An abstract base class for representing atmospherics. More...

#include <SOSM_Atmosphere.hpp>

Inheritance diagram for SOSM_Atmosphere:

[legend]

Collaboration diagram for SOSM_Atmosphere:

[legend]

Public Member Functions
	SOSM_Atmosphere ()
	Constructor.
	SOSM_Atmosphere (const SOSM_Atmosphere &aSrc)
	Copy constructor.
virtual SOSM_Atmosphere *	Clone () const =0
	A virtual copy constructor.
virtual void	ComputeAtmosphereData (const SOSM_Selector &aSelector, SOSM_Interaction &aInteraction, std::vector< float > &aBackgroundRadiance, std::vector< float > &aForegroundRadiance, std::vector< float > &aForegroundTransmittance)=0
virtual void	GetSamplePoints (std::vector< float > &aAltValues, std::vector< float > &aElValues, std::vector< float > &aRangeValues)=0
Public Member Functions inherited from SOSM_CoreBase
	SOSM_CoreBase ()
	SOSM_CoreBase (const SOSM_CoreBase &aSrc)
	~SOSM_CoreBase () override
SOSM_CoreBase &	operator= (const SOSM_CoreBase &)=delete
std::string	GetTypeName () const
	Return the user-specified type name of the object.
void	SetTypeName (const std::string &aTypeName)
	Set the user-specified type name of the object.
double	GetModificationTime () const
	Return when the source file from which the object was recreated was last modified.
void	SetModificationTime (double aModificationTime)
	Set the last modification time of the object.
void	UpdateModificationTime (double aModificationTime)
std::string	GetCachePrefix () const
	Return the name of the cache prefix for this object.
void	SetCachePrefix (const std::string &aCachePrefix)
	Set the cache prefix (subdirectory) to be used for creating cache files of this object.
virtual bool	Initialize ()
virtual void	InputComplete ()
virtual bool	ProcessInput (UtInput &aInput)
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)

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)
Protected Attributes inherited from SOSM_CoreBase
double	mModificationTime
	When the file was last modified.
std::string	mTypeName
	The type name of the object.
std::string	mCachePrefix

Detailed Description

An abstract base class for representing atmospherics.

Constructor & Destructor Documentation

◆ SOSM_Atmosphere() [1/2]

SOSM_Atmosphere::SOSM_Atmosphere ( )

Constructor.

References SOSM_CoreBase::SOSM_CoreBase().

Referenced by Clone(), SOSM_SimpleAtmosphere::Clone(), SOSM_TableAtmosphere::Clone(), SOSM_Atmosphere(), SOSM_SimpleAtmosphere::SOSM_SimpleAtmosphere(), and SOSM_TableAtmosphere::SOSM_TableAtmosphere().

◆ SOSM_Atmosphere() [2/2]

SOSM_Atmosphere::SOSM_Atmosphere ( const SOSM_Atmosphere & aSrc )

Copy constructor.

References SOSM_Atmosphere(), and SOSM_CoreBase::SOSM_CoreBase().

Member Function Documentation

◆ Clone()

virtual SOSM_Atmosphere * SOSM_Atmosphere::Clone ( ) const

pure virtual

A virtual copy constructor.

Implemented in SOSM_SimpleAtmosphere, and SOSM_TableAtmosphere.

References SOSM_Atmosphere().

Referenced by SOSM_Manager::AllocateAtmosphere().

◆ ComputeAtmosphereData()

virtual void SOSM_Atmosphere::ComputeAtmosphereData	(	const SOSM_Selector &	aSelector,
		SOSM_Interaction &	aInteraction,
		std::vector< float > &	aBackgroundRadiance,
		std::vector< float > &	aForegroundRadiance,
		std::vector< float > &	aForegroundTransmittance )

pure virtual

Compute the atmospheric data

The background is considered space or ground. The foreground is considered the target.

Parameters

aSelector	[input] The selector which defines the spectral overlap between this and the sensor.
aInteraction	[input] The interaction object representing the sensor and target state.
aBackgroundRadiance	[output] The background radiance (W/cm^2/sr/um)
aForegroundRadiance	[output] The foreground radiance (W/cm^2/sr/um)
aForegroundTransmittance	[output] The foreground transmittance (unitless - [0..1])

Implemented in SOSM_SimpleAtmosphere, and SOSM_TableAtmosphere.

◆ GetSamplePoints()

virtual void SOSM_Atmosphere::GetSamplePoints	(	std::vector< float > &	aAltValues,
		std::vector< float > &	aElValues,
		std::vector< float > &	aRangeValues )

pure virtual

Get the sample points to be used for fast detection mode table generation.

Parameters

aAltValues	Altitude sample points (meters)
aElValues	Elevation sample points (radians)
aRangeValues	Range sample points (meters)

Implemented in SOSM_SimpleAtmosphere, and SOSM_TableAtmosphere.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SOSM_Atmosphere() [1/2]

◆ SOSM_Atmosphere() [2/2]

Member Function Documentation

◆ Clone()

◆ ComputeAtmosphereData()

◆ GetSamplePoints()