Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SarParametricMapFunction< TInputImage, TCoordRep > Class Template Reference

Evaluates a parametric bidimensionnal polynomial model from a PointSet. More...

#include <otbSarParametricMapFunction.h>

+ Inheritance diagram for otb::SarParametricMapFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for otb::SarParametricMapFunction< TInputImage, TCoordRep >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef
itk::VariableSizeMatrix
< double > 
MatrixType
 
typedef Superclass::OutputType OutputType
 
typedef PointSetType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PointSetType::ConstPointer PointSetConstPointer
 
typedef PointSetType::Pointer PointSetPointer
 
typedef itk::PointSet
< OutputType, ImageDimension
PointSetType
 
typedef PointSetType::PointType PointType
 
typedef itk::NumericTraits
< InputPixelType >
::ScalarRealType 
RealType
 
typedef SarParametricMapFunction Self
 
typedef itk::ImageFunction
< TInputImage, typename
itk::NumericTraits< typename
TInputImage::PixelType >
::ScalarRealType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
OutputType
 
typedef itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef FunctionBase Self
 
typedef ImageFunction Self
 
typedef Object Superclass
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual RealType Evaluate (const PointType &point) const
 
virtual RealType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const
 
virtual RealType EvaluateAtIndex (const IndexType &index) const
 
void EvaluateParametricCoefficient ()
 
virtual MatrixType GetCoeff ()
 
virtual MatrixType GetCoeff () const
 
virtual const bool & GetIsInitialize ()
 
virtual const char * GetNameOfClass () const
 
virtual PointSetTypeGetPointSet ()
 
virtual const PointSetTypeGetPointSet ()
 
virtual void SetCoeff (MatrixType _arg)
 
void SetConstantValue (const RealType &value)
 
void SetPointSet (PointSetPointer val)
 
void SetPolynomalSize (const IndexType PolynomalSize)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
Evaluate (const PointType &point) const =0
 
virtual OutputType Evaluate (const InputType &input) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual void SetInputImage (const InputImageType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType >
virtual OutputType Evaluate (const InputType &input) const =0
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

 SarParametricMapFunction ()
 
virtual ~SarParametricMapFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >
 ImageFunction ()
 
 ~FunctionBase ()
 
 ~ImageFunction ()
 
 FunctionBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 

Private Member Functions

 SarParametricMapFunction (const Self &)
 
double Horner (PointType point) const
 
void operator= (const Self &)
 

Private Attributes

MatrixType m_Coeff
 
bool m_IsInitialize
 
PointSetPointer m_PointSet
 
double m_ProductHeight
 the width of the complete product (read from metadata) More...
 
double m_ProductWidth
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 

Detailed Description

template<class TInputImage, class TCoordRep = float>
class otb::SarParametricMapFunction< TInputImage, TCoordRep >

Evaluates a parametric bidimensionnal polynomial model from a PointSet.

Note
This is an internal class used by the Sar calibration framework.

Definition at line 40 of file otbSarParametricMapFunction.h.

Member Typedef Documentation

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<const Self> otb::SarParametricMapFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 50 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::ContinuousIndexType otb::SarParametricMapFunction< TInputImage, TCoordRep >::ContinuousIndexType

Definition at line 63 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::IndexType otb::SarParametricMapFunction< TInputImage, TCoordRep >::IndexType

Definition at line 62 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef TInputImage otb::SarParametricMapFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 56 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef InputImageType::PixelType otb::SarParametricMapFunction< TInputImage, TCoordRep >::InputPixelType

Definition at line 60 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::VariableSizeMatrix<double> otb::SarParametricMapFunction< TInputImage, TCoordRep >::MatrixType

Definition at line 73 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef Superclass::OutputType otb::SarParametricMapFunction< TInputImage, TCoordRep >::OutputType

Definition at line 61 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef PointSetType::PixelType otb::SarParametricMapFunction< TInputImage, TCoordRep >::PixelType

Definition at line 71 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<Self> otb::SarParametricMapFunction< TInputImage, TCoordRep >::Pointer

Definition at line 49 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef PointSetType::ConstPointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetConstPointer

Definition at line 69 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef PointSetType::Pointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetPointer

Definition at line 68 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::PointSet<OutputType, ImageDimension> otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetType

Definition at line 67 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef PointSetType::PointType otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointType

Definition at line 70 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::NumericTraits<InputPixelType>::ScalarRealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::RealType

Datatype used for the evaluation

Definition at line 76 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef SarParametricMapFunction otb::SarParametricMapFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 46 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::ScalarRealType, TCoordRep> otb::SarParametricMapFunction< TInputImage, TCoordRep >::Superclass

Definition at line 48 of file otbSarParametricMapFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep >
otb::SarParametricMapFunction< TInputImage, TCoordRep >::SarParametricMapFunction ( )
protected

Constructor

Definition at line 40 of file otbSarParametricMapFunction.txx.

template<class TInputImage, class TCoordRep = float>
virtual otb::SarParametricMapFunction< TInputImage, TCoordRep >::~SarParametricMapFunction ( )
inlineprotectedvirtual

Definition at line 127 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
otb::SarParametricMapFunction< TInputImage, TCoordRep >::SarParametricMapFunction ( const Self )
private

Member Function Documentation

template<class TInputImage, class TCoordRep = float>
virtual::itk::LightObject::Pointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const
template<class TInputImage , class TCoordRep >
SarParametricMapFunction< TInputImage, TCoordRep >::RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
virtual

Evaluate the function at specific positions

Definition at line 199 of file otbSarParametricMapFunction.txx.

template<class TInputImage, class TCoordRep = float>
virtual RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlinevirtual
template<class TInputImage, class TCoordRep = float>
virtual RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
inlinevirtual
template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateParametricCoefficient ( )

Evaluate parametric coefficent from pointset

Definition at line 105 of file otbSarParametricMapFunction.txx.

References otb::ImageKeywordlist::GetMetadataByKey(), itk::MetaDataDictionary::HasKey(), and otb::MetaDataKey::OSSIMKeywordlistKey.

template<class TInputImage, class TCoordRep = float>
virtual MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetCoeff ( )
virtual
template<class TInputImage, class TCoordRep = float>
virtual MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetCoeff ( ) const
virtual
template<class TInputImage, class TCoordRep = float>
virtual const bool& otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetIsInitialize ( )
virtual

Get/Set the Coeff pointer

template<class TInputImage, class TCoordRep = float>
virtual const char* otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType, TCoordRep >.

template<class TInputImage, class TCoordRep = float>
virtual PointSetType* otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetPointSet ( )
virtual

Get/Set the PointSet pointer

template<class TInputImage, class TCoordRep = float>
virtual const PointSetType* otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetPointSet ( )
virtual
template<class TInputImage , class TCoordRep >
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::Horner ( PointType  point) const
private

Definition at line 81 of file otbSarParametricMapFunction.txx.

template<class TInputImage, class TCoordRep = float>
static Pointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<class TInputImage, class TCoordRep = float>
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::operator= ( const Self )
private
template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 225 of file otbSarParametricMapFunction.txx.

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetCoeff ( MatrixType  _arg)
virtual

Get/Set the Coeff pointer

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetConstantValue ( const RealType value)

Set constante value for evaluation

Definition at line 53 of file otbSarParametricMapFunction.txx.

template<class TInputImage, class TCoordRep = float>
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetPointSet ( PointSetPointer  val)
inline

Definition at line 101 of file otbSarParametricMapFunction.h.

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetPolynomalSize ( const IndexType  PolynomalSize)

Get/Set the PolynomalSize pointer

Definition at line 71 of file otbSarParametricMapFunction.txx.

Member Data Documentation

template<class TInputImage, class TCoordRep = float>
const unsigned int otb::SarParametricMapFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
static

Definition at line 65 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_Coeff
private

Definition at line 137 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
bool otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_IsInitialize
private

Definition at line 138 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
PointSetPointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_PointSet
private

Definition at line 136 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_ProductHeight
private

the width of the complete product (read from metadata)

Definition at line 140 of file otbSarParametricMapFunction.h.

template<class TInputImage, class TCoordRep = float>
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_ProductWidth
private

Definition at line 139 of file otbSarParametricMapFunction.h.


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