otb::DecimateImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbDecimateImageFilter.h>

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

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

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef DecimateImageFilter	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 TInputImage	InputImageType
typedef InputImageType::RegionType	InputImageRegionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputPixelType
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 ()
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	GenerateOutputInformation ()
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const
	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 >

typedef itk::SmartPointer<const Self> otb::DecimateImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 51 of file otbDecimateImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType otb::DecimateImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Image typedef support.

Definition at line 66 of file otbDecimateImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::DecimateImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support.

Definition at line 65 of file otbDecimateImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Image typedef support.

Definition at line 69 of file otbDecimateImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputImageType

Image typedef support.

Definition at line 68 of file otbDecimateImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType otb::DecimateImageFilter< TInputImage, TOutputImage >::OutputPixelType

Image typedef support.

Definition at line 70 of file otbDecimateImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage >

typedef itk::SmartPointer<Self> otb::DecimateImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 50 of file otbDecimateImageFilter.h.

Self

template<class TInputImage , class TOutputImage >

typedef DecimateImageFilter otb::DecimateImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 48 of file otbDecimateImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage >

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::DecimateImageFilter< TInputImage, TOutputImage >::Superclass

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 ( )

inlineprotectedvirtual

Image typedef support.

Definition at line 82 of file otbDecimateImageFilter.h.

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  )

protectedvirtual

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  )

protectedvirtual

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

GenerateOutputInformation()

template<class TInputImage , class TOutputImage >

void otb::DecimateImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation

protectedvirtual

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

protectedvirtual

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.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::DecimateImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

protectedvirtual

Allows multithreading

Definition at line 106 of file otbDecimateImageFilter.hxx.

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

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 107 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:

• otbDecimateImageFilter.h
• otbDecimateImageFilter.hxx