OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation > Class Template Reference
Group FeaturesExtraction » Module OTBWavelet

#include <otbSubsampleImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::SmartPointer< Self > Pointer
 
typedef SubsampleImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
typedef Wavelet::WaveletDirection DirectionOfTransformationEnumType
 
typedef TInputImage InputImageType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageIndexType::IndexValueType InputImageIndexValueType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::SizeType OutputImageSizeType
 
typedef OutputImageType::IndexType OutputImageIndexType
 
typedef OutputImageType::PixelType OutputPixelType
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
static const DirectionOfTransformationEnumType DirectionOfTransformation = TDirectionOfTransformation
 
InputImageIndexType m_SubsampleFactor
 
virtual const InputImageIndexType & GetSubsampleFactor ()
 
virtual void SetSubsampleFactor (InputImageIndexType &_arg)
 
void SetSubSampleFactor (InputImageIndexValueType factor)
 
 SubsampleImageFilter ()
 
 ~SubsampleImageFilter () override
 
bool IsSubsampleFactorOne () const
 
void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion) override
 
void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion) override
 
void GenerateOutputInformation () override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SubsampleImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage, Wavelet::WaveletDirection TDirectionOfTransformation>
class otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >

Performs a down sampling of an image.

This class performs a simple resampling image filtering.

The third template is a Wavelet::FORWARD/Wavelet::INVERSE Wavelet::WaveletDirection enumeration type. With Wavelet::FORWARD, the output image is of the same size of the one of the input image. But the output image contains only co-located subsample, the rest being 0. When Wavelet::INVERSE is used, the input image is considered as the sub-sampled. Then, the output image is larger. Initial pixel values are preserved but the output image is interleaved with 0.

See also
ResampleImageFilter
SubsampleImageRegionConstIterator
DecimateImageFilter

Definition at line 54 of file otbSubsampleImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef itk::SmartPointer<const Self> otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::ConstPointer

Definition at line 61 of file otbSubsampleImageFilter.h.

◆ DirectionOfTransformationEnumType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef Wavelet::WaveletDirection otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::DirectionOfTransformationEnumType

Direction definition

Definition at line 75 of file otbSubsampleImageFilter.h.

◆ InputImageIndexType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef InputImageType::IndexType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::InputImageIndexType

Direction definition

Definition at line 81 of file otbSubsampleImageFilter.h.

◆ InputImageIndexValueType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef InputImageIndexType::IndexValueType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::InputImageIndexValueType

Direction definition

Definition at line 82 of file otbSubsampleImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef InputImageType::RegionType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::InputImageRegionType

Direction definition

Definition at line 80 of file otbSubsampleImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef TInputImage otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::InputImageType

Image typedef support.

Definition at line 79 of file otbSubsampleImageFilter.h.

◆ OutputImageIndexType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef OutputImageType::IndexType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImageIndexType

Direction definition

Definition at line 88 of file otbSubsampleImageFilter.h.

◆ OutputImagePointerType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef OutputImageType::Pointer otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImagePointerType

Direction definition

Definition at line 85 of file otbSubsampleImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef OutputImageType::RegionType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImageRegionType

Direction definition

Definition at line 86 of file otbSubsampleImageFilter.h.

◆ OutputImageSizeType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef OutputImageType::SizeType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImageSizeType

Direction definition

Definition at line 87 of file otbSubsampleImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef TOutputImage otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImageType

Direction definition

Definition at line 84 of file otbSubsampleImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef OutputImageType::PixelType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputPixelType

Direction definition

Definition at line 89 of file otbSubsampleImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef itk::SmartPointer<Self> otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::Pointer

Definition at line 60 of file otbSubsampleImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef SubsampleImageFilter otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::Self

Standard class typedefs.

Definition at line 58 of file otbSubsampleImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::Superclass

Definition at line 59 of file otbSubsampleImageFilter.h.

Constructor & Destructor Documentation

◆ SubsampleImageFilter() [1/2]

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::SubsampleImageFilter ( )
inlineprotected

Direction definition

Definition at line 103 of file otbSubsampleImageFilter.h.

◆ ~SubsampleImageFilter()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::~SubsampleImageFilter ( )
inlineoverrideprotected

Direction definition

Definition at line 107 of file otbSubsampleImageFilter.h.

◆ SubsampleImageFilter() [2/2]

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::SubsampleImageFilter ( const Self &  )
privatedelete

Direction definition

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::BeforeThreadedGenerateData
overrideprotected

Set output image to 0 before processing

Definition at line 124 of file otbSubsampleImageFilter.hxx.

◆ CallCopyInputRegionToOutputRegion()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::CallCopyInputRegionToOutputRegion ( OutputImageRegionType &  destRegion,
const InputImageRegionType &  srcRegion 
)
overrideprotected

Direction definition

Definition at line 99 of file otbSubsampleImageFilter.hxx.

References otb::Wavelet::INVERSE.

◆ CallCopyOutputRegionToInputRegion()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::CallCopyOutputRegionToInputRegion ( InputImageRegionType &  destRegion,
const OutputImageRegionType &  srcRegion 
)
overrideprotected

Since input and output image are very likely to be of different size. Region estimation functions has to be reimplemented

Definition at line 73 of file otbSubsampleImageFilter.hxx.

References otb::Wavelet::INVERSE.

◆ CreateAnother()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
virtual::itk::LightObject::Pointer otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::CreateAnother ( void  ) const

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::GenerateOutputInformation
overrideprotected

Output image region size is not of the same dimension as the input. That is why GenerateOutputInformation has to be redefined.

Definition at line 60 of file otbSubsampleImageFilter.hxx.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
virtual const char* otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetSubsampleFactor()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
virtual const InputImageIndexType& otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::GetSubsampleFactor ( )
virtual

Set/Get the SubsampleFactor

◆ IsSubsampleFactorOne()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
bool otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::IsSubsampleFactorOne
protected

Internal test function to check if there is any direction to subsample

Definition at line 48 of file otbSubsampleImageFilter.hxx.

◆ New()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
static Pointer otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::operator= ( const Self &  )
privatedelete

Direction definition

◆ PrintSelf()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Direction definition

Definition at line 36 of file otbSubsampleImageFilter.hxx.

◆ SetSubsampleFactor()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
virtual void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::SetSubsampleFactor ( InputImageIndexType &  _arg)
virtual

Direction definition

◆ SetSubSampleFactor()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::SetSubSampleFactor ( InputImageIndexValueType  factor)
inline

Direction definition

Definition at line 94 of file otbSubsampleImageFilter.h.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
void otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Allows multithreading

Definition at line 131 of file otbSubsampleImageFilter.hxx.

References otb::Wavelet::FORWARD, otb::SubsampledImageRegionConstIterator< TImage >::GetIndex(), otb::SubsampledImageRegionConstIterator< TImage >::GetOffset(), otb::SubsampledImageRegionConstIterator< TImage >::GoToBegin(), otb::SubsampledImageRegionConstIterator< TImage >::IsAtEnd(), otb::SubsampledImageRegionIterator< TImage >::Set(), otb::SubsampledImageRegionConstIterator< TImage >::SetIndex(), otb::SubsampledImageRegionConstIterator< TImage >::SetOffset(), and otb::SubsampledImageRegionConstIterator< TImage >::SetSubsampleFactor().

Member Data Documentation

◆ DirectionOfTransformation

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
const DirectionOfTransformationEnumType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::DirectionOfTransformation = TDirectionOfTransformation
static

Direction definition

Definition at line 76 of file otbSubsampleImageFilter.h.

◆ InputImageDimension

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
const unsigned int otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::InputImageDimension = TInputImage::ImageDimension
static

Extract dimension from input and output image.

Definition at line 70 of file otbSubsampleImageFilter.h.

◆ m_SubsampleFactor

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
InputImageIndexType otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::m_SubsampleFactor
private

Direction definition

Definition at line 138 of file otbSubsampleImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage , Wavelet::WaveletDirection TDirectionOfTransformation>
const unsigned int otb::SubsampleImageFilter< TInputImage, TOutputImage, TDirectionOfTransformation >::OutputImageDimension = TOutputImage::ImageDimension
static

Direction definition

Definition at line 71 of file otbSubsampleImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:32 for OTB with   doxygen 1.8.17