A spectral table with two independent variables. More...

#include <SOSM_SpectralTable3D.hpp>

Inheritance diagram for SOSM_SpectralTable3D:

Collaboration diagram for SOSM_SpectralTable3D:

[legend]

Public Member Functions
	SOSM_SpectralTable3D (SOSM_Manager *aManagerPtr)
double	GetModificationTime () const
	Return when the source file from which the object was recreated was last modified.
const TblIndVarU< float > &	IV1 () const
	Return the independent variable 1 values (const form).
TblIndVarU< float > &	IV1 ()
	Return the independent variable 1 values (non-const form).
const TblIndVarU< float > &	IV2 () const
	Return the independent variable 2 values (const form).
TblIndVarU< float > &	IV2 ()
	Return the independent variable 2 values (non-const form).
const TblIndVarU< float > &	IV3 () const
	Return the independent variable 3 values (const form).
TblIndVarU< float > &	IV3 ()
	Return the independent variable 3 values (non-const form).
void	SetDV_Info (const SOSM_TableVar &aDV_Info)
	Set the name, limits and scale for the dependent variable.
void	SetIV1_Info (const SOSM_TableVar &aIV1_Info)
	Set the name, limits and scale for independent variable 1.
void	SetIV2_Info (const SOSM_TableVar &aIV2_Info)
	Set the name, limits and scale for independent variable 2.
void	SetIV3_Info (const SOSM_TableVar &aIV3_Info)
	Set the name, limits and scale for independent variable 3.
void	Interpolate (std::vector< float > &aOutput, const SOSM_Selector &aSelector, const TblLookupL< float > &aIV1_Lookup, const TblLookupL< float > &aIV2_Lookup, const TblLookupL< float > &aIV3_Lookup) const
void	Load (const std::string &aFileName, const std::string &aCachePrefix)
void	LoadTextFile (const std::string &aFileName)
void	LoadBinaryFile (const std::string &aFileName)
void	SaveBinaryFile (const std::string &aFileName)
SOSM_Manager *	GetManager () const
Public Member Functions inherited from SOSM_SpectralObject
	SOSM_SpectralObject ()
	SOSM_SpectralObject (float aOrigin, float aIncrement, int aCount)
virtual	~SOSM_SpectralObject ()
float	Origin () const
	Return the origin (wavenumber, cm-1) of the first sample point.
float	Increment () const
int	Count () const
void	DefineSpectralLimits (float aOrigin, float aIncrement, int aCount)
void	DefineSpectralLimits (const SOSM_SpectralObject &aSource)
bool	Equals (const SOSM_SpectralObject &aRhs) const
	Do this object and another object have the same spectral limits?
Status	Union (const SOSM_SpectralObject &aObject)
Status	Union (const SOSM_SpectralObject &aObject1, const SOSM_SpectralObject &aObject2)
float	LowerWavelength () const
float	UpperWavelength () const
void	SetWavelengthLimits (float aLowerWavelength, float aUpperWavelength)

Protected Member Functions
void	ValidateAndScale_IV (TblIndVarU< float > &aIV, const SOSM_TableVar &aIV_Info)

Protected Attributes
SOSM_Manager *	mManagerPtr
std::string	mFileName
	The name of the file from which the table was loaded.
double	mModificationTime
	The modification date of the above file.
std::string	mUserIdent [3]
	The first three lines from the file.
SOSM_TableVar	mDV_Info
	Dependent variable ([iv1][iv2][iv3][sample]).
std::vector< float >	mDV
SOSM_TableVar	mIV1_Info
	Independent variable 1.
TblIndVarU< float >	mIV1
SOSM_TableVar	mIV2_Info
	Independent variable 2.
TblIndVarU< float >	mIV2
SOSM_TableVar	mIV3_Info
	Independent variable 3.
TblIndVarU< float >	mIV3

Additional Inherited Members
Public Types inherited from SOSM_SpectralObject
enum	Status { cOK = 0 , cINCOMPATIBLE_INCREMENTS , cINCOMPATIBLE_ORIGINS }
	Return value from 'UnionOf'. More...
Static Public Member Functions inherited from SOSM_SpectralObject
static std::string	StatusString (Status aStatus)

Detailed Description

A spectral table with two independent variables.

Constructor & Destructor Documentation

◆ SOSM_SpectralTable3D()

SOSM_SpectralTable3D::SOSM_SpectralTable3D ( SOSM_Manager * aManagerPtr )

References mManagerPtr, and mModificationTime.

Member Function Documentation

◆ GetManager()

SOSM_Manager * SOSM_SpectralTable3D::GetManager ( ) const

inline

References mManagerPtr.

Referenced by Load(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

◆ GetModificationTime()

double SOSM_SpectralTable3D::GetModificationTime ( ) const

inline

Return when the source file from which the object was recreated was last modified.

References mModificationTime.

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ Interpolate()

void SOSM_SpectralTable3D::Interpolate	(	std::vector< float > &	aOutput,
		const SOSM_Selector &	aSelector,
		const TblLookupL< float > &	aIV1_Lookup,
		const TblLookupL< float > &	aIV2_Lookup,
		const TblLookupL< float > &	aIV3_Lookup ) const

References SOSM_Selector::Count(), SOSM_SpectralObject::Count(), SOSM_Selector::InputStartIndex(), mDV, mIV2, mIV3, and SOSM_Selector::OutputStartIndex().

◆ IV1() [1/2]

TblIndVarU< float > & SOSM_SpectralTable3D::IV1 ( )

inline

Return the independent variable 1 values (non-const form).

References mIV1.

◆ IV1() [2/2]

const TblIndVarU< float > & SOSM_SpectralTable3D::IV1 ( ) const

inline

Return the independent variable 1 values (const form).

References mIV1.

Referenced by SOSM_TableAtmosphere::InputComplete().

◆ IV2() [1/2]

TblIndVarU< float > & SOSM_SpectralTable3D::IV2 ( )

inline

Return the independent variable 2 values (non-const form).

References mIV2.

◆ IV2() [2/2]

const TblIndVarU< float > & SOSM_SpectralTable3D::IV2 ( ) const

inline

Return the independent variable 2 values (const form).

References mIV2.

Referenced by SOSM_TableAtmosphere::InputComplete().

◆ IV3() [1/2]

TblIndVarU< float > & SOSM_SpectralTable3D::IV3 ( )

inline

Return the independent variable 3 values (non-const form).

References mIV3.

◆ IV3() [2/2]

const TblIndVarU< float > & SOSM_SpectralTable3D::IV3 ( ) const

inline

Return the independent variable 3 values (const form).

References mIV3.

Referenced by SOSM_TableAtmosphere::InputComplete().

◆ Load()

void SOSM_SpectralTable3D::Load	(	const std::string &	aFileName,
		const std::string &	aCachePrefix )

References SOSM_Manager::CacheFileName(), SOSM_Utility::FileIsCurrent(), GetManager(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ LoadBinaryFile()

void SOSM_SpectralTable3D::LoadBinaryFile ( const std::string & aFileName )

References SOSM_Utility::FileModificationTime(), SOSM_Manager::FileReferenced, GetManager(), mDV, mFileName, mIV1, mIV2, mIV3, mModificationTime, mUserIdent, SOSM_BinaryIO::ReadDV(), SOSM_BinaryIO::ReadHeader(), SOSM_BinaryIO::ReadIV(), SOSM_BinaryIO::ReadSpectralObject(), and SOSM_BinaryIO::ReadTrailer().

Referenced by Load().

◆ LoadTextFile()

void SOSM_SpectralTable3D::LoadTextFile ( const std::string & aFileName )

References SOSM_SpectralObject::Count(), SOSM_SpectralObject::DefineSpectralLimits(), SOSM_Utility::FileModificationTime(), SOSM_Manager::FileReferenced, GetManager(), mDV, mDV_Info, mFileName, mIV1, mIV1_Info, mIV2, mIV2_Info, mIV3, mIV3_Info, mModificationTime, mUserIdent, and ValidateAndScale_IV().

Referenced by Load().

◆ SaveBinaryFile()

void SOSM_SpectralTable3D::SaveBinaryFile ( const std::string & aFileName )

References GetManager(), mDV, mIV1, mIV2, mIV3, mUserIdent, SOSM_BinaryIO::WriteDV(), SOSM_BinaryIO::WriteHeader(), SOSM_BinaryIO::WriteIV(), SOSM_BinaryIO::WriteSpectralObject(), and SOSM_BinaryIO::WriteTrailer().

Referenced by Load().

◆ SetDV_Info()

void SOSM_SpectralTable3D::SetDV_Info ( const SOSM_TableVar & aDV_Info )

inline

Set the name, limits and scale for the dependent variable.

References mDV_Info.

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ SetIV1_Info()

void SOSM_SpectralTable3D::SetIV1_Info ( const SOSM_TableVar & aIV1_Info )

inline

Set the name, limits and scale for independent variable 1.

References mIV1_Info.

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ SetIV2_Info()

void SOSM_SpectralTable3D::SetIV2_Info ( const SOSM_TableVar & aIV2_Info )

inline

Set the name, limits and scale for independent variable 2.

References mIV2_Info.

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ SetIV3_Info()

void SOSM_SpectralTable3D::SetIV3_Info ( const SOSM_TableVar & aIV3_Info )

inline

Set the name, limits and scale for independent variable 3.

References mIV3_Info.

Referenced by SOSM_TableAtmosphere::ProcessInput().

◆ ValidateAndScale_IV()

void SOSM_SpectralTable3D::ValidateAndScale_IV	(	TblIndVarU< float > &	aIV,
		const SOSM_TableVar &	aIV_Info )

protected

References SOSM_TableVar::Max(), mFileName, SOSM_TableVar::Min(), SOSM_TableVar::Name(), and SOSM_TableVar::Scale().

Referenced by LoadTextFile().

Member Data Documentation

◆ mDV

std::vector<float> SOSM_SpectralTable3D::mDV

protected

Referenced by Interpolate(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

◆ mDV_Info

SOSM_TableVar SOSM_SpectralTable3D::mDV_Info

protected

Dependent variable ([iv1][iv2][iv3][sample]).

Referenced by LoadTextFile(), and SetDV_Info().

◆ mFileName

std::string SOSM_SpectralTable3D::mFileName

protected

The name of the file from which the table was loaded.

Referenced by LoadBinaryFile(), LoadTextFile(), and ValidateAndScale_IV().

◆ mIV1

TblIndVarU<float> SOSM_SpectralTable3D::mIV1

protected

Referenced by IV1(), IV1(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

◆ mIV1_Info

SOSM_TableVar SOSM_SpectralTable3D::mIV1_Info

protected

Independent variable 1.

Referenced by LoadTextFile(), and SetIV1_Info().

◆ mIV2

TblIndVarU<float> SOSM_SpectralTable3D::mIV2

protected

Referenced by Interpolate(), IV2(), IV2(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

◆ mIV2_Info

SOSM_TableVar SOSM_SpectralTable3D::mIV2_Info

protected

Independent variable 2.

Referenced by LoadTextFile(), and SetIV2_Info().

◆ mIV3

TblIndVarU<float> SOSM_SpectralTable3D::mIV3

protected

Referenced by Interpolate(), IV3(), IV3(), LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

◆ mIV3_Info

SOSM_TableVar SOSM_SpectralTable3D::mIV3_Info

protected

Independent variable 3.

Referenced by LoadTextFile(), and SetIV3_Info().

◆ mManagerPtr

SOSM_Manager* SOSM_SpectralTable3D::mManagerPtr

protected

Referenced by GetManager(), and SOSM_SpectralTable3D().

◆ mModificationTime

double SOSM_SpectralTable3D::mModificationTime

protected

The modification date of the above file.

Referenced by GetModificationTime(), LoadBinaryFile(), LoadTextFile(), and SOSM_SpectralTable3D().

◆ mUserIdent

std::string SOSM_SpectralTable3D::mUserIdent[3]

protected

The first three lines from the file.

Referenced by LoadBinaryFile(), LoadTextFile(), and SaveBinaryFile().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SOSM_SpectralTable3D()

Member Function Documentation

◆ GetManager()

◆ GetModificationTime()

◆ Interpolate()

◆ IV1() [1/2]

◆ IV1() [2/2]

◆ IV2() [1/2]

◆ IV2() [2/2]

◆ IV3() [1/2]

◆ IV3() [2/2]

◆ Load()

◆ LoadBinaryFile()

◆ LoadTextFile()

◆ SaveBinaryFile()

◆ SetDV_Info()

◆ SetIV1_Info()

◆ SetIV2_Info()

◆ SetIV3_Info()

◆ ValidateAndScale_IV()

Member Data Documentation

◆ mDV

◆ mDV_Info

◆ mFileName

◆ mIV1

◆ mIV1_Info

◆ mIV2

◆ mIV2_Info

◆ mIV3

◆ mIV3_Info

◆ mManagerPtr

◆ mModificationTime

◆ mUserIdent