OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
otb::PersistentShrinkImageFilter< TInputImage, TOutputImage > Class Template Reference
Processing images region by region » Filters supporting StreamingSupport for Multithreading » | Multithreaded FiltersGroup Core » | Module OTBImageManipulation

#include <otbStreamingShrinkImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef TOutputImage::Pointer OutputImagePointer
 
typedef TOutputImage OutputImageType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentShrinkImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef PersistentImageFilter< TInputImage, TOutputImage > Superclass
 
- Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TInputImage InputImageType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef PersistentImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TInputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetShrinkFactor ()
 
OutputImageType * GetShrunkOutput ()
 
virtual void SetShrinkFactor (unsigned int _arg)
 
- Public Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Private Member Functions

void operator= (const Self &)=delete
 
 PersistentShrinkImageFilter (const Self &)=delete
 

Private Attributes

IndexType m_Offset
 
unsigned int m_ShrinkFactor
 
OutputImagePointer m_ShrunkOutput
 
void Synthetize (void) override
 
void Reset (void) override
 
 PersistentShrinkImageFilter ()
 
 ~PersistentShrinkImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void AfterThreadedGenerateData () override
 
void AllocateOutputs () override
 
void GenerateOutputInformation () override
 

Additional Inherited Members

- Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
 PersistentImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentImageFilter () override
 

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >

See also
PersistentImageFilter

Definition at line 170 of file otbStreamingShrinkImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 177 of file otbStreamingShrinkImageFilter.h.

◆ DataObjectPointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::DataObject::Pointer otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 200 of file otbStreamingShrinkImageFilter.h.

◆ IndexType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::IndexType otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 190 of file otbStreamingShrinkImageFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::Pointer otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::InputImagePointer

Definition at line 187 of file otbStreamingShrinkImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::InputImageType

Image related typedefs.

Definition at line 183 of file otbStreamingShrinkImageFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage::Pointer otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 195 of file otbStreamingShrinkImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::OutputImageType

Image related typedefs.

Definition at line 194 of file otbStreamingShrinkImageFilter.h.

◆ PixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::PixelType otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::PixelType

Definition at line 191 of file otbStreamingShrinkImageFilter.h.

◆ Pointer

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

Definition at line 176 of file otbStreamingShrinkImageFilter.h.

◆ RegionType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::RegionType otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 188 of file otbStreamingShrinkImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage = TInputImage>
typedef PersistentShrinkImageFilter otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::Self

Standard Self typedef

Definition at line 174 of file otbStreamingShrinkImageFilter.h.

◆ SizeType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::SizeType otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 189 of file otbStreamingShrinkImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage = TInputImage>
typedef PersistentImageFilter<TInputImage, TOutputImage> otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 175 of file otbStreamingShrinkImageFilter.h.

Constructor & Destructor Documentation

◆ PersistentShrinkImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::PersistentShrinkImageFilter
protected

Constructor

Definition at line 61 of file otbStreamingShrinkImageFilter.hxx.

◆ ~PersistentShrinkImageFilter()

template<class TInputImage , class TOutputImage >
otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::~PersistentShrinkImageFilter
overrideprotected

Destructor

Definition at line 70 of file otbStreamingShrinkImageFilter.hxx.

◆ PersistentShrinkImageFilter() [2/2]

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

Member Function Documentation

◆ AfterThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData
overrideprotected

Constructor

Definition at line 187 of file otbStreamingShrinkImageFilter.hxx.

◆ AllocateOutputs()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::AllocateOutputs
overrideprotected

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Definition at line 96 of file otbStreamingShrinkImageFilter.hxx.

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData
overrideprotected

Constructor

Definition at line 159 of file otbStreamingShrinkImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation
overrideprotected

Constructor

Definition at line 75 of file otbStreamingShrinkImageFilter.hxx.

◆ GetNameOfClass()

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

Runtime information support.

◆ GetShrinkFactor()

template<class TInputImage , class TOutputImage = TInputImage>
virtual unsigned int otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::GetShrinkFactor ( )
virtual

◆ GetShrunkOutput()

template<class TInputImage , class TOutputImage = TInputImage>
OutputImageType* otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::GetShrunkOutput ( )
inline

Definition at line 202 of file otbStreamingShrinkImageFilter.h.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

◆ PrintSelf()

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

Constructor

Definition at line 192 of file otbStreamingShrinkImageFilter.hxx.

◆ Reset()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::Reset ( void  )
overridevirtual

Constructor

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 107 of file otbStreamingShrinkImageFilter.hxx.

◆ SetShrinkFactor()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactor ( unsigned int  _arg)
virtual

◆ Synthetize()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::Synthetize ( void  )
overridevirtual

Constructor

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 154 of file otbStreamingShrinkImageFilter.hxx.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Multi-thread version GenerateData.

Definition at line 164 of file otbStreamingShrinkImageFilter.hxx.

Member Data Documentation

◆ InputImageDimension

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

Definition at line 197 of file otbStreamingShrinkImageFilter.h.

◆ m_Offset

template<class TInputImage , class TOutputImage = TInputImage>
IndexType otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::m_Offset
private

The offset to get the cell center

Definition at line 247 of file otbStreamingShrinkImageFilter.h.

◆ m_ShrinkFactor

template<class TInputImage , class TOutputImage = TInputImage>
unsigned int otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::m_ShrinkFactor
private

The shrink factor

Definition at line 244 of file otbStreamingShrinkImageFilter.h.

◆ m_ShrunkOutput

template<class TInputImage , class TOutputImage = TInputImage>
OutputImagePointer otb::PersistentShrinkImageFilter< TInputImage, TOutputImage >::m_ShrunkOutput
private

Definition at line 241 of file otbStreamingShrinkImageFilter.h.

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