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

#include <otbSarRadiometricCalibrationToImageFilter.h>

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

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

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::FunctionPointer	FunctionPointer
typedef Superclass::FunctionPositionType	FunctionPositionType
typedef Superclass::FunctionType	FunctionType
typedef Superclass::FunctionValueType	FunctionValueType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef FunctionType::ParametricFunctionConstPointer	ParametricFunctionConstPointer
typedef FunctionType::ParametricFunctionPointer	ParametricFunctionPointer
typedef FunctionType::ParametricFunctionType	ParametricFunctionType
typedef itk::SmartPointer< Self >	Pointer
typedef SarRadiometricCalibrationToImageFilter	Self
typedef FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >	Superclass
Public Types inherited from otb::FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef FunctionType::Pointer	FunctionPointer
typedef FunctionType::InputType	FunctionPositionType
typedef SarRadiometricCalibrationFunction< TInputImage >	FunctionType
typedef FunctionType::OutputType	FunctionValueType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef FunctionToImageFilter	Self
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual short	GetLookupSelected () const
virtual const char *	GetNameOfClass () const
void	SetEnableNoise (bool inArg)
virtual void	SetLookupSelected (short _arg)
Public Member Functions inherited from otb::FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	SetFunction (FunctionType *PixelFunction)
FunctionType *	GetFunction ()
FunctionType const *	GetFunction () const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >
static Pointer	New ()

Protected Member Functions
void	GenerateOutputInformation () override
	SarRadiometricCalibrationToImageFilter ()
	~SarRadiometricCalibrationToImageFilter () override
void	BeforeThreadedGenerateData () override
Protected Member Functions inherited from otb::FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >
	FunctionToImageFilter ()
	~FunctionToImageFilter () override
void	BeforeThreadedGenerateData () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override

Private Member Functions
void	operator= (const Self &)=delete
	SarRadiometricCalibrationToImageFilter (const Self &)=delete

Private Attributes
short	m_LookupSelected

Additional Inherited Members
Static Public Attributes inherited from otb::FunctionToImageFilter< TInputImage, TOutputImage, SarRadiometricCalibrationFunction< TInputImage > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension

Detailed Description

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

Evaluates the SarRadiometricCalibrationFunction onto a source image The nature of product(TerrSARX, Sentinel1, etc..) are thus detected automatically from the metadata. The filter then reads necessary parameters required to perform SarCalibration in a generic way.

BeforeThreadedGenerateData() instantiate a SarRadiometricCalibrationFunction and pass the values taken from ImageMetadata instance to it. This is where the actual computation of sigma (backscatter) occurs.

Noise, Antenna pattern gain (old && new), range spread loss, incidence angle data members used in this class are all instances of SarPrametricFunction class. Each have a Evaluate() method and a special EvaluateParametricCoefficient() which computes the actual value.

See also

otb::SarParametricFunction

otb::SarCalibrationLookupBase References (Retrieved on 08-Sept-2015) Sentinel1 - https://sentinel.esa.int/web/sentinel/sentinel-1-sar-wiki/-/wiki/Sentinel%20One/Application+of+Radiometric+Calibration+LUT Radarsat2 - http://gs.mdacorporation.com/products/sensor/radarsat2/RS2_Product_Description.pdf

Definition at line 58 of file otbSarRadiometricCalibrationToImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage >

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

Definition at line 66 of file otbSarRadiometricCalibrationToImageFilter.h.

FunctionPointer

template<class TInputImage , class TOutputImage >

typedef Superclass::FunctionPointer otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::FunctionPointer

Definition at line 89 of file otbSarRadiometricCalibrationToImageFilter.h.

FunctionPositionType

template<class TInputImage , class TOutputImage >

typedef Superclass::FunctionPositionType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::FunctionPositionType

Definition at line 91 of file otbSarRadiometricCalibrationToImageFilter.h.

FunctionType

template<class TInputImage , class TOutputImage >

typedef Superclass::FunctionType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::FunctionType

Type of function.

Definition at line 88 of file otbSarRadiometricCalibrationToImageFilter.h.

FunctionValueType

template<class TInputImage , class TOutputImage >

typedef Superclass::FunctionValueType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::FunctionValueType

Definition at line 90 of file otbSarRadiometricCalibrationToImageFilter.h.

InputImagePixelType

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePixelType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 80 of file otbSarRadiometricCalibrationToImageFilter.h.

InputImagePointer

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePointer otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 78 of file otbSarRadiometricCalibrationToImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageRegionType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 79 of file otbSarRadiometricCalibrationToImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::InputImageType

Some typedefs. Image size typedef.

Definition at line 72 of file otbSarRadiometricCalibrationToImageFilter.h.

OutputImagePixelType

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePixelType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 84 of file otbSarRadiometricCalibrationToImageFilter.h.

OutputImagePointer

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePointer otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 82 of file otbSarRadiometricCalibrationToImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageRegionType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 83 of file otbSarRadiometricCalibrationToImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 81 of file otbSarRadiometricCalibrationToImageFilter.h.

ParametricFunctionConstPointer

template<class TInputImage , class TOutputImage >

typedef FunctionType::ParametricFunctionConstPointer otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::ParametricFunctionConstPointer

Definition at line 93 of file otbSarRadiometricCalibrationToImageFilter.h.

ParametricFunctionPointer

template<class TInputImage , class TOutputImage >

typedef FunctionType::ParametricFunctionPointer otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::ParametricFunctionPointer

Definition at line 92 of file otbSarRadiometricCalibrationToImageFilter.h.

ParametricFunctionType

template<class TInputImage , class TOutputImage >

typedef FunctionType::ParametricFunctionType otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::ParametricFunctionType

Definition at line 94 of file otbSarRadiometricCalibrationToImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

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

Definition at line 65 of file otbSarRadiometricCalibrationToImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

Definition at line 63 of file otbSarRadiometricCalibrationToImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

typedef FunctionToImageFilter<TInputImage, TOutputImage, SarRadiometricCalibrationFunction<TInputImage> > otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 64 of file otbSarRadiometricCalibrationToImageFilter.h.

Constructor & Destructor Documentation

SarRadiometricCalibrationToImageFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::SarRadiometricCalibrationToImageFilter

protected

Default ctor

Constructor

Definition at line 37 of file otbSarRadiometricCalibrationToImageFilter.hxx.

~SarRadiometricCalibrationToImageFilter()

template<class TInputImage , class TOutputImage >

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

inlineoverrideprotected

Empty, default virtual dtor

Definition at line 111 of file otbSarRadiometricCalibrationToImageFilter.h.

SarRadiometricCalibrationToImageFilter() [2/2]

template<class TInputImage , class TOutputImage >

otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::SarRadiometricCalibrationToImageFilter ( const Self &  )

privatedelete

Member Function Documentation

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData

overrideprotected

Update the function list and input parameters

Retrieve the ImageMetadata

Fetch the SARCalib

Get the SarRadiometricCalibrationFunction function instance.

Check if a calibration lookupdata is available with the product. eg. Sentinel1. This means A. The computation of the backscatter is based on this lookup value which depends on the given product.* B. The other value such as antenna pattern gain, rangespread loss, incidence angle has no effect in calibration

Get the lookupdata instance. Unlike all the above this is not a parametricFunction instance. But rather an internal class in IMI called SarCalibrationLookupData.

NOTE: As the computation of lookup data for sensors is not universal. One must provide a sub-class. See Also: otbSentinel1ImageMetadataInterface, otbTerraSarImageMetadataInterface, otbRadarsat2ImageMetadataInterface

This was introduced for cosmoskymed which required a rescaling factor

Definition at line 64 of file otbSarRadiometricCalibrationToImageFilter.hxx.

References otb::ogr::apply(), otb::SARCalib::calibrationLookupData, otb::SARCalib::calibrationLookupFlag, otb::CalScale, otb::SarCalibrationLookupData::NOISE, otb::SARCalib::radiometricCalibrationAntennaPatternNewGain, otb::SARCalib::radiometricCalibrationAntennaPatternNewGainPolynomialDegree, otb::SARCalib::radiometricCalibrationAntennaPatternOldGain, otb::SARCalib::radiometricCalibrationAntennaPatternOldGainPolynomialDegree, otb::SARCalib::radiometricCalibrationIncidenceAngle, otb::SARCalib::radiometricCalibrationIncidenceAnglePolynomialDegree, otb::SARCalib::radiometricCalibrationNoise, otb::SARCalib::radiometricCalibrationNoisePolynomialDegree, otb::SARCalib::radiometricCalibrationRangeSpreadLoss, otb::SARCalib::radiometricCalibrationRangeSpreadLossPolynomialDegree, otb::SARCalib::rescalingFactor, and otb::SARCalib.

CreateAnother()

template<class TInputImage , class TOutputImage >

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

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage >

void otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation

overrideprotected

Generate output information

Definition at line 42 of file otbSarRadiometricCalibrationToImageFilter.hxx.

GetLookupSelected()

template<class TInputImage , class TOutputImage >

virtual short otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::GetLookupSelected ( ) const

virtual

GetNameOfClass()

template<class TInputImage , class TOutputImage >

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

virtual

Run-time type information (and related methods).

New()

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TOutputImage >

void otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

privatedelete

SetEnableNoise()

template<class TInputImage , class TOutputImage >

void otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::SetEnableNoise ( bool  inArg )

inline

Enable/disable the noise flag in SarRadiometricCalibrationFunction

Definition at line 98 of file otbSarRadiometricCalibrationToImageFilter.h.

SetLookupSelected()

template<class TInputImage , class TOutputImage >

virtual void otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::SetLookupSelected ( short  _arg )

virtual

Member Data Documentation

m_LookupSelected

template<class TInputImage , class TOutputImage >

short otb::SarRadiometricCalibrationToImageFilter< TInputImage, TOutputImage >::m_LookupSelected

private

Definition at line 126 of file otbSarRadiometricCalibrationToImageFilter.h.

---

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

• otbSarRadiometricCalibrationToImageFilter.h
• otbSarRadiometricCalibrationToImageFilter.hxx