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 | Protected Attributes | Private Member Functions | List of all members
otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage > Class Template Reference

This class is an evolution of the itk::BSplineDecompositionImageFilter to handle huge images with this interpolator. For more documentation, please refer to the original class. More...

#include <otbBSplineDecompositionImageFilter.h>

+ Inheritance diagram for otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::InputImageConstPointer 
InputImageConstPointer
 
typedef
Superclass::InputImagePointer 
InputImagePointer
 
typedef Superclass::InputImageType InputImageType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
itk::ImageLinearIteratorWithIndex
< TOutputImage > 
OutputLinearIterator
 
typedef itk::SmartPointer< SelfPointer
 
typedef
BSplineDecompositionImageFilter 
Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual int GetSplineOrder ()
 
void SetSplineOrder (unsigned int SplineOrder)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

 BSplineDecompositionImageFilter ()
 
virtual ~BSplineDecompositionImageFilter ()
 
void GenerateData ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Protected Attributes

TInputImage::SizeType m_DataLength
 
unsigned int m_IteratorDirection
 
int m_NumberOfPoles
 
std::vector< double > m_Scratch
 
unsigned int m_SplineOrder
 
double m_SplinePoles [3]
 
double m_Tolerance
 

Private Member Functions

 BSplineDecompositionImageFilter (const Self &)
 
void CopyCoefficientsToScratch (OutputLinearIterator &)
 
void CopyImageToImage ()
 
void CopyScratchToCoefficients (OutputLinearIterator &)
 
virtual bool DataToCoefficients1D ()
 
void DataToCoefficientsND ()
 
void operator= (const Self &)
 
virtual void SetInitialAntiCausalCoefficient (double z)
 
virtual void SetInitialCausalCoefficient (double z)
 
virtual void SetPoles ()
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >

This class is an evolution of the itk::BSplineDecompositionImageFilter to handle huge images with this interpolator. For more documentation, please refer to the original class.

See Also
itk::BSplineDecompositionImageFilter

Definition at line 38 of file otbBSplineDecompositionImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 46 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::InputImageConstPointer otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Definition at line 57 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::InputImagePointer otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 56 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::InputImageType otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::InputImageType

Inherit input and output image types from Superclass.

Definition at line 52 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::OutputImagePointer otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 58 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::ImageLinearIteratorWithIndex<TOutputImage> otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::OutputLinearIterator

Iterator typedef support

Definition at line 66 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 45 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef BSplineDecompositionImageFilter otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 43 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 44 of file otbBSplineDecompositionImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::BSplineDecompositionImageFilter ( )
protected

Constructor

Definition at line 34 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::~BSplineDecompositionImageFilter ( )
inlineprotectedvirtual

Definition at line 75 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::BSplineDecompositionImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::CopyCoefficientsToScratch ( OutputLinearIterator Iter)
private

Copies a vector of data from the Coefficients image to the m_Scratch vector.

Copy one line of the output image to the scratch

Definition at line 326 of file otbBSplineDecompositionImageFilter.txx.

References itk::ImageConstIteratorWithIndex< TImage >::Get(), and itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtEndOfLine().

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::CopyImageToImage ( )
private

Used to initialize the Coefficients image before calculation.

Copy the input image into the output image

Definition at line 279 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::CopyScratchToCoefficients ( OutputLinearIterator Iter)
private

Copies a vector of data from m_Scratch to the Coefficients image.

Copy the scratch to one line of the output image

Definition at line 307 of file otbBSplineDecompositionImageFilter.txx.

References itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtEndOfLine(), and itk::ImageLinearIteratorWithIndex< TImage >::Set().

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage >
bool otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::DataToCoefficients1D ( )
privatevirtual

Converts a vector of data to a vector of Spline coefficients.

Definition at line 61 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::DataToCoefficientsND ( )
private

Converts an N-dimension image of data to an equivalent sized image of spline coefficients.

Definition at line 233 of file otbBSplineDecompositionImageFilter.txx.

References itk::ProgressReporter::CompletedPixel(), itk::Size< VDimension >::GetSize(), and itk::ImageLinearConstIteratorWithIndex< TImage >::SetDirection().

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::GenerateData ( void  )
protected

Generate data

Definition at line 343 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
virtual const char* otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::GetSplineOrder ( )
virtual
template<class TInputImage , class TOutputImage >
static Pointer otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::New ( )
static

New macro for creation of through a Smart Pointer

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Standard "PrintSelf" method

Definition at line 49 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::SetInitialAntiCausalCoefficient ( double  z)
privatevirtual

Determines the first coefficient for the anti-causal filtering of the data.

Definition at line 220 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::SetInitialCausalCoefficient ( double  z)
privatevirtual

Determines the first coefficient for the causal filtering of the data.

Definition at line 174 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::SetPoles ( )
privatevirtual

Determines the poles given the Spline Order.

Definition at line 128 of file otbBSplineDecompositionImageFilter.txx.

template<class TInputImage , class TOutputImage >
void otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::SetSplineOrder ( unsigned int  SplineOrder)

Get/Sets the Spline Order, supports 0th - 5th order splines. The default is a 3rd order spline.

Definition at line 113 of file otbBSplineDecompositionImageFilter.txx.

Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
static

Dimension underlying input image.

Definition at line 61 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
TInputImage::SizeType otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_DataLength
protected

Definition at line 82 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_IteratorDirection
protected

Definition at line 87 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_NumberOfPoles
protected

Definition at line 85 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
std::vector<double> otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_Scratch
protected

These are needed by the smoothing spline routine.

Definition at line 81 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_SplineOrder
protected

Definition at line 83 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
double otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_SplinePoles[3]
protected

Definition at line 84 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
double otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::m_Tolerance
protected

Definition at line 86 of file otbBSplineDecompositionImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int otb::BSplineDecompositionImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

Definition at line 63 of file otbBSplineDecompositionImageFilter.h.


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