OTB  10.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
otb::BCOInterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference
Data Processing Objects » Functions » Image Functions | Data Processing Objects » Functions » Image Functions » Image Interpolators | Group Core » Module OTBInterpolation

#include <otbBCOInterpolateImageFunction.h>

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

Public Types

typedef Superclass::CoefContainerType CoefContainerType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::InputPixelType InputPixelType
 
typedef Superclass::OutputType OutputType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RealType RealType
 
typedef BCOInterpolateImageFunction Self
 
typedef BCOInterpolateImageFunctionBase< TInputImage, TCoordRep > Superclass
 
- Public Types inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, double >
typedef boost::container::small_vector< double, 7 > CoefContainerType
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef double 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 Superclass::SizeType SizeType
 
typedef itk::InterpolateImageFunction< TInputImage, double > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, double >
virtual void SetRadius (unsigned int radius)
 
virtual SizeType GetRadius () const
 
virtual void SetAlpha (double alpha)
 
virtual double GetAlpha () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, double >
static const unsigned int ImageDimension
 

Protected Member Functions

 BCOInterpolateImageFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~BCOInterpolateImageFunction () override
 
- Protected Member Functions inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, double >
 BCOInterpolateImageFunctionBase ()
 
 ~BCOInterpolateImageFunctionBase () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
CoefContainerType EvaluateCoef (const ContinuousIndexValueType &indexValue) const
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, double >
unsigned int m_Radius
 
unsigned int m_WinSize
 
double m_Alpha
 

Detailed Description

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

Interpolate an image at specified positions using bicubic interpolation.

BCOInterpolateImageFunction interpolates image intensity at a non-integer pixel position. This class is templated over the input image type and the coordinate representation type (e.g. float or double).

This function works for 2-dimensional images.

This function works with both Images and VectorImages.

Parameters are the interpolation window radius and the bicubic optimisation coefficient alpha. Alpha is usually set to -0.5, -0.75 or -1 (-0.5 by default). The case alpha = -0.5 (which corresponds to the cubic Hermite spline) is known to produce the best approximation of the original function.

Definition at line 141 of file otbBCOInterpolateImageFunction.h.

Member Typedef Documentation

◆ CoefContainerType

template<class TInputImage , class TCoordRep = double>
typedef Superclass::CoefContainerType otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::CoefContainerType

Definition at line 162 of file otbBCOInterpolateImageFunction.h.

◆ ConstPointer

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

Definition at line 148 of file otbBCOInterpolateImageFunction.h.

◆ ContinuousIndexType

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

Definition at line 161 of file otbBCOInterpolateImageFunction.h.

◆ IndexType

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

Definition at line 158 of file otbBCOInterpolateImageFunction.h.

◆ IndexValueType

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

Definition at line 159 of file otbBCOInterpolateImageFunction.h.

◆ InputImageType

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

Definition at line 155 of file otbBCOInterpolateImageFunction.h.

◆ InputPixelType

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

Definition at line 156 of file otbBCOInterpolateImageFunction.h.

◆ OutputType

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

Definition at line 154 of file otbBCOInterpolateImageFunction.h.

◆ Pointer

template<class TInputImage , class TCoordRep = double>
typedef itk::SmartPointer<Self> otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 147 of file otbBCOInterpolateImageFunction.h.

◆ PointType

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

Definition at line 160 of file otbBCOInterpolateImageFunction.h.

◆ RealType

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

Definition at line 157 of file otbBCOInterpolateImageFunction.h.

◆ Self

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

Standard class typedefs.

Definition at line 145 of file otbBCOInterpolateImageFunction.h.

◆ Superclass

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

Definition at line 146 of file otbBCOInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ BCOInterpolateImageFunction() [1/2]

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

Definition at line 167 of file otbBCOInterpolateImageFunction.h.

◆ ~BCOInterpolateImageFunction()

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

Definition at line 168 of file otbBCOInterpolateImageFunction.h.

◆ BCOInterpolateImageFunction() [2/2]

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

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TCoordRep = double>
virtual::itk::LightObject::Pointer otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const

◆ EvaluateAtContinuousIndex()

template<class TInputImage , class TCoordRep >
BCOInterpolateImageFunction< TInputImage, TCoordRep >::OutputType otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
overridevirtual

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 otb::BCOInterpolateImageFunctionBase< TInputImage, double >.

Definition at line 131 of file otbBCOInterpolateImageFunction.hxx.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from otb::BCOInterpolateImageFunctionBase< TInputImage, double >.

◆ New()

template<class TInputImage , class TCoordRep = double>
static Pointer otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::New ( )
static

◆ operator=()

template<class TInputImage , class TCoordRep = double>
void otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::operator= ( const Self &  )
privatedelete

◆ PrintSelf()

template<class TInputImage , class TCoordRep >
void otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 124 of file otbBCOInterpolateImageFunction.hxx.

Member Data Documentation

◆ ImageDimension

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

Definition at line 152 of file otbBCOInterpolateImageFunction.h.

The documentation for this class was generated from the following files:
Generated at Fri Mar 21 2025 16:06:49 for OTB with   doxygen 1.9.1