SOSM_Selector Class Reference

#include <SOSM_Selector.hpp>

Public Types
enum	Status {   cINTERSECTS = 0 , cOUTPUT_IS_CONTINUOUS , cINCOMPATIBLE_INCREMENTS , cINCOMPATIBLE_ORIGINS ,   cNO_INTERSECTION }
	Return value from 'Intersect'. More...

Public Member Functions
	SOSM_Selector ()
	Default constructor.
	SOSM_Selector (const SOSM_SpectralObject &aInputOutput)
	An alternative constructor used for creating selectors for testing.
Status	Intersect (const SOSM_SpectralObject &aInput, const SOSM_SpectralObject &aOutput)
void	InitializeOutput (std::vector< float > &aOutput, float aValue) const
float	Origin () const
	Return the origin (wavenumber of the first sample point) in the intersection.
float	Increment () const
	Returns the wavenumber increment between sample points.
int	Count () const
	Returns the number of points in the intersection.
int	InputStartIndex () const
	Returns the index of the sample point in the input that corresponds to the Origin().
int	OutputStartIndex () const
	Returns the index of the sample in point the output that corresponds to the Origin().

Static Public Member Functions
static std::string	StatusString (Status aStatus)

Detailed Description

This class represents the intersection of two SOSM_SpectralObject's.

This class is used to compute the 'intersection' between to two SOSM_SpectralObjects.

Member Enumeration Documentation

Status

enum SOSM_Selector::Status

Return value from 'Intersect'.

Enumerator
cINTERSECTS
cOUTPUT_IS_CONTINUOUS
cINCOMPATIBLE_INCREMENTS
cINCOMPATIBLE_ORIGINS
cNO_INTERSECTION

Constructor & Destructor Documentation

SOSM_Selector() [1/2]

SOSM_Selector::SOSM_Selector

(

)

Default constructor.

SOSM_Selector() [2/2]

SOSM_Selector::SOSM_Selector

(

const SOSM_SpectralObject &

aInputOutput

)

An alternative constructor used for creating selectors for testing.

References Count(), Increment(), and Origin().

Member Function Documentation

Count()

int SOSM_Selector::Count ( ) const

inline

Returns the number of points in the intersection.

Referenced by SOSM_TableAtmosphere::ComputeAtmosphereData(), SOSM_TableTarget::ComputeRadiantIntensity(), SOSM_SpectralTable2D::Interpolate(), SOSM_SpectralTable3D::Interpolate(), SOSM_Utility::PrintSpectralVector(), and SOSM_Selector().

Increment()

float SOSM_Selector::Increment ( ) const

inline

Returns the wavenumber increment between sample points.

Referenced by SOSM_Utility::PrintSpectralVector(), and SOSM_Selector().

InitializeOutput()

void SOSM_Selector::InitializeOutput	(	std::vector< float > &	aOutput,
		float	aValue ) const

Referenced by SOSM_SimpleAtmosphere::ComputeAtmosphereData(), and SOSM_TableAtmosphere::ComputeAtmosphereData().

InputStartIndex()

int SOSM_Selector::InputStartIndex ( ) const

inline

Returns the index of the sample point in the input that corresponds to the Origin().

Referenced by SOSM_SpectralTable2D::Interpolate(), and SOSM_SpectralTable3D::Interpolate().

Intersect()

SOSM_Selector::Status SOSM_Selector::Intersect	(	const SOSM_SpectralObject &	aInput,
		const SOSM_SpectralObject &	aOutput )

Determine the intersection between two spectral objects.

Parameters

aInput	The object providing the data. This will generally be an SOSM_Atmosphere or SOSM_Target object.
aOutput	The object that will be receiving the data from the input object. This is generally the SOSM_Sensor object.

References cINCOMPATIBLE_INCREMENTS, cINCOMPATIBLE_ORIGINS, cINTERSECTS, cNO_INTERSECTION, SOSM_SpectralObject::Count(), cOUTPUT_IS_CONTINUOUS, SOSM_SpectralObject::Increment(), and SOSM_SpectralObject::Origin().

Referenced by SOSM_TableTarget::ComputeRadiantIntensity().

Origin()

float SOSM_Selector::Origin ( ) const

inline

Return the origin (wavenumber of the first sample point) in the intersection.

Referenced by SOSM_Utility::PrintSpectralVector(), and SOSM_Selector().

OutputStartIndex()

int SOSM_Selector::OutputStartIndex ( ) const

inline

Returns the index of the sample in point the output that corresponds to the Origin().

Referenced by SOSM_TableAtmosphere::ComputeAtmosphereData(), SOSM_TableTarget::ComputeRadiantIntensity(), SOSM_SpectralTable2D::Interpolate(), SOSM_SpectralTable3D::Interpolate(), and SOSM_Utility::PrintSpectralVector().

StatusString()

std::string SOSM_Selector::StatusString ( Status aStatus )

static

Return the string associated with the supplied status value.

Parameters

aStatus

The Status enumeration value whose string value is to be returned.

Returns

The string associated with the supplied Status value.

References cINCOMPATIBLE_INCREMENTS, cINCOMPATIBLE_ORIGINS, cINTERSECTS, cNO_INTERSECTION, and cOUTPUT_IS_CONTINUOUS.

Referenced by SOSM_Sensor::Initialize().

---

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

• SOSM_Selector.hpp
• SOSM_Selector.cpp