nag Namespace Reference

Overall namespace for the NAG C++ Hyperspectral Imaging Library. More...

Data Structures
struct	cfree
	A type used to wrap access to the C free() function. More...
struct	csr_mat
	A type used to hold the components of a sparse matrix in compressed sparse row (CSR) format. More...
struct	cwt_results
	A type used to hold the result of a 1D real continuous wavelet transform. More...
class	Error
	Class thrown on error. More...
struct	kmeans_results
	A type used to hold the details of a k-means clustering analysis. More...
class	MALDISpecImage
	Class representing a spectral image generated from a MALDI instrument. More...
struct	nmf_results
	A type used to hold the result of a non-negative matrix factorization. More...
struct	pca_results
	A type used to hold the details of a principal component analysis. More...
class	SIMSpecImage
	Class representing a spectral image generated from a Secondary Ion Mass Spectrometry instrument. More...
class	SpecImage
	Base class representing a spectral image. More...
class	SpecImageFactory
	This class contains a function which reads in a configuration file and creates a new nag::SIMSpecImage of nag::MALDISpecImage object accordingly. More...
struct	tsne_results
	A type used to hold the details of a t-SNE analysis. More...

Typedefs
typedef enum nag::source	source_t
	A type used to indicate the instrument source of the image. Returned by nag::SpecImage.getSource. More...
typedef enum nag::pca_mat	pca_mat_t
	The matrix used to perform principal component analysis. More...
typedef enum nag::kmeans_metric	kmeans_metric_t
	The metric used to perform k-means clustering analysis. More...
typedef enum nag::matrix_ordering	matrix_ordering_t
	A type used to indicate whether the ordering of the matrix is pixels by channels or channels by pixels. More...
typedef enum nag::wavelet_name	wavelet_t
	The wavelet used to perform the continuous wavelet transform. More...
typedef enum nag::wavelet_extension	wavelet_extension_t
	The end extension method used to perform the continuous wavelet transform. More...
template<class FPType >
using	csr_mat_t = struct csr_mat< FPType >
template<class FPType >
using	pca_results_t = struct pca_results< FPType >
	A type used to hold the details of a principal components analysis. More...
template<class FPType >
using	tsne_results_t = struct tsne_results< FPType >
	A type used to hold the details of a t-SNE analysis. More...
template<class FPType >
using	kmeans_results_t = struct kmeans_results< FPType >
	A type used to hold the details of a k-means clustering analysis. More...
template<class FPType >
using	nmf_results_t = struct nmf_results< FPType >
	A type used to hold the result of non-negative matrix factorization. More...
template<class FPType >
using	cwt_results_t = struct cwt_results< FPType >
	A type used to hold the result of a 1D real continuous wavelet transform. More...

Enumerations
enum	source { SIMS, MALDI, none }
	A type used to indicate the instrument source of the image. Returned by nag::SpecImage.getSource. More...
enum	pca_mat { Covariance, Correlation }
	The matrix used to perform principal component analysis. More...
enum	kmeans_metric { Euclidean, Cosine }
	The metric used to perform k-means clustering analysis. More...
enum	matrix_ordering { PixelsByChannels, ChannelsByPixels }
	A type used to indicate whether the ordering of the matrix is pixels by channels or channels by pixels. More...
enum	wavelet_name { MexicanHat, Haar }
	The wavelet used to perform the continuous wavelet transform. More...
enum	wavelet_extension { Periodic, Zero, Symmetric }
	The end extension method used to perform the continuous wavelet transform. More...

Detailed Description

Overall namespace for the NAG C++ Hyperspectral Imaging Library.

Typedef Documentation

template<class FPType >

using nag::csr_mat_t = typedef struct csr_mat<FPType>

template<class FPType >

using nag::cwt_results_t = typedef struct cwt_results<FPType>

A type used to hold the result of a 1D real continuous wavelet transform.

For more information see: nag::SpecImage::cwt.

typedef enum nag::kmeans_metric nag::kmeans_metric_t

The metric used to perform k-means clustering analysis.

template<class FPType >

using nag::kmeans_results_t = typedef struct kmeans_results<FPType>

A type used to hold the details of a k-means clustering analysis.

For more information see: nag::SpecImage::kmeans.

typedef enum nag::matrix_ordering nag::matrix_ordering_t

A type used to indicate whether the ordering of the matrix is pixels by channels or channels by pixels.

template<class FPType >

using nag::nmf_results_t = typedef struct nmf_results<FPType>

A type used to hold the result of non-negative matrix factorization.

For more information see: nag::SpecImage::nmf.

typedef enum nag::pca_mat nag::pca_mat_t

The matrix used to perform principal component analysis.

template<class FPType >

using nag::pca_results_t = typedef struct pca_results<FPType>

A type used to hold the details of a principal components analysis.

For more information see: nag::SpecImage::pca.

typedef enum nag::source nag::source_t

A type used to indicate the instrument source of the image. Returned by nag::SpecImage.getSource.

For nag::SpecImage objects the source type will be none.

template<class FPType >

using nag::tsne_results_t = typedef struct tsne_results<FPType>

A type used to hold the details of a t-SNE analysis.

For more information see: nag::SpecImage::tsne.

typedef enum nag::wavelet_extension nag::wavelet_extension_t

The end extension method used to perform the continuous wavelet transform.

typedef enum nag::wavelet_name nag::wavelet_t

The wavelet used to perform the continuous wavelet transform.

Enumeration Type Documentation

enum nag::kmeans_metric

The metric used to perform k-means clustering analysis.

Enumerator
Euclidean	Use the Euclidean distance metric for nag::SpecImage::kmeans analysis.
Cosine	Use the cosine distance metric for nag::SpecImage::kmeans analysis.

enum nag::matrix_ordering

A type used to indicate whether the ordering of the matrix is pixels by channels or channels by pixels.

Enumerator
PixelsByChannels	Indicates that the rows of the matrix represent pixels, and the columns mass channels.
ChannelsByPixels	Indicates that the rows of the matrix represent mass channels, and the columns pixels.

enum nag::pca_mat

The matrix used to perform principal component analysis.

Enumerator
Covariance	Use the covariance matrix to perform nag::SpecImage::pca.
Correlation	Use the correlation matrix to perform nag::SpecImage::pca.

enum nag::source

A type used to indicate the instrument source of the image. Returned by nag::SpecImage.getSource.

For nag::SpecImage objects the source type will be none.

Enumerator
SIMS	The source is a SIMS instrument, and the object is of type nag::SIMSpecImage.
MALDI	The source is a MALDI instrument, and the object is of type nag::MALDISpecImage.
none	The source is unknown and the object has been constructed directly as a base nag::SpecImage type.

enum nag::wavelet_extension

The end extension method used to perform the continuous wavelet transform.

Enumerator
Periodic	Use periodic end extension for nag::SpecImage::cwt.
Zero	Use zero end extension for nag::SpecImage::cwt.
Symmetric	Use symmetric end extension for nag::SpecImage::cwt.

enum nag::wavelet_name

The wavelet used to perform the continuous wavelet transform.

Enumerator
MexicanHat	Use the Mexican hat wavelet for nag::SpecImage::cwt.
Haar	Use the Haar wavelet for nag::SpecImage::cwt.