skOpticalProperties  2.1
Public Member Functions | List of all members
skOpticalProperties_ConvolvedDiscreteWavelenCachedStateFixedFWHM Class Reference

#include <skconvolvedopticalproperties.h>

Inheritance diagram for skOpticalProperties_ConvolvedDiscreteWavelenCachedStateFixedFWHM:
skOpticalProperties_ConvolvedDiscreteWavelenCachedState skOpticalProperties

Public Member Functions

void SetFWHM (double fwhm)
 
virtual bool GetTargetFWHM (double wavelen_nm, double *fwhm_nm) const override
 
- Public Member Functions inherited from skOpticalProperties_ConvolvedDiscreteWavelenCachedState
bool SetHighResOpticalProperties (skOpticalProperties *highresopticalproperties, skWavelengthToPSF_Table *measurementdetails, skOpticalProperty_AdditionalStateInfo *atmosphericstateinfo)
 
virtual bool SetAtmosphericState (skClimatology *neutralatmosphere, const GEODETIC_INSTANT &pt, bool *crosssectionschanged) override
 Sets the atmospheric state and location for calculating cross-sections, usually temperature, pressure and position. More...
 
virtual bool UpdateInternalClimatology (const GEODETIC_INSTANT &pt) override
 
virtual bool CalculateCrossSections (double wavenumber, double *absxs, double *extxs, double *scattxs, size_t threadindex) override
 Calculate cross-sections at the specified wave-number. More...
 
virtual bool CalculatePhaseMatrix (double wavenumber, double cosscatterangle, skRTPhaseMatrix *phasematrix, size_t threadindex) override
 Calculate the phase matrix at the specified wavenumber and scattering angle. More...
 
virtual bool IsScatterer () const override
 Returns true if this particles scatters radiation.
 
virtual bool IsAbsorber () const override
 Returns true if this particles absorbs radiation radiation.
 
- Public Member Functions inherited from skOpticalProperties
 skOpticalProperties ()
 
bool GetRotatedPhaseMatrix (double wavenum, double mu, double muprime, double dphi, skRTPhaseMatrix *rotatedmatrix, size_t threadindex)
 Returns the rotated phase matrix necessary for scattering. More...
 
void CheckCosineRange (double *mu)
 
bool IsDeltaFunctionForwardScatter () const
 Returns true if this cross-section has a delta function forward scatter element.
 
virtual bool CalculateCrossSectionsArray (const std::vector< double > &wavenumber, std::vector< double > *absxs, std::vector< double > *extxs, std::vector< double > *scattxs)
 Calculate cross-sections at the specified array of wave-numbers. More...
 

Detailed Description

An implementation of skOpticalProperties_ConvolvedDiscreteWavelenCachedState that uses constant value for the target convolution. See SetFWHM

Member Function Documentation

void skOpticalProperties_ConvolvedDiscreteWavelenCachedStateFixedFWHM::SetFWHM ( double  fwhm)
inline

set the desired spectral resolution of the final convolution expressed as FWHM in nanometers.

Parameters
[in]fwhmThe desired spectral resolution, FWHM in nanometers.
virtual bool skOpticalProperties_ConvolvedDiscreteWavelenCachedStateFixedFWHM::GetTargetFWHM ( double  wavelen_nm,
double *  fwhm_nm 
) const
inlineoverridevirtual

A purely virtual function that fetches the desired spectral resolution of the target convolution centered at the wavelength of interest. End users usually dont call this function as it automatically called when doing the convolution calculation. This function must be implemented in a derived class.

Parameters
[in]wavelen_nmThe wavelength at the which the spectral resolution is required
[out]fwhm_nmReturns the spectral resolution at the desired wavelength as a FWHM in nanmeters.
Returns
True if successful.

Implements skOpticalProperties_ConvolvedDiscreteWavelenCachedState.


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