otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep > Class Template Reference

#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 Member Functions
virtual const char *	GetNameOfClass () const

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
unsigned int	m_Radius
unsigned int	m_WinSize
double	m_Alpha
virtual void	SetRadius (unsigned int radius)
virtual unsigned int	GetRadius () const
virtual void	SetAlpha (double alpha)
virtual double	GetAlpha () const
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
	BCOInterpolateImageFunctionBase ()
	~BCOInterpolateImageFunctionBase () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
CoefContainerType	EvaluateCoef (const ContinuousIndexValueType &indexValue) const
	BCOInterpolateImageFunctionBase (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

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

Definition at line 62 of file otbBCOInterpolateImageFunction.h.

Member Typedef Documentation

CoefContainerType

template<class TInputImage , class TCoordRep = double>

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

Coefficients container type.

Definition at line 105 of file otbBCOInterpolateImageFunction.h.

ContinuousIndexType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::ContinuousIndexType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 95 of file otbBCOInterpolateImageFunction.h.

ContinuousIndexValueType

template<class TInputImage , class TCoordRep = double>

typedef TCoordRep otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ContinuousIndexValueType

Definition at line 96 of file otbBCOInterpolateImageFunction.h.

IndexType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::IndexType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 88 of file otbBCOInterpolateImageFunction.h.

IndexValueType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::IndexValueType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::IndexValueType

Definition at line 89 of file otbBCOInterpolateImageFunction.h.

InputImageType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::InputImageType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 76 of file otbBCOInterpolateImageFunction.h.

InputPixelType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::InputPixelType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::InputPixelType

InputPixelType typedef support.

Definition at line 79 of file otbBCOInterpolateImageFunction.h.

OutputType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::OutputType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 70 of file otbBCOInterpolateImageFunction.h.

PointType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::PointType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 92 of file otbBCOInterpolateImageFunction.h.

RealType

template<class TInputImage , class TCoordRep = double>

typedef Superclass::RealType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 82 of file otbBCOInterpolateImageFunction.h.

Self

template<class TInputImage , class TCoordRep = double>

typedef BCOInterpolateImageFunctionBase otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 66 of file otbBCOInterpolateImageFunction.h.

Superclass

template<class TInputImage , class TCoordRep = double>

typedef itk::InterpolateImageFunction<TInputImage, TCoordRep> otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::Superclass

Definition at line 67 of file otbBCOInterpolateImageFunction.h.

Constructor & Destructor Documentation

BCOInterpolateImageFunctionBase() [1/2]

template<class TInputImage , class TCoordRep = double>

otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::BCOInterpolateImageFunctionBase ( )

inlineprotected

Used radius for the BCO

Definition at line 129 of file otbBCOInterpolateImageFunction.h.

~BCOInterpolateImageFunctionBase()

template<class TInputImage , class TCoordRep = double>

otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::~BCOInterpolateImageFunctionBase ( )

inlineoverrideprotected

Used radius for the BCO

Definition at line 130 of file otbBCOInterpolateImageFunction.h.

BCOInterpolateImageFunctionBase() [2/2]

template<class TInputImage , class TCoordRep = double>

otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::BCOInterpolateImageFunctionBase ( const Self &  )

privatedelete

Used radius for the BCO

Member Function Documentation

EvaluateAtContinuousIndex()

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.

Implemented in otb::BCOInterpolateImageFunction< otb::VectorImage< TPixel, VImageDimension >, TCoordRep >, and otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >.

EvaluateCoef()

template<class TInputImage , class TCoordRep >

BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::CoefContainerType otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::EvaluateCoef ( const ContinuousIndexValueType &  indexValue ) const

protected

Compute the BCO coefficients.

Definition at line 73 of file otbBCOInterpolateImageFunction.hxx.

GetAlpha()

template<class TInputImage , class TCoordRep >

double otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetAlpha

virtual

Used radius for the BCO

Definition at line 66 of file otbBCOInterpolateImageFunction.hxx.

GetNameOfClass()

template<class TInputImage , class TCoordRep = double>

virtual const char* otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetRadius()

template<class TInputImage , class TCoordRep >

unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::GetRadius

virtual

Used radius for the BCO

Definition at line 54 of file otbBCOInterpolateImageFunction.hxx.

operator=()

template<class TInputImage , class TCoordRep = double>

void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::operator= ( const Self &  )

privatedelete

Used radius for the BCO

PrintSelf()

template<class TInputImage , class TCoordRep >

void otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

Used radius for the BCO

Definition at line 32 of file otbBCOInterpolateImageFunction.hxx.

SetAlpha()

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 60 of file otbBCOInterpolateImageFunction.hxx.

SetRadius()

template<class TInputImage , class TCoordRep >

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

virtual

Set/Get the window radius

Definition at line 40 of file otbBCOInterpolateImageFunction.hxx.

Member Data Documentation

ImageDimension

template<class TInputImage , class TCoordRep = double>

const unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension

static

Dimension underlying input image.

Definition at line 85 of file otbBCOInterpolateImageFunction.h.

m_Alpha

template<class TInputImage , class TCoordRep = double>

double otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_Alpha

protected

Optimisation Coefficient

Definition at line 142 of file otbBCOInterpolateImageFunction.h.

m_Radius

template<class TInputImage , class TCoordRep = double>

unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_Radius

protected

Used radius for the BCO

Definition at line 136 of file otbBCOInterpolateImageFunction.h.

m_WinSize

template<class TInputImage , class TCoordRep = double>

unsigned int otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >::m_WinSize

protected

Used winsize for the BCO

Definition at line 139 of file otbBCOInterpolateImageFunction.h.

---

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

• otbBCOInterpolateImageFunction.h
• otbBCOInterpolateImageFunction.hxx