#include <WsfOpticalPath.hpp>

Classes
class	Coefficients
class	LaserCoefficients
class	Integrand

Public Types
enum	Type { cABS , cSCAT , cBOTH }

Public Member Functions
	WsfOpticalPath ()
	WsfOpticalPath (const WsfOpticalPathCoefficientTypes &aTypes, unsigned aWavelength, unsigned aAtmosphereModel=2, unsigned aHazeMode=1)
	Constructor for use with laser coefficient tables.
	WsfOpticalPath (const WsfOpticalPath::Coefficients *aCoefficientsPtr)
virtual	~WsfOpticalPath ()=default
bool	Initialize (WsfOpticalPathCoefficientTypes &aTypes, unsigned aWavelength_nm, unsigned aAtmosphereModel=2, unsigned aHazeModel=1)
double	GetAttenuation (double aSlantRange, double aTargetHeight, double aShootHeight)
	WsfOpticalPath (const WsfOpticalPathCoefficientTypes &aTypes, double aWavelength, unsigned aAtmosphereModel=2, unsigned aHazeMode=1)
	Older, deprecated version of custom constructor.

Friends
class	WsfOpticalPathCoefficientTypes

Detailed Description

Evaluates a line-of-sight path through the atmosphere. Calculates atmospheric transmission and extinction at a given wavelength. Coefficient tables must be provided for atmospheric extinction (absorption and scattering).

Note: This extinction calculation should be used for optical wavelengths (IR-UV). Generating new tables is done using MODTRAN.

Member Enumeration Documentation

◆ Type

enum WsfOpticalPath::Type

Enumerator

cABS

cSCAT

absorption only

cBOTH

scattering only

both

Constructor & Destructor Documentation

◆ WsfOpticalPath() [1/4]

WsfOpticalPath::WsfOpticalPath ( )

Referenced by WsfOpticalPathCoefficientTypes.

◆ WsfOpticalPath() [2/4]

WsfOpticalPath::WsfOpticalPath	(	const WsfOpticalPathCoefficientTypes &	aTypes,
		unsigned	aWavelength,
		unsigned	aAtmosphereModel = 2,
		unsigned	aHazeMode = 1 )

Constructor for use with laser coefficient tables.

References WsfOpticalPathCoefficientTypes::GetCoefficients(), and WsfOpticalPathCoefficientTypes.

◆ WsfOpticalPath() [3/4]

WsfOpticalPath::WsfOpticalPath ( const WsfOpticalPath::Coefficients * aCoefficientsPtr )

◆ ~WsfOpticalPath()

virtual WsfOpticalPath::~WsfOpticalPath ( )

virtualdefault

◆ WsfOpticalPath() [4/4]

WsfOpticalPath::WsfOpticalPath	(	const WsfOpticalPathCoefficientTypes &	aTypes,
		double	aWavelength,
		unsigned	aAtmosphereModel = 2,
		unsigned	aHazeMode = 1 )

Older, deprecated version of custom constructor.

References WsfOpticalPathCoefficientTypes::GetCoefficients(), and WsfOpticalPathCoefficientTypes.

Member Function Documentation

◆ GetAttenuation()

double WsfOpticalPath::GetAttenuation	(	double	aSlantRange,
		double	aTargetHeight,
		double	aPlatformHeight )

Compute the total atmospheric transmission along a path.

Parameters

aSlantRange	The slant range along which the propagation is calculated.
aTargetHeight	The height of the endpoint of propagation.
aPlatformHeight	The height of the start point of propagation.

Returns: The transmission along the path,

References cBOTH.

◆ Initialize()

bool WsfOpticalPath::Initialize	(	WsfOpticalPathCoefficientTypes &	aTypes,
		unsigned	aWavelength_nm,
		unsigned	aAtmosphereModel = 2,
		unsigned	aHazeModel = 1 )

Initialize an already instantiated object. This method is for monochromatic (laser) use only (See WsfOpticalAttenuation::Initialize).

Parameters

aTypes	The optical path coefficient types
aWavelength_nm	The monochromatic wavelength in nanometers.
aAtmosphereModel	The atmosphere model (default of 2).
aHazeModel	The haze model to use (default of 1).

References WsfOpticalPathCoefficientTypes::GetCoefficients(), ok, and WsfOpticalPathCoefficientTypes.