OTB  5.0.0
Orfeo Toolbox
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

#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 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 itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual RealType Evaluate (const PointType &point) const
 
virtual RealType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const
 
void EvaluateParametricCoefficient ()
 
virtual const bool & GetIsInitialize () const
 
virtual const char * GetNameOfClass () const
 
void SetConstantValue (const RealType &value)
 
void SetPolynomalSize (const IndexType PolynomalSize)
 
virtual RealType EvaluateAtIndex (const IndexType &index) const
 
 itkGetObjectMacro (PointSet, PointSetType)
 
virtual const PointSetTypeGetPointSet () const
 
void SetPointSet (PointSetPointer val)
 
virtual void SetCoeff (MatrixType _arg)
 
virtual MatrixType GetCoeff ()
 
virtual MatrixType GetCoeff () const
 
- 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 itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual itk::NumericTraits
< TInputImage::PixelType >
::ScalarRealType 
EvaluateAtIndex (const IndexType &index) 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 PointType &point) const
 
virtual bool IsInsideBuffer (const IndexType &index) 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
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
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

virtual ~SarParametricMapFunction ()
 
 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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::ScalarRealType >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

MatrixType m_Coeff
 
bool m_IsInitialize
 
PointSetPointer m_PointSet
 
double m_ProductHeight
 
double m_ProductWidth
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- 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
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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 39 of file otbSarParametricMapFunction.txx.

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

Definition at line 130 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
virtual

Reimplemented from itk::Object.

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

Definition at line 91 of file otbSarParametricMapFunction.h.

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

Evalulate the function at specified index

Definition at line 82 of file otbSarParametricMapFunction.h.

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

Get/Set the Coeff pointer

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

Get/Set the Coeff pointer

template<class TInputImage, class TCoordRep = float>
virtual const bool& otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetIsInitialize ( ) const
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 const PointSetType* otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetPointSet ( ) const
virtual

Get/Set the PointSet pointer

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>
otb::SarParametricMapFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( PointSet  ,
PointSetType   
)

Get/Set the PointSet pointer

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
protectedvirtual

Reimplemented from itk::Object.

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

Get/Set the PointSet pointer

Definition at line 102 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 140 of file otbSarParametricMapFunction.h.

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

Definition at line 141 of file otbSarParametricMapFunction.h.

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

Definition at line 139 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 143 of file otbSarParametricMapFunction.h.

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

Definition at line 142 of file otbSarParametricMapFunction.h.


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