Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType > Class Template Reference

This class is a composite filter resampling an input image by setting a transform. The filter computes a displacement grid using the transform set and used it to warp the input. More...

#include <otbStreamingResampleImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::LinearInterpolateImageFunction
< InputImageType,
TInterpolatorPrecisionType > 
DefaultInterpolatorType
 
typedef
itk::TransformToDisplacementFieldSource
< DisplacementFieldType,
double > 
DisplacementFieldGeneratorType
 
typedef otb::Image
< DisplacementType
DisplacementFieldType
 
typedef itk::Vector< double,
TOutputImage::ImageDimension > 
DisplacementType
 
typedef itk::ImageBase
< OutputImageType::ImageDimension > 
ImageBaseType
 
typedef
DisplacementFieldGeneratorType::IndexType 
IndexType
 
typedef TInputImage InputImageType
 
typedef InterpolatorType::Pointer InterpolatorPointerType
 
typedef
itk::InterpolateImageFunction
< InputImageType,
TInterpolatorPrecisionType > 
InterpolatorType
 
typedef
DisplacementFieldGeneratorType::OriginType 
OriginType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
DisplacementFieldGeneratorType::RegionType 
RegionType
 
typedef
StreamingResampleImageFilter 
Self
 
typedef
DisplacementFieldGeneratorType::SizeType 
SizeType
 
typedef
DisplacementFieldGeneratorType::SpacingType 
SpacingType
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
typedef
DisplacementFieldGeneratorType::TransformType 
TransformType
 
typedef
StreamingWarpImageFilter
< InputImageType,
OutputImageType,
DisplacementFieldType
WarpImageFilterType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const SpacingTypeGetDisplacementFieldSpacing () const
 
virtual OutputImageType::PixelType GetEdgePaddingValue ()
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual const char * GetNameOfClass () const
 
virtual const OriginTypeGetOutputOrigin () const
 
virtual const SizeTypeGetOutputSize () const
 
virtual const SpacingTypeGetOutputSpacing () const
 
virtual const IndexTypeGetOutputStartIndex () const
 
virtual const TransformTypeGetTransform () const
 
void SetDisplacementFieldSpacing (const SpacingType &spacing)
 
void SetDisplacementFilterNumberOfThreads (unsigned int nbThread)
 
virtual void SetEdgePaddingValue (const typename OutputImageType::PixelType _arg)
 
void SetInterpolator (InterpolatorType *interpolator)
 
void SetOutputOrigin (const OriginType &origin)
 
void SetOutputParametersFromImage (const ImageBaseType *image)
 
virtual void SetOutputSize (const SizeType _arg)
 
virtual void SetOutputSpacing (const SpacingType _arg)
 
virtual void SetOutputStartIndex (const IndexType _arg)
 
void SetTransform (TransformType *transform)
 

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

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

Private Attributes

DisplacementFieldGeneratorType::Pointer m_DisplacementFilter
 
WarpImageFilterType::Pointer m_WarpFilter
 

Detailed Description

template<class TInputImage, class TOutputImage, class TInterpolatorPrecisionType = double>
class otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >

This class is a composite filter resampling an input image by setting a transform. The filter computes a displacement grid using the transform set and used it to warp the input.

The otb::StreamingResampleImageFilter allows to resample a otb::VectorImage using a transformation set with SetTransform() method. First, a displacement grid, with a spacing m_DisplacementGridSpacing and a size relative to this spacing, is built. Then, the image is wraped using this displacement grid. The size (SetOuputSize()), the spacing (SetOuputSpacing()), the start index (SetOutputIndex()) and the interpolator (SetInterpolator()) and the origin (SetOrigin()) can be set using the method between brackets.

Definition at line 56 of file otbStreamingResampleImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::SmartPointer<const Self> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ConstPointer

Definition at line 64 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::DefaultInterpolatorType

Definition at line 101 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::TransformToDisplacementFieldSource<DisplacementFieldType, double> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::DisplacementFieldGeneratorType

Internal filters typedefs

Definition at line 88 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef otb::Image<DisplacementType> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::DisplacementFieldType

Definition at line 79 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::Vector<double, TOutputImage::ImageDimension> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::DisplacementType

Displacement field used to warp the image

Definition at line 78 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::ImageBase<OutputImageType::ImageDimension> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::ImageBaseType

ImageBase typedef

Definition at line 104 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::IndexType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::IndexType

Definition at line 93 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef TInputImage otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InputImageType

Typedef parameters

Definition at line 70 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef InterpolatorType::Pointer otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InterpolatorPointerType

Definition at line 99 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::InterpolateImageFunction<InputImageType, TInterpolatorPrecisionType> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::InterpolatorType

Interpolator type

Definition at line 98 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::OriginType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::OriginType

Definition at line 92 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef TOutputImage otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::OutputImageType

Definition at line 74 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::SmartPointer<Self> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::Pointer

Definition at line 63 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::RegionType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::RegionType

Definition at line 94 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef StreamingResampleImageFilter otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::Self

Standard class typedefs.

Definition at line 61 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::SizeType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SizeType

Definition at line 90 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::SpacingType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SpacingType

Definition at line 91 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::Superclass

Definition at line 62 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef DisplacementFieldGeneratorType::TransformType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::TransformType

Definition at line 89 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
typedef StreamingWarpImageFilter<InputImageType, OutputImageType, DisplacementFieldType> otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::WarpImageFilterType

filter warping input image using displacement field

Definition at line 84 of file otbStreamingResampleImageFilter.h.

Constructor & Destructor Documentation

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

Definition at line 28 of file otbStreamingResampleImageFilter.txx.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::~StreamingResampleImageFilter ( )
inlineprotectedvirtual

Destructor

Definition at line 177 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::StreamingResampleImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual::itk::LightObject::Pointer otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType >
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateData ( void  )
protectedvirtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType >
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateInputRequestedRegion ( void  )
protectedvirtual

Definition at line 89 of file otbStreamingResampleImageFilter.txx.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType >
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GenerateOutputInformation ( void  )
protectedvirtual

Definition at line 63 of file otbStreamingResampleImageFilter.txx.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
const SpacingType& otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetDisplacementFieldSpacing ( ) const
inline

Definition at line 121 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual OutputImageType::PixelType otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetEdgePaddingValue ( )
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const InterpolatorType* otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetInterpolator ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const char* otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const OriginType& otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputOrigin ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const SizeType& otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputSize ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const SpacingType& otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputSpacing ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const IndexType& otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetOutputStartIndex ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual const TransformType* otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetTransform ( ) const
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
static Pointer otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::New ( )
static

Method for creation through the object factory.

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

Definition at line 146 of file otbStreamingResampleImageFilter.txx.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetDisplacementFieldSpacing ( const SpacingType spacing)
inline

The Displacement field spacing & size

Definition at line 116 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetDisplacementFilterNumberOfThreads ( unsigned int  nbThread)
inline

Definition at line 168 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetEdgePaddingValue ( const typename OutputImageType::PixelType  _arg)
virtual

Default Edgepadding value

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetInterpolator ( InterpolatorType interpolator)
inline

Methods to Set/Get the interpolator

Definition at line 149 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputOrigin ( const OriginType origin)
inline

The resampled image parameters

Definition at line 128 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType >
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputParametersFromImage ( const ImageBaseType image)

Import output parameters from a given image

Method used to copy the parameters of the input image

Definition at line 134 of file otbStreamingResampleImageFilter.txx.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputSize ( const SizeType  _arg)
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputSpacing ( const SpacingType  _arg)
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
virtual void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetOutputStartIndex ( const IndexType  _arg)
virtual
template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
void otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::SetTransform ( TransformType transform)
inline

Accessors to internal filters parameters

Definition at line 108 of file otbStreamingResampleImageFilter.h.

Member Data Documentation

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
DisplacementFieldGeneratorType::Pointer otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_DisplacementFilter
private

Definition at line 191 of file otbStreamingResampleImageFilter.h.

template<class TInputImage , class TOutputImage , class TInterpolatorPrecisionType = double>
WarpImageFilterType::Pointer otb::StreamingResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::m_WarpFilter
private

Definition at line 192 of file otbStreamingResampleImageFilter.h.


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