otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbRadianceToReflectanceImageFilter.h>

Inheritance diagram for otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >:

typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef Functor::RadianceToReflectanceImageFunctor< typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType >	FunctorType
typedef RadianceToReflectanceImageFilter	Self
typedef UnaryImageFunctorWithVectorImageFilter< InputImageType, OutputImageType, FunctorType >	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::InternalPixelType	InputInternalPixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputImageType::InternalPixelType	OutputInternalPixelType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef itk::VariableLengthVector< double >	VectorType
typedef InputImageType::SizeType	SizeType
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
double	m_ZenithalSolarAngle
double	m_FluxNormalizationCoefficient
int	m_Day
int	m_Month
double	m_SolarDistance
VectorType	m_SolarIllumination
bool	m_IsSetFluxNormalizationCoefficient
bool	m_IsSetSolarDistance
bool	m_UseClamp
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetSolarIllumination (VectorType _arg)
virtual const VectorType &	GetSolarIllumination () const
virtual void	SetZenithalSolarAngle (double _arg)
virtual const double &	GetZenithalSolarAngle () const
virtual void	SetElevationSolarAngle (double elevationAngle)
virtual double	GetElevationSolarAngle () const
virtual void	SetDay (int _arg)
virtual const int &	GetDay () const
virtual void	SetMonth (int _arg)
virtual const int &	GetMonth () const
void	SetFluxNormalizationCoefficient (double coef)
virtual const double &	GetFluxNormalizationCoefficient () const
void	SetSolarDistance (double value)
virtual const double &	GetSolarDistance () const
virtual void	SetIsSetSolarDistance (bool _arg)
virtual const bool &	GetIsSetSolarDistance () const
virtual void	SetIsSetFluxNormalizationCoefficient (bool _arg)
virtual const bool &	GetIsSetFluxNormalizationCoefficient () const
virtual void	SetUseClamp (bool _arg)
virtual const bool &	GetUseClamp () const
	RadianceToReflectanceImageFilter ()
	~RadianceToReflectanceImageFilter () override
void	BeforeThreadedGenerateData (void) override

Additional Inherited Members
Public Types inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef UnaryImageFunctorWithVectorImageFilter	Self
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage >	Superclass
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType >	FunctorType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::InternalPixelType	InputInternalPixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputImageType::InternalPixelType	OutputInternalPixelType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef InputImageType::SizeType	SizeType
typedef std::vector< FunctorType >	FunctorVectorType
Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
FunctorVectorType &	GetFunctorVector (void)
Static Public Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static Pointer	New ()
Static Public Attributes inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Protected Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::RadianceToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
	UnaryImageFunctorWithVectorImageFilter ()
	~UnaryImageFunctorWithVectorImageFilter () override
void	GenerateOutputInformation () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >

Convert radiance value into reflectance value.

Transform a radiance image into the reflectance. For this it uses the functor RadianceToReflectanceImageFunctor calling for each component of each pixel.

For Spot image in the dimap format, the correction parameters are retrieved automatically from the metadata

Examples

Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 129 of file otbRadianceToReflectanceImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::ConstPointer

"typedef" to simplify the variables definition and the declaration.

Definition at line 150 of file otbRadianceToReflectanceImageFilter.h.

FunctorType

template<class TInputImage , class TOutputImage >

typedef Functor::RadianceToReflectanceImageFunctor<typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType> otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::FunctorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 144 of file otbRadianceToReflectanceImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::InputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 161 of file otbRadianceToReflectanceImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::InputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 141 of file otbRadianceToReflectanceImageFilter.h.

InputInternalPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::InternalPixelType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 160 of file otbRadianceToReflectanceImageFilter.h.

InputPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::InputPixelType

Supported images definition.

Definition at line 156 of file otbRadianceToReflectanceImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 164 of file otbRadianceToReflectanceImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::OutputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 142 of file otbRadianceToReflectanceImageFilter.h.

OutputInternalPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::InternalPixelType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 163 of file otbRadianceToReflectanceImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::OutputPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 162 of file otbRadianceToReflectanceImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<Self> otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::Pointer

"typedef" to simplify the variables definition and the declaration.

Definition at line 149 of file otbRadianceToReflectanceImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

typedef RadianceToReflectanceImageFilter otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::Self

"typedef" for standard classes.

Definition at line 147 of file otbRadianceToReflectanceImageFilter.h.

SizeType

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SizeType

Image size "typedef" definition.

Definition at line 169 of file otbRadianceToReflectanceImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

typedef UnaryImageFunctorWithVectorImageFilter<InputImageType, OutputImageType, FunctorType> otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::Superclass

"typedef" to simplify the variables definition and the declaration.

Definition at line 148 of file otbRadianceToReflectanceImageFilter.h.

VectorType

template<class TInputImage , class TOutputImage >

typedef itk::VariableLengthVector<double> otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::VectorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 166 of file otbRadianceToReflectanceImageFilter.h.

Constructor & Destructor Documentation

RadianceToReflectanceImageFilter()

template<class TInputImage , class TOutputImage >

otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::RadianceToReflectanceImageFilter ( )

inlineprotected

Constructor

Definition at line 254 of file otbRadianceToReflectanceImageFilter.h.

~RadianceToReflectanceImageFilter()

template<class TInputImage , class TOutputImage >

otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::~RadianceToReflectanceImageFilter ( )

inlineoverrideprotected

Destructor

Definition at line 269 of file otbRadianceToReflectanceImageFilter.h.

Member Function Documentation

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )

inlineoverrideprotected

Update the functor list and input parameters

Definition at line 274 of file otbRadianceToReflectanceImageFilter.h.

References otb::AcquisitionDate, otb::CONST_PI_180, otb::VarSol::GetVarSol(), otbMsgDevMacro, otb::Functor::RadianceToReflectanceImageFunctor< TInput, TOutput >::SetIlluminationCorrectionCoefficient(), otb::Functor::RadianceToReflectanceImageFunctor< TInput, TOutput >::SetSolarIllumination(), otb::Functor::RadianceToReflectanceImageFunctor< TInput, TOutput >::SetUseClamp(), otb::SolarIrradiance, and otb::SunElevation.

CreateAnother()

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

const

"typedef" to simplify the variables definition and the declaration.

GetDay()

template<class TInputImage , class TOutputImage >

virtual const int& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetDay ( ) const

virtual

Give the day.

GetElevationSolarAngle()

template<class TInputImage , class TOutputImage >

virtual double otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetElevationSolarAngle ( ) const

inlinevirtual

"typedef" to simplify the variables definition and the declaration.

Definition at line 195 of file otbRadianceToReflectanceImageFilter.h.

GetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >

virtual const double& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetFluxNormalizationCoefficient ( ) const

virtual

Give the flux normalization coefficient.

GetIsSetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >

virtual const bool& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetIsSetFluxNormalizationCoefficient ( ) const

virtual

Give the IsSetFluxNormalizationCoefficient boolean.

GetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >

virtual const bool& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetIsSetSolarDistance ( ) const

virtual

Give the IsSetSolarDistance boolean.

GetMonth()

template<class TInputImage , class TOutputImage >

virtual const int& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetMonth ( ) const

virtual

Give the month.

GetNameOfClass()

template<class TInputImage , class TOutputImage >

virtual const char* otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

return class name.

GetSolarDistance()

template<class TInputImage , class TOutputImage >

virtual const double& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetSolarDistance ( ) const

virtual

Give the solar distance.

GetSolarIllumination()

template<class TInputImage , class TOutputImage >

virtual const VectorType& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetSolarIllumination ( ) const

virtual

Give the solar illumination value.

GetUseClamp()

template<class TInputImage , class TOutputImage >

virtual const bool& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetUseClamp ( ) const

virtual

Give the UseClamp boolean.

GetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >

virtual const double& otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::GetZenithalSolarAngle ( ) const

virtual

Give the zenithal solar angle.

New()

template<class TInputImage , class TOutputImage >

static Pointer otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::New ( )

static

object factory method.

SetDay()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetDay ( int  _arg )

virtual

Set the day.

SetElevationSolarAngle()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetElevationSolarAngle ( double  elevationAngle )

inlinevirtual

Set/Get the sun elevation angle (internally handled by the zenithal angle)

Definition at line 184 of file otbRadianceToReflectanceImageFilter.h.

SetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >

void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetFluxNormalizationCoefficient ( double  coef )

inline

Set the flux normalization coefficient.

Definition at line 213 of file otbRadianceToReflectanceImageFilter.h.

SetIsSetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetIsSetFluxNormalizationCoefficient ( bool  _arg )

virtual

Set the IsSetFluxNormalizationCoefficient boolean.

SetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetIsSetSolarDistance ( bool  _arg )

virtual

Set the IsSetSolarDistance boolean.

SetMonth()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetMonth ( int  _arg )

virtual

Set the month.

SetSolarDistance()

template<class TInputImage , class TOutputImage >

void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetSolarDistance ( double  value )

inline

Set the solar distance.

Definition at line 224 of file otbRadianceToReflectanceImageFilter.h.

SetSolarIllumination()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetSolarIllumination ( VectorType  _arg )

virtual

Set the solar illumination value.

SetUseClamp()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetUseClamp ( bool  _arg )

virtual

Set the UseClamp boolean.

SetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >

virtual void otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::SetZenithalSolarAngle ( double  _arg )

virtual

Set the zenithal solar angle.

Member Data Documentation

InputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

Extract input and output images dimensions.

Definition at line 136 of file otbRadianceToReflectanceImageFilter.h.

m_Day

template<class TInputImage , class TOutputImage >

int otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_Day

private

Acquisition day.

Definition at line 351 of file otbRadianceToReflectanceImageFilter.h.

m_FluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >

double otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_FluxNormalizationCoefficient

private

Flux normalization coefficient.

Definition at line 348 of file otbRadianceToReflectanceImageFilter.h.

m_IsSetFluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >

bool otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_IsSetFluxNormalizationCoefficient

private

Used to know if the user has set a value for the FluxNormalizationCoefficient parameter or if the class has to compute it

Definition at line 364 of file otbRadianceToReflectanceImageFilter.h.

m_IsSetSolarDistance

template<class TInputImage , class TOutputImage >

bool otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_IsSetSolarDistance

private

Used to know if the user has set a value for the SolarDistance parameter or if the class has to compute it

Definition at line 368 of file otbRadianceToReflectanceImageFilter.h.

m_Month

template<class TInputImage , class TOutputImage >

int otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_Month

private

Acquisition month.

Definition at line 354 of file otbRadianceToReflectanceImageFilter.h.

m_SolarDistance

template<class TInputImage , class TOutputImage >

double otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_SolarDistance

private

Solar distance.

Definition at line 357 of file otbRadianceToReflectanceImageFilter.h.

m_SolarIllumination

template<class TInputImage , class TOutputImage >

VectorType otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_SolarIllumination

private

Solar illumination value.

Definition at line 360 of file otbRadianceToReflectanceImageFilter.h.

m_UseClamp

template<class TInputImage , class TOutputImage >

bool otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_UseClamp

private

Clamp values to [0,1]

Definition at line 371 of file otbRadianceToReflectanceImageFilter.h.

m_ZenithalSolarAngle

template<class TInputImage , class TOutputImage >

double otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::m_ZenithalSolarAngle

private

Set the zenithal soalr angle.

Definition at line 345 of file otbRadianceToReflectanceImageFilter.h.

OutputImageDimension

template<class TInputImage , class TOutputImage >

const unsigned int otb::RadianceToReflectanceImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

"typedef" to simplify the variables definition and the declaration.

Definition at line 137 of file otbRadianceToReflectanceImageFilter.h.

---

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

• otbRadianceToReflectanceImageFilter.h