OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep > Class Template Referenceabstract

#include <otbBCOInterpolateImageFunction.h>

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

Public Types

typedef vnl_vector< double > CoefContainerType
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef TCoordRep ContinuousIndexValueType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::InputPixelType InputPixelType
 
typedef Superclass::OutputType OutputType
 
typedef Superclass::PointType PointType
 
typedef Superclass::RealType RealType
 
typedef
BCOInterpolateImageFunctionBase 
Self
 
typedef
itk::InterpolateImageFunction
< TInputImage, TCoordRep > 
Superclass
 
- Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef NumericTraits
< typename
TImageType::PixelType >
::RealType 
RealType
 
typedef InterpolateImageFunction Self
 
typedef ImageFunction
< TImageType, typename
NumericTraits< typename
TImageType::PixelType >
::RealType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 NumericTraits
< TInputImage::PixelType >
::RealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, NumericTraits
< TInputImage::PixelType >
::RealType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef NumericTraits
< TInputImage::PixelType >
::RealType 
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

OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
 
virtual const char * GetNameOfClass () const
 
virtual void SetRadius (unsigned int radius)
 
virtual unsigned int GetRadius () const
 
virtual void SetAlpha (double alpha)
 
virtual double GetAlpha () const
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
virtual OutputType Evaluate (const PointType &point) const override
 
virtual OutputType EvaluateAtIndex (const IndexType &index) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 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 >, NumericTraits< TInputImage::PixelType >::RealType >
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 LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
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 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) override
 
virtual void UnRegister () const noexceptoverride
 
- 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 Attributes

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

Protected Member Functions

 BCOInterpolateImageFunctionBase ()
 
virtual CoefContainerType EvaluateCoef (const ContinuousIndexValueType &indexValue) const
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~BCOInterpolateImageFunctionBase () override
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
 InterpolateImageFunction ()
 
 ~InterpolateImageFunction ()
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 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 ()
 

Protected Attributes

double m_Alpha
 
unsigned int m_Radius
 
unsigned int m_WinSize
 
- Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 BCOInterpolateImageFunctionBase (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- 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 ()
 

Detailed Description

template<class TInputImage, class TCoordRep = double>
class otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >

Definition at line 56 of file otbBCOInterpolateImageFunction.h.

Member Typedef Documentation

template<class TInputImage, class TCoordRep = double>
typedef vnl_vector<double> otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::CoefContainerType

Coeficients container type.

Definition at line 94 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::ContinuousIndexType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 90 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef TCoordRep otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ContinuousIndexValueType

Definition at line 91 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::IndexType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 83 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::IndexValueType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::IndexValueType

Definition at line 84 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::InputImageType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 71 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::InputPixelType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::InputPixelType

InputPixelType typedef support.

Definition at line 74 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::OutputType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 65 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::PointType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 87 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef Superclass::RealType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 77 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef BCOInterpolateImageFunctionBase otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 61 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
typedef itk::InterpolateImageFunction<TInputImage, TCoordRep> otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::Superclass

Definition at line 62 of file otbBCOInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage, class TCoordRep = double>
otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::BCOInterpolateImageFunctionBase ( )
inlineprotected

Definition at line 117 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::~BCOInterpolateImageFunctionBase ( )
inlineoverrideprotected

Definition at line 118 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::BCOInterpolateImageFunctionBase ( const Self )
privatedelete

Member Function Documentation

template<class TInputImage, class TCoordRep = double>
OutputType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
overridepure virtual

Evaluate the function at a ContinuousIndex position

Returns the linearly interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

Implemented in otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep >
BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::CoefContainerType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::EvaluateCoef ( const ContinuousIndexValueType indexValue) const
protectedvirtual

Compute the BCO coefficients.

Definition at line 80 of file otbBCOInterpolateImageFunction.hxx.

template<class TInputImage , class TCoordRep >
double otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetAlpha ( void  ) const
virtual

Set/Get the optimisation coefficient (Common values are -0.5, -0.75 or -1.0)

Definition at line 71 of file otbBCOInterpolateImageFunction.hxx.

template<class TInputImage, class TCoordRep = double>
virtual const char* otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TCoordRep >
unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetRadius ( ) const
virtual

Set/Get the window radius

Definition at line 57 of file otbBCOInterpolateImageFunction.hxx.

template<class TInputImage, class TCoordRep = double>
void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::operator= ( const Self )
privatedelete
template<class TInputImage , class TCoordRep >
void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual
template<class TInputImage , class TCoordRep >
void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::SetAlpha ( double  alpha)
virtual

Set/Get the optimisation coefficient (Common values are -0.5, -0.75 or -1.0)

Definition at line 64 of file otbBCOInterpolateImageFunction.hxx.

template<class TInputImage , class TCoordRep >
void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::SetRadius ( unsigned int  radius)
virtual

Set/Get the window radius

Definition at line 42 of file otbBCOInterpolateImageFunction.hxx.

Member Data Documentation

template<class TInputImage, class TCoordRep = double>
const unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension
static

Dimension underlying input image.

Definition at line 80 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
double otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_Alpha
protected

Optimisation Coefficient

Definition at line 130 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_Radius
protected

Used radius for the BCO

Definition at line 124 of file otbBCOInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = double>
unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_WinSize
protected

Used winsize for the BCO

Definition at line 127 of file otbBCOInterpolateImageFunction.h.


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