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

#include <otbImageToReflectanceImageFilter.h>

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

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

typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef Functor::ImageToReflectanceImageFunctor< typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType >	FunctorType
typedef ImageToReflectanceImageFilter	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
VectorType	m_Alpha
VectorType	m_Beta
double	m_ZenithalSolarAngle
double	m_FluxNormalizationCoefficient
VectorType	m_SolarIllumination
bool	m_UseClamp
bool	m_IsSetFluxNormalizationCoefficient
int	m_Day
int	m_Month
double	m_SolarDistance
bool	m_IsSetSolarDistance
static Pointer	New ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetAlpha (VectorType _arg)
virtual const VectorType &	GetAlpha () const
virtual void	SetBeta (VectorType _arg)
virtual const VectorType &	GetBeta () const
virtual void	SetSolarIllumination (VectorType _arg)
virtual const VectorType &	GetSolarIllumination () const
virtual void	SetZenithalSolarAngle (double _arg)
virtual const double &	GetZenithalSolarAngle () const
virtual void	SetUseClamp (bool _arg)
virtual const bool &	GetUseClamp () const
virtual void	SetElevationSolarAngle (double elevationAngle)
virtual double	GetElevationSolarAngle () const
void	SetFluxNormalizationCoefficient (double coef)
void	SetSolarDistance (double value)
virtual const double &	GetSolarDistance () const
virtual void	SetIsSetSolarDistance (bool _arg)
virtual const bool &	GetIsSetSolarDistance () const
virtual void	SetDay (int _arg)
virtual const int &	GetDay () const
virtual void	SetMonth (int _arg)
virtual const int &	GetMonth () const
	ImageToReflectanceImageFilter ()
	~ImageToReflectanceImageFilter () override
void	BeforeThreadedGenerateData (void) override

Additional Inherited Members
Public Types inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToReflectanceImageFunctor< 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::ImageToReflectanceImageFunctor< 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::ImageToReflectanceImageFunctor< 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::ImageToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static Pointer	New ()
Static Public Attributes inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToReflectanceImageFunctor< TInputImage::InternalPixelType, TOutputImage::InternalPixelType > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Protected Member Functions inherited from otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, Functor::ImageToReflectanceImageFunctor< 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::ImageToReflectanceImageFilter< TInputImage, TOutputImage >

Convert a raw value into a reflectance value.

Transform a classical image into the reflectance image. For this it uses the functor ImageToReflectanceFunctor calling for each component of each pixel. The flux normalization coefficient (that is the ratio solar distance over mean solar distance) can be directly set as well as the solar distance or the user can give the day and the month of the observation and the class will used a coefficient given by a 6S routine that will give the corresponding coefficient. To note that in the case, 6S gives the square of the distances ratio.

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

Definition at line 138 of file otbImageToReflectanceImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage >

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

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

Definition at line 158 of file otbImageToReflectanceImageFilter.h.

FunctorType

template<class TInputImage , class TOutputImage >

typedef Functor::ImageToReflectanceImageFunctor<typename InputImageType::InternalPixelType, typename OutputImageType::InternalPixelType> otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::FunctorType

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

Definition at line 152 of file otbImageToReflectanceImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 169 of file otbImageToReflectanceImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 150 of file otbImageToReflectanceImageFilter.h.

InputInternalPixelType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 168 of file otbImageToReflectanceImageFilter.h.

InputPixelType

template<class TInputImage , class TOutputImage >

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

Supported images definition.

Definition at line 164 of file otbImageToReflectanceImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 172 of file otbImageToReflectanceImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 151 of file otbImageToReflectanceImageFilter.h.

OutputInternalPixelType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 171 of file otbImageToReflectanceImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 170 of file otbImageToReflectanceImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

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

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

Definition at line 157 of file otbImageToReflectanceImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

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

"typedef" for standard classes.

Definition at line 155 of file otbImageToReflectanceImageFilter.h.

SizeType

template<class TInputImage , class TOutputImage >

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

Image size "typedef" definition.

Definition at line 177 of file otbImageToReflectanceImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

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

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

Definition at line 156 of file otbImageToReflectanceImageFilter.h.

VectorType

template<class TInputImage , class TOutputImage >

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

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

Definition at line 174 of file otbImageToReflectanceImageFilter.h.

Constructor & Destructor Documentation

ImageToReflectanceImageFilter()

template<class TInputImage , class TOutputImage >

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

inlineprotected

Constructor

Definition at line 266 of file otbImageToReflectanceImageFilter.h.

~ImageToReflectanceImageFilter()

template<class TInputImage , class TOutputImage >

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

inlineoverrideprotected

Destructor

Definition at line 283 of file otbImageToReflectanceImageFilter.h.

Member Function Documentation

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >

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

inlineoverrideprotected

Update the functor list and input parameters

Definition at line 288 of file otbImageToReflectanceImageFilter.h.

References otb::AcquisitionDate, otb::CONST_PI_180, otb::VarSol::GetVarSol(), otbMsgDevMacro, otb::PhysicalBias, otb::PhysicalGain, otb::Functor::ImageToReflectanceImageFunctor< TInput, TOutput >::SetAlpha(), otb::Functor::ImageToReflectanceImageFunctor< TInput, TOutput >::SetBeta(), otb::Functor::ImageToReflectanceImageFunctor< TInput, TOutput >::SetIlluminationCorrectionCoefficient(), otb::Functor::ImageToReflectanceImageFunctor< TInput, TOutput >::SetSolarIllumination(), otb::Functor::ImageToReflectanceImageFunctor< TInput, TOutput >::SetUseClamp(), otb::SolarIrradiance, and otb::SunElevation.

CreateAnother()

template<class TInputImage , class TOutputImage >

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

(

void

)

const

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

GetAlpha()

template<class TInputImage , class TOutputImage >

virtual const VectorType& otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::GetAlpha ( ) const

virtual

Give the absolute calibration gains.

GetBeta()

template<class TInputImage , class TOutputImage >

virtual const VectorType& otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::GetBeta ( ) const

virtual

Give the absolute calibration bias.

GetDay()

template<class TInputImage , class TOutputImage >

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

virtual

Get the acquisition day.

GetElevationSolarAngle()

template<class TInputImage , class TOutputImage >

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

inlinevirtual

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

Definition at line 221 of file otbImageToReflectanceImageFilter.h.

GetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >

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

virtual

Give the IsSetSolarDistance boolean.

GetMonth()

template<class TInputImage , class TOutputImage >

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

virtual

Get the acquisition month.

GetNameOfClass()

template<class TInputImage , class TOutputImage >

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

virtual

return class name.

GetSolarDistance()

template<class TInputImage , class TOutputImage >

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

virtual

Give the solar distance.

GetSolarIllumination()

template<class TInputImage , class TOutputImage >

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

virtual

Give the solar illumination value.

GetUseClamp()

template<class TInputImage , class TOutputImage >

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

virtual

Give the useClamp flag.

GetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >

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

virtual

Give the zenithal solar angle.

New()

template<class TInputImage , class TOutputImage >

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

static

object factory method.

SetAlpha()

template<class TInputImage , class TOutputImage >

virtual void otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::SetAlpha ( VectorType  _arg )

virtual

Set the absolute calibration gains.

SetBeta()

template<class TInputImage , class TOutputImage >

virtual void otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::SetBeta ( VectorType  _arg )

virtual

Set the absolute calibration bias.

SetDay()

template<class TInputImage , class TOutputImage >

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

virtual

Set the acquisition day.

SetElevationSolarAngle()

template<class TInputImage , class TOutputImage >

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

inlinevirtual

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

Definition at line 210 of file otbImageToReflectanceImageFilter.h.

SetFluxNormalizationCoefficient()

template<class TInputImage , class TOutputImage >

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

inline

Set the flux normalization coefficient.

Definition at line 227 of file otbImageToReflectanceImageFilter.h.

SetIsSetSolarDistance()

template<class TInputImage , class TOutputImage >

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

virtual

Set the IsSetSolarDistance boolean.

SetMonth()

template<class TInputImage , class TOutputImage >

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

virtual

Set the acquisition month.

SetSolarDistance()

template<class TInputImage , class TOutputImage >

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

inline

Set the solar distance.

Definition at line 236 of file otbImageToReflectanceImageFilter.h.

SetSolarIllumination()

template<class TInputImage , class TOutputImage >

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

virtual

Set the solar illumination value.

SetUseClamp()

template<class TInputImage , class TOutputImage >

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

virtual

Set the useClamp flag.

SetZenithalSolarAngle()

template<class TInputImage , class TOutputImage >

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

virtual

Set the zenithal solar angle.

Member Data Documentation

InputImageDimension

template<class TInputImage , class TOutputImage >

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

static

Extract input and output images dimensions.

Definition at line 145 of file otbImageToReflectanceImageFilter.h.

m_Alpha

template<class TInputImage , class TOutputImage >

VectorType otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::m_Alpha

private

Ponderation declaration

Definition at line 373 of file otbImageToReflectanceImageFilter.h.

m_Beta

template<class TInputImage , class TOutputImage >

VectorType otb::ImageToReflectanceImageFilter< TInputImage, TOutputImage >::m_Beta

private

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

Definition at line 374 of file otbImageToReflectanceImageFilter.h.

m_Day

template<class TInputImage , class TOutputImage >

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

private

Acquisition Day

Definition at line 393 of file otbImageToReflectanceImageFilter.h.

m_FluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >

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

private

Flux normalization coefficient.

Definition at line 380 of file otbImageToReflectanceImageFilter.h.

m_IsSetFluxNormalizationCoefficient

template<class TInputImage , class TOutputImage >

bool otb::ImageToReflectanceImageFilter< 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 390 of file otbImageToReflectanceImageFilter.h.

m_IsSetSolarDistance

template<class TInputImage , class TOutputImage >

bool otb::ImageToReflectanceImageFilter< 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 403 of file otbImageToReflectanceImageFilter.h.

m_Month

template<class TInputImage , class TOutputImage >

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

private

Acquisition Month

Definition at line 396 of file otbImageToReflectanceImageFilter.h.

m_SolarDistance

template<class TInputImage , class TOutputImage >

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

private

Solar distance.

Definition at line 399 of file otbImageToReflectanceImageFilter.h.

m_SolarIllumination

template<class TInputImage , class TOutputImage >

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

private

Solar illumination value.

Definition at line 383 of file otbImageToReflectanceImageFilter.h.

m_UseClamp

template<class TInputImage , class TOutputImage >

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

private

Flag to activate clamping between 0 and 1

Definition at line 386 of file otbImageToReflectanceImageFilter.h.

m_ZenithalSolarAngle

template<class TInputImage , class TOutputImage >

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

private

Set the zenithal soalr angle.

Definition at line 377 of file otbImageToReflectanceImageFilter.h.

OutputImageDimension

template<class TInputImage , class TOutputImage >

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

static

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

Definition at line 146 of file otbImageToReflectanceImageFilter.h.

---

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

• otbImageToReflectanceImageFilter.h