otb::ImageMetadataCorrectionParameters Class Reference

#include <otbImageMetadataCorrectionParameters.h>

Inheritance diagram for otb::ImageMetadataCorrectionParameters:

Collaboration diagram for otb::ImageMetadataCorrectionParameters:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef ObjectList< FilterFunctionValues >	InternalWavelengthSpectralBandVectorType
typedef itk::SmartPointer< Self >	Pointer
typedef ImageMetadataCorrectionParameters	Self
typedef itk::Object	Superclass
typedef InternalWavelengthSpectralBandVectorType::Pointer	WavelengthSpectralBandVectorType

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual double	GetSolarZenithalAngle ()
virtual void	SetSolarZenithalAngle (double _arg)

Static Public Member Functions
static Pointer	New ()
double	m_SolarZenithalAngle
double	m_SolarAzimutalAngle
double	m_ViewingZenithalAngle
double	m_ViewingAzimutalAngle
unsigned int	m_Month
unsigned int	m_Day
unsigned int	m_Year
std::string	m_FilterFunctionValuesFileName
WavelengthSpectralBandVectorType	m_WavelengthSpectralBand
virtual void	SetSolarAzimutalAngle (double _arg)
virtual double	GetSolarAzimutalAngle ()
virtual void	SetViewingZenithalAngle (double _arg)
virtual double	GetViewingZenithalAngle ()
virtual void	SetViewingAzimutalAngle (double _arg)
virtual double	GetViewingAzimutalAngle ()
virtual void	SetMonth (unsigned int _arg)
virtual unsigned int	GetMonth ()
virtual void	SetDay (unsigned int _arg)
virtual unsigned int	GetDay ()
virtual void	SetYear (unsigned int _arg)
virtual unsigned int	GetYear ()
virtual void	SetFilterFunctionValuesFileName (std::string _arg)
virtual std::string	GetFilterFunctionValuesFileName ()
void	SetWavelengthSpectralBand (const WavelengthSpectralBandVectorType &waveband)
void	SetWavelengthSpectralBandWithIndex (unsigned int id, const FilterFunctionValues::Pointer &function)
WavelengthSpectralBandVectorType	GetWavelengthSpectralBand () const
const WavelengthSpectralBandVectorType *	GetWavelengthSpectralBandRef () const
void	LoadFilterFunctionValue (const std::string &filename)
void	LoadFilterFunctionValue ()
	ImageMetadataCorrectionParameters ()
	~ImageMetadataCorrectionParameters () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	ImageMetadataCorrectionParameters (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

This class contains all atmospheric correction parameters.

Each value can be read in the metadata of an image (ex: SPOT5, ...) or directly set by the user.

Examples

Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 46 of file otbImageMetadataCorrectionParameters.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::ImageMetadataCorrectionParameters::ConstPointer

Definition at line 53 of file otbImageMetadataCorrectionParameters.h.

InternalWavelengthSpectralBandVectorType

typedef ObjectList<FilterFunctionValues> otb::ImageMetadataCorrectionParameters::InternalWavelengthSpectralBandVectorType

Definition at line 59 of file otbImageMetadataCorrectionParameters.h.

Pointer

typedef itk::SmartPointer<Self> otb::ImageMetadataCorrectionParameters::Pointer

Definition at line 52 of file otbImageMetadataCorrectionParameters.h.

Self

typedef ImageMetadataCorrectionParameters otb::ImageMetadataCorrectionParameters::Self

Standard typedefs

Definition at line 50 of file otbImageMetadataCorrectionParameters.h.

Superclass

typedef itk::Object otb::ImageMetadataCorrectionParameters::Superclass

Definition at line 51 of file otbImageMetadataCorrectionParameters.h.

WavelengthSpectralBandVectorType

typedef InternalWavelengthSpectralBandVectorType::Pointer otb::ImageMetadataCorrectionParameters::WavelengthSpectralBandVectorType

Definition at line 62 of file otbImageMetadataCorrectionParameters.h.

Constructor & Destructor Documentation

ImageMetadataCorrectionParameters() [1/2]

otb::ImageMetadataCorrectionParameters::ImageMetadataCorrectionParameters

(

)

Constructor

~ImageMetadataCorrectionParameters()

otb::ImageMetadataCorrectionParameters::~ImageMetadataCorrectionParameters ( )

inlineoverride

Destructor

Definition at line 159 of file otbImageMetadataCorrectionParameters.h.

ImageMetadataCorrectionParameters() [2/2]

otb::ImageMetadataCorrectionParameters::ImageMetadataCorrectionParameters ( const Self &  )

privatedelete

The Solar zenithal angle

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::ImageMetadataCorrectionParameters::CreateAnother

(

void

)

const

GetDay()

virtual unsigned int otb::ImageMetadataCorrectionParameters::GetDay ( )

virtual

The Solar zenithal angle

GetFilterFunctionValuesFileName()

virtual std::string otb::ImageMetadataCorrectionParameters::GetFilterFunctionValuesFileName ( )

virtual

The Solar zenithal angle

GetMonth()

virtual unsigned int otb::ImageMetadataCorrectionParameters::GetMonth ( )

virtual

The Solar zenithal angle

GetNameOfClass()

virtual const char* otb::ImageMetadataCorrectionParameters::GetNameOfClass ( ) const

virtual

Type macro

GetSolarAzimutalAngle()

virtual double otb::ImageMetadataCorrectionParameters::GetSolarAzimutalAngle ( )

virtual

The Solar zenithal angle

GetSolarZenithalAngle()

virtual double otb::ImageMetadataCorrectionParameters::GetSolarZenithalAngle ( )

virtual

GetViewingAzimutalAngle()

virtual double otb::ImageMetadataCorrectionParameters::GetViewingAzimutalAngle ( )

virtual

The Solar zenithal angle

GetViewingZenithalAngle()

virtual double otb::ImageMetadataCorrectionParameters::GetViewingZenithalAngle ( )

virtual

The Solar zenithal angle

GetWavelengthSpectralBand()

WavelengthSpectralBandVectorType otb::ImageMetadataCorrectionParameters::GetWavelengthSpectralBand ( ) const

inline

The Solar zenithal angle

Definition at line 135 of file otbImageMetadataCorrectionParameters.h.

Referenced by otb::RadiometryCorrectionParametersToAtmosphericRadiativeTerms::Compute().

GetWavelengthSpectralBandRef()

const WavelengthSpectralBandVectorType* otb::ImageMetadataCorrectionParameters::GetWavelengthSpectralBandRef ( ) const

inline

The Solar zenithal angle

Definition at line 139 of file otbImageMetadataCorrectionParameters.h.

GetYear()

virtual unsigned int otb::ImageMetadataCorrectionParameters::GetYear ( )

virtual

The Solar zenithal angle

LoadFilterFunctionValue() [1/2]

void otb::ImageMetadataCorrectionParameters::LoadFilterFunctionValue ( )

inline

The Solar zenithal angle

Definition at line 149 of file otbImageMetadataCorrectionParameters.h.

LoadFilterFunctionValue() [2/2]

void otb::ImageMetadataCorrectionParameters::LoadFilterFunctionValue

(

const std::string &

filename

)

Read a file that contains filter function values on the 6S format.

New()

static Pointer otb::ImageMetadataCorrectionParameters::New ( )

static

Creation through object factory macro

Referenced by otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ReflectanceToSurfaceReflectanceImageFilter(), otb::SurfaceAdjacencyEffectCorrectionSchemeFilter< TInputImage, TOutputImage >::SurfaceAdjacencyEffectCorrectionSchemeFilter(), and otb::SurfaceReflectanceToReflectanceFilter< TInputImage, TOutputImage >::SurfaceReflectanceToReflectanceFilter().

operator=()

void otb::ImageMetadataCorrectionParameters::operator= ( const Self &  )

privatedelete

The Solar zenithal angle

PrintSelf()

void otb::ImageMetadataCorrectionParameters::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

PrintSelf method

SetDay()

virtual void otb::ImageMetadataCorrectionParameters::SetDay ( unsigned int  _arg )

virtual

Set/Get the day.

SetFilterFunctionValuesFileName()

virtual void otb::ImageMetadataCorrectionParameters::SetFilterFunctionValuesFileName ( std::string  _arg )

virtual

Get/Set FilterFunction file name.

SetMonth()

virtual void otb::ImageMetadataCorrectionParameters::SetMonth ( unsigned int  _arg )

virtual

Set/Get the month.

SetSolarAzimutalAngle()

virtual void otb::ImageMetadataCorrectionParameters::SetSolarAzimutalAngle ( double  _arg )

virtual

Set/Get the solar azimutal angle.

SetSolarZenithalAngle()

virtual void otb::ImageMetadataCorrectionParameters::SetSolarZenithalAngle ( double  _arg )

virtual

Set/Get the solar zenithal angle.

SetViewingAzimutalAngle()

virtual void otb::ImageMetadataCorrectionParameters::SetViewingAzimutalAngle ( double  _arg )

virtual

Set/Get the viewing azimutal angle.

SetViewingZenithalAngle()

virtual void otb::ImageMetadataCorrectionParameters::SetViewingZenithalAngle ( double  _arg )

virtual

Set/Get the viewing zenithal angle.

SetWavelengthSpectralBand()

void otb::ImageMetadataCorrectionParameters::SetWavelengthSpectralBand ( const WavelengthSpectralBandVectorType &  waveband )

inline

Set/Get the wavelength spectral band.

Definition at line 119 of file otbImageMetadataCorrectionParameters.h.

SetWavelengthSpectralBandWithIndex()

void otb::ImageMetadataCorrectionParameters::SetWavelengthSpectralBandWithIndex ( unsigned int  id, const FilterFunctionValues::Pointer &  function  )

inline

The Solar zenithal angle

Definition at line 123 of file otbImageMetadataCorrectionParameters.h.

SetYear()

virtual void otb::ImageMetadataCorrectionParameters::SetYear ( unsigned int  _arg )

virtual

Set/Get the year.

Member Data Documentation

m_Day

unsigned int otb::ImageMetadataCorrectionParameters::m_Day

private

The Day (in the month)

Definition at line 187 of file otbImageMetadataCorrectionParameters.h.

m_FilterFunctionValuesFileName

std::string otb::ImageMetadataCorrectionParameters::m_FilterFunctionValuesFileName

private

The Solar zenithal angle

Definition at line 191 of file otbImageMetadataCorrectionParameters.h.

m_Month

unsigned int otb::ImageMetadataCorrectionParameters::m_Month

private

The Month

Definition at line 184 of file otbImageMetadataCorrectionParameters.h.

m_SolarAzimutalAngle

double otb::ImageMetadataCorrectionParameters::m_SolarAzimutalAngle

private

The Solar azimutal angle

Definition at line 175 of file otbImageMetadataCorrectionParameters.h.

m_SolarZenithalAngle

double otb::ImageMetadataCorrectionParameters::m_SolarZenithalAngle

private

The Solar zenithal angle

Definition at line 172 of file otbImageMetadataCorrectionParameters.h.

m_ViewingAzimutalAngle

double otb::ImageMetadataCorrectionParameters::m_ViewingAzimutalAngle

private

The Viewing azimutal angle

Definition at line 181 of file otbImageMetadataCorrectionParameters.h.

m_ViewingZenithalAngle

double otb::ImageMetadataCorrectionParameters::m_ViewingZenithalAngle

private

The Viewing zenithal angle

Definition at line 178 of file otbImageMetadataCorrectionParameters.h.

m_WavelengthSpectralBand

WavelengthSpectralBandVectorType otb::ImageMetadataCorrectionParameters::m_WavelengthSpectralBand

private

Wavelength for the each spectral band definition

Definition at line 194 of file otbImageMetadataCorrectionParameters.h.

m_Year

unsigned int otb::ImageMetadataCorrectionParameters::m_Year

private

The Year

Definition at line 190 of file otbImageMetadataCorrectionParameters.h.

---

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

• otbImageMetadataCorrectionParameters.h