OTB  10.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::DecimateImageFilter< TInputImage, TOutputImage > Class Template Reference
Group Core » Module OTBCommon

#include <otbDecimateImageFilter.h>

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

Public Types

using ConstPointer = itk::SmartPointer< const Self >
 
using Pointer = itk::SmartPointer< Self >
 
using Self = DecimateImageFilter
 
using Superclass = itk::ImageToImageFilter< TInputImage, TOutputImage >
 

Public Member Functions

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

Static Public Member Functions

static Pointer New ()
 
using InputImageType = TInputImage
 
using InputImageRegionType = typename InputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputPixelType = typename OutputImageType::PixelType
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
unsigned int m_DecimationFactor
 
virtual unsigned int GetDecimationFactor ()
 
virtual void SetDecimationFactor (unsigned int _arg)
 
 DecimateImageFilter ()
 
virtual ~DecimateImageFilter ()=default
 
void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion) override
 
void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion) override
 
void GenerateOutputInformation () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 DecimateImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

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

Performs a down sampling of an image.

This class performs a basic down sampling of an image. On the contrary to itk::ResampleImageFilter, it does not perform any interpolation.

See also
ResampleImageFilter
SubsampleImageRegionConstIterator

Definition at line 44 of file otbDecimateImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 51 of file otbDecimateImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Image typedef support.

Definition at line 66 of file otbDecimateImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image typedef support.

Definition at line 65 of file otbDecimateImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Image typedef support.

Definition at line 69 of file otbDecimateImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Image typedef support.

Definition at line 68 of file otbDecimateImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Image typedef support.

Definition at line 70 of file otbDecimateImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::Pointer = itk::SmartPointer<Self>

Definition at line 50 of file otbDecimateImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::Self = DecimateImageFilter

Standard class typedefs.

Definition at line 48 of file otbDecimateImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
using otb::DecimateImageFilter< TInputImage, TOutputImage >::Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 49 of file otbDecimateImageFilter.h.

Constructor & Destructor Documentation

◆ DecimateImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::DecimateImageFilter< TInputImage, TOutputImage >::DecimateImageFilter ( )
inlineprotected

Image typedef support.

Definition at line 78 of file otbDecimateImageFilter.h.

◆ ~DecimateImageFilter()

template<class TInputImage , class TOutputImage >
virtual otb::DecimateImageFilter< TInputImage, TOutputImage >::~DecimateImageFilter ( )
protectedvirtualdefault

Image typedef support.

◆ DecimateImageFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::DecimateImageFilter< TInputImage, TOutputImage >::DecimateImageFilter ( const Self &  )
privatedelete

Image typedef support.

Member Function Documentation

◆ CallCopyInputRegionToOutputRegion()

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

Image typedef support.

Definition at line 85 of file otbDecimateImageFilter.hxx.

◆ CallCopyOutputRegionToInputRegion()

template<class TInputImage , class TOutputImage >
void otb::DecimateImageFilter< TInputImage, TOutputImage >::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 64 of file otbDecimateImageFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::DecimateImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ DynamicThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::DecimateImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread)
overrideprotected

Allows multithreading

Definition at line 106 of file otbDecimateImageFilter.hxx.

References otb::SubsampledImageRegionConstIterator< TImage >::GoToBegin(), otb::SubsampledImageRegionConstIterator< TImage >::IsAtEnd(), and otb::SubsampledImageRegionConstIterator< TImage >::SetSubsampleFactor().

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::DecimateImageFilter< TInputImage, TOutputImage >::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 44 of file otbDecimateImageFilter.hxx.

References otbGenericMsgDebugMacro.

◆ GetDecimationFactor()

template<class TInputImage , class TOutputImage >
virtual unsigned int otb::DecimateImageFilter< TInputImage, TOutputImage >::GetDecimationFactor ( )
virtual

Set/Get the DecimateFactor

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::DecimateImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::DecimateImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )
privatedelete

Image typedef support.

◆ PrintSelf()

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

Image typedef support.

Definition at line 37 of file otbDecimateImageFilter.hxx.

◆ SetDecimationFactor()

template<class TInputImage , class TOutputImage >
virtual void otb::DecimateImageFilter< TInputImage, TOutputImage >::SetDecimationFactor ( unsigned int  _arg)
virtual

Image typedef support.

Member Data Documentation

◆ InputImageDimension

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

Extract dimension from input and output image.

Definition at line 60 of file otbDecimateImageFilter.h.

◆ m_DecimationFactor

template<class TInputImage , class TOutputImage >
unsigned int otb::DecimateImageFilter< TInputImage, TOutputImage >::m_DecimationFactor
private

Image typedef support.

Definition at line 106 of file otbDecimateImageFilter.h.

◆ OutputImageDimension

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

Image typedef support.

Definition at line 61 of file otbDecimateImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Thu Dec 11 2025 13:39:51 for OTB with   doxygen 1.9.1