Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Mantid::Algorithms::MaxentTransformMultiFourier Class Reference

MaxentTransformMultiFourier : Defines a transformation from data space to image space (and vice-versa) where spaces are related by a 1D Fourier Transform, in which which the data has multiple spectra concatenatenated. More...

#include <MaxentTransformMultiFourier.h>

Inheritance diagram for Mantid::Algorithms::MaxentTransformMultiFourier:
Mantid::Algorithms::MaxentTransformFourier Mantid::Algorithms::MaxentTransform

Public Member Functions

std::vector< double > dataToImage (const std::vector< double > &data) override
 Transforms a 1D signal from data space to image space, performing a forward Fast MexentTransformFourier on the sum of the spectra. More...
 
std::vector< double > imageToData (const std::vector< double > &image) override
 Transforms a 1D signal from image space to data space, performing an a backward MaxentTransformFourier on it then creating a concatenated copy of the resulting data for each spectrum and applying the adjustments to them. More...
 
 MaxentTransformMultiFourier ()=delete
 
 MaxentTransformMultiFourier (const MaxentSpaceComplex_sptr &dataSpace, MaxentSpace_sptr imageSpace, size_t numSpec)
 Constructor. More...
 
void setAdjustments (const std::vector< double > &linAdj, const std::vector< double > &constAdj)
 Sets the adjustments to be applied to the data when converted from image. More...
 
- Public Member Functions inherited from Mantid::Algorithms::MaxentTransformFourier
std::vector< double > dataToImage (const std::vector< double > &data) override
 Transforms a 1D signal from data space to image space, performing a forward Fast Fourier Transform. More...
 
std::vector< double > imageToData (const std::vector< double > &image) override
 Transforms a 1D signal from image space to data space, performing an inverse Fast Fourier Transform. More...
 
 MaxentTransformFourier ()=delete
 
 MaxentTransformFourier (MaxentSpace_sptr dataSpace, MaxentSpace_sptr imageSpace)
 Constructor. More...
 
- Public Member Functions inherited from Mantid::Algorithms::MaxentTransform
virtual std::vector< double > dataToImage (const std::vector< double > &data)=0
 
virtual std::vector< double > imageToData (const std::vector< double > &image)=0
 
 MaxentTransform ()=default
 
virtual ~MaxentTransform ()=default
 

Private Attributes

std::vector< double > m_constAdjustments
 
MaxentSpace_sptr m_dataSpace
 
MaxentSpace_sptr m_imageSpace
 
std::vector< double > m_linearAdjustments
 
size_t m_numSpec
 

Detailed Description

MaxentTransformMultiFourier : Defines a transformation from data space to image space (and vice-versa) where spaces are related by a 1D Fourier Transform, in which which the data has multiple spectra concatenatenated.

In transforming from data to image, the spectra are added together before tranforming to a single image. In transforming the image to data, copies to the transformed data (one for each spectrum) are concatenated and then have the supplied adjustments applied.

The concatenated format of the data is chosen to enable existing code to calculate its chi squared.

Definition at line 33 of file MaxentTransformMultiFourier.h.

Constructor & Destructor Documentation

◆ MaxentTransformMultiFourier() [1/2]

Mantid::Algorithms::MaxentTransformMultiFourier::MaxentTransformMultiFourier ( )
delete

◆ MaxentTransformMultiFourier() [2/2]

Mantid::Algorithms::MaxentTransformMultiFourier::MaxentTransformMultiFourier ( const MaxentSpaceComplex_sptr dataSpace,
MaxentSpace_sptr  imageSpace,
size_t  numSpec 
)

Constructor.

Definition at line 17 of file MaxentTransformMultiFourier.cpp.

Member Function Documentation

◆ dataToImage()

std::vector< double > Mantid::Algorithms::MaxentTransformMultiFourier::dataToImage ( const std::vector< double > &  data)
overridevirtual

Transforms a 1D signal from data space to image space, performing a forward Fast MexentTransformFourier on the sum of the spectra.

Input is assumed real or complex according to the type of data space given to the constructor. Return value is real or complex according to the type of image space given to the constructor. If complex, input & return vectors consist of real part immediately followed by imaginary part of each individual value.

Parameters
data: [input] Data as a vector of concatenated spectra
Returns
: The vector in the image space

Reimplemented from Mantid::Algorithms::MaxentTransformFourier.

Definition at line 91 of file MaxentTransformMultiFourier.cpp.

References Mantid::Algorithms::MaxentTransformFourier::dataToImage(), and m_numSpec.

◆ imageToData()

std::vector< double > Mantid::Algorithms::MaxentTransformMultiFourier::imageToData ( const std::vector< double > &  image)
overridevirtual

Transforms a 1D signal from image space to data space, performing an a backward MaxentTransformFourier on it then creating a concatenated copy of the resulting data for each spectrum and applying the adjustments to them.

Input is assumed real or complex according to the type of image space given to the constructor. Return value is real or complex according to the type of data space given to the constructor. If complex, input & return vectors consist of real part immediately followed by imaginary part of each individual value.

Parameters
image: [input] Image as a vector
Returns
: The vector in the data space of concatenated spectra

Reimplemented from Mantid::Algorithms::MaxentTransformFourier.

Definition at line 36 of file MaxentTransformMultiFourier.cpp.

References Mantid::Algorithms::MaxentTransformFourier::imageToData(), m_constAdjustments, m_linearAdjustments, and m_numSpec.

◆ setAdjustments()

void Mantid::Algorithms::MaxentTransformMultiFourier::setAdjustments ( const std::vector< double > &  linAdj,
const std::vector< double > &  constAdj 
)

Sets the adjustments to be applied to the data when converted from image.

Parameters
linAdj: [input] Linear adjustments as complex numbers for all spectra concatenated
constAdj[input] Constant adjustments as complex numbers for all spectra concatenated

Definition at line 117 of file MaxentTransformMultiFourier.cpp.

References m_constAdjustments, and m_linearAdjustments.

Member Data Documentation

◆ m_constAdjustments

std::vector<double> Mantid::Algorithms::MaxentTransformMultiFourier::m_constAdjustments
private

Definition at line 51 of file MaxentTransformMultiFourier.h.

Referenced by imageToData(), and setAdjustments().

◆ m_dataSpace

MaxentSpace_sptr Mantid::Algorithms::MaxentTransformMultiFourier::m_dataSpace
private

Definition at line 47 of file MaxentTransformMultiFourier.h.

◆ m_imageSpace

MaxentSpace_sptr Mantid::Algorithms::MaxentTransformMultiFourier::m_imageSpace
private

Definition at line 48 of file MaxentTransformMultiFourier.h.

◆ m_linearAdjustments

std::vector<double> Mantid::Algorithms::MaxentTransformMultiFourier::m_linearAdjustments
private

Definition at line 50 of file MaxentTransformMultiFourier.h.

Referenced by imageToData(), and setAdjustments().

◆ m_numSpec

size_t Mantid::Algorithms::MaxentTransformMultiFourier::m_numSpec
private

Definition at line 49 of file MaxentTransformMultiFourier.h.

Referenced by dataToImage(), and imageToData().


The documentation for this class was generated from the following files: