nag::cwt_results< FPType > Struct Template Reference

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

#include <SpecImage.hpp>

Public Member Functions
	cwt_results (cwt_results &&a)
	Move constructor. More...
	cwt_results ()=default
	Default constructor. More...
cwt_results &	operator= (cwt_results &&a)
	Move assignment operator. More...

Data Fields
size_t	n
	The input length (number of channels). More...
int	nscales
	The number of scales over which the CWT has been performed. More...
size_t	npixels
	The number of pixels for which the CWT has been performed. More...
std::vector< uint32_t >	scales
	Vector of scales used. More...
std::vector< size_t >	pixels
	Vector of pixels used. More...
std::unique_ptr< FPType[], cfree >	coefficients
	n by nscales by npixels 3D array of output CWT coefficients. The \(ichan^{th}\) coefficient for the \(iscale^{th}\) scale of the \(ipix^{th}\) pixel is stored at (*coeffs)[ipix*nscales*nchan + iscale*nchan + ichan]. More...

Detailed Description

template<class FPType>
struct nag::cwt_results< FPType >

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

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

Constructor & Destructor Documentation

template<class FPType>

nag::cwt_results< FPType >::cwt_results ( cwt_results< FPType > &&  a )

inline

Move constructor.

template<class FPType>

nag::cwt_results< FPType >::cwt_results ( )

default

Default constructor.

Member Function Documentation

template<class FPType>

cwt_results& nag::cwt_results< FPType >::operator= ( cwt_results< FPType > &&  a )

inline

Move assignment operator.

Field Documentation

template<class FPType>

std::unique_ptr<FPType[], cfree> nag::cwt_results< FPType >::coefficients

n by nscales by npixels 3D array of output CWT coefficients. The \(ichan^{th}\) coefficient for the \(iscale^{th}\) scale of the \(ipix^{th}\) pixel is stored at (*coeffs)[ipix*nscales*nchan + iscale*nchan + ichan].

template<class FPType>

size_t nag::cwt_results< FPType >::n

The input length (number of channels).

template<class FPType>

size_t nag::cwt_results< FPType >::npixels

The number of pixels for which the CWT has been performed.

template<class FPType>

int nag::cwt_results< FPType >::nscales

The number of scales over which the CWT has been performed.

template<class FPType>

std::vector<size_t> nag::cwt_results< FPType >::pixels

Vector of pixels used.

template<class FPType>

std::vector<uint32_t> nag::cwt_results< FPType >::scales

Vector of scales used.

---

The documentation for this struct was generated from the following file:

• SpecImage.hpp