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 | List of all members
otb::BCOInterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference

Interpolate an image at specified positions using bicubic interpolation. More...

#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< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RealType RealType
 
typedef BCOInterpolateImageFunction Self
 
typedef
BCOInterpolateImageFunctionBase
< TInputImage, TCoordRep > 
Superclass
 
- Public Types inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >
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::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 NumericTraits
< TInputImage::PixelType >
::RealType 
OutputType
 
typedef NumericTraits
< TInputImage::PixelType >
::RealType 
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) >
, NumericTraits
< TInputImage::PixelType >
::RealType > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >
virtual double GetAlpha () const
 
virtual unsigned int GetRadius () const
 
virtual void SetAlpha (double alpha)
 
virtual void SetRadius (unsigned int radius)
 
- 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 NumericTraits
< TInputImage::PixelType >
::RealType 
Evaluate (const PointType &point) const =0
 
virtual OutputType Evaluate (const InputType &input) const =0
 
virtual NumericTraits
< TInputImage::PixelType >
::RealType 
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 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 >, NumericTraits< TInputImage::PixelType >::RealType >
virtual OutputType Evaluate (const InputType &input) const =0
 

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

Protected Member Functions

 BCOInterpolateImageFunction ()
 
virtual ~BCOInterpolateImageFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >
 BCOInterpolateImageFunctionBase ()
 
virtual ~BCOInterpolateImageFunctionBase ()
 
virtual CoefContainerType EvaluateCoef (const ContinuousIndexValueType &indexValue) const
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
 ~FunctionBase ()
 
 ~ImageFunction ()
 
 FunctionBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 

Private Member Functions

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

Additional Inherited Members

- 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
 

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 128 of file otbBCOInterpolateImageFunction.h.

Member Typedef Documentation

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

Definition at line 150 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 136 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 149 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 146 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 147 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 143 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 144 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 142 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 135 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 148 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 145 of file otbBCOInterpolateImageFunction.h.

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

Standard class typedefs.

Definition at line 133 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 134 of file otbBCOInterpolateImageFunction.h.

Constructor & Destructor Documentation

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

Definition at line 155 of file otbBCOInterpolateImageFunction.h.

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

Definition at line 156 of file otbBCOInterpolateImageFunction.h.

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

Member Function Documentation

template<class TInputImage, class TCoordRep = double>
virtual::itk::LightObject::Pointer otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const
template<class TInputImage , class TCoordRep >
BCOInterpolateImageFunction< TInputImage, TCoordRep >::OutputType otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
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 otb::BCOInterpolateImageFunctionBase< TInputImage, TCoordRep >.

Definition at line 129 of file otbBCOInterpolateImageFunction.txx.

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, TCoordRep >.

template<class TInputImage, class TCoordRep = double>
static Pointer otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::New ( )
static
template<class TInputImage, class TCoordRep = double>
void otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
private
template<class TInputImage , class TCoordRep >
void otb::BCOInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 120 of file otbBCOInterpolateImageFunction.txx.

Member Data Documentation

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

Definition at line 140 of file otbBCOInterpolateImageFunction.h.


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