OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType > Class Template Referenceabstract

#include <otbPersistentMosaicFilter.h>

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

Public Types

typedef Superclass::ConstIteratorType ConstIteratorType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef Superclass::DefaultInterpolatorType DefaultInterpolatorType
 
typedef Superclass::InputImageIndexType InputImageIndexType
 
typedef Superclass::InputImageInternalPixelType InputImageInternalPixelType
 
typedef Superclass::InputImagePixelType InputImagePixelType
 
typedef Superclass::InputImagePointer InputImagePointer
 
typedef Superclass::InputImagePointType InputImagePointType
 
typedef Superclass::InputImageRegionType InputImageRegionType
 
typedef Superclass::InputImageSizeType InputImageSizeType
 
typedef Superclass::InputImageSpacingType InputImageSpacingType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::InternalImageType InternalImageType
 
typedef Superclass::InternalPixelType InternalPixelType
 
typedef Superclass::InternalValueType InternalValueType
 
typedef Superclass::InterpolatorPointerType InterpolatorPointerType
 
typedef Superclass::InterpolatorType InterpolatorType
 
typedef Superclass::IteratorType IteratorType
 
typedef Superclass::OutputImageIndexType OutputImageIndexType
 
typedef Superclass::OutputImageInternalPixelType OutputImageInternalPixelType
 
typedef Superclass::OutputImagePixelType OutputImagePixelType
 
typedef Superclass::OutputImagePointer OutputImagePointer
 
typedef Superclass::OutputImagePointType OutputImagePointType
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef Superclass::OutputImageSizeType OutputImageSizeType
 
typedef Superclass::OutputImageSpacingType OutputImageSpacingType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentMosaicFilter Self
 
typedef Superclass::StreamingTraitsType StreamingTraitsType
 
typedef otb::StreamingMosaicFilterBase< TInputImage, TOutputImage, TPrecisionType > Superclass
 
- Public Types inherited from otb::StreamingMosaicFilterBase< TInputImage, TOutputImage, TPrecisionType >
typedef itk::ImageRegionConstIterator< OutputImageTypeConstIteratorType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::ContinuousIndex< double, 2 > ContinuousIndexType
 
typedef itk::NearestNeighborInterpolateImageFunction< InputImageType, InternalValueTypeDefaultInterpolatorType
 
typedef std::vector< unsigned int > IndicesListType
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::InternalPixelType InputImageInternalPixelType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::PointType InputImagePointType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef InputImageType::SpacingType InputImageSpacingType
 
typedef TInputImage InputImageType
 
typedef otb::VectorImage< InternalValueType, 2 > InternalImageType
 
typedef InternalImageType::PixelType InternalPixelType
 
typedef TPrecisionType InternalValueType
 
typedef InterpolatorType::Pointer InterpolatorPointerType
 
typedef itk::InterpolateImageFunction< InputImageType, InternalValueTypeInterpolatorType
 
typedef itk::ImageRegionIterator< OutputImageTypeIteratorType
 
typedef vnl_matrix< InternalValueTypeMatrixType
 
typedef OutputImageType::IndexType OutputImageIndexType
 
typedef OutputImageType::InternalPixelType OutputImageInternalPixelType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::PointType OutputImagePointType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::SizeType OutputImageSizeType
 
typedef OutputImageType::SpacingType OutputImageSpacingType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingMosaicFilterBase Self
 
typedef otb::StreamingTraits< OutputImageTypeStreamingTraitsType
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual void Reset (void)=0
 
virtual void Synthetize (void)=0
 
- Public Member Functions inherited from otb::StreamingMosaicFilterBase< TInputImage, TOutputImage, TPrecisionType >
virtual const char * GetNameOfClass () const
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
 itkGetObjectMacro (Interpolator, InterpolatorType)
 
virtual void SetNoDataOutputPixel (OutputImagePixelType _arg)
 
virtual OutputImagePixelType GetNoDataOutputPixel ()
 
virtual void SetNoDataInputPixel (InputImagePixelType _arg)
 
virtual InputImagePixelType GetNoDataInputPixel ()
 
virtual void SetOutputSpacing (OutputImageSpacingType _arg)
 
virtual OutputImageSpacingType GetOutputSpacing ()
 
virtual void SetOutputOrigin (OutputImagePointType _arg)
 
virtual OutputImagePointType GetOutputOrigin ()
 
virtual void SetOutputSize (OutputImageSizeType _arg)
 
virtual OutputImageSizeType GetOutputSize ()
 
virtual void SetAutomaticOutputParametersComputation (bool _arg)
 
virtual bool GetAutomaticOutputParametersComputation ()
 
virtual void SetShiftScaleInputImages (bool _arg)
 
virtual bool GetShiftScaleInputImages ()
 
virtual void ShiftScaleInputImagesOn ()
 
virtual void ShiftScaleInputImagesOff ()
 
virtual void SetShiftMatrix (MatrixType shiftMatrix)
 
virtual void SetScaleMatrix (MatrixType scaleMatrix)
 
virtual MatrixType GetShiftMatrix ()
 
virtual MatrixType GetScaleMatrix ()
 

Protected Member Functions

 PersistentMosaicFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentMosaicFilter () override
 
- Protected Member Functions inherited from otb::StreamingMosaicFilterBase< TInputImage, TOutputImage, TPrecisionType >
 StreamingMosaicFilterBase ()
 
 ~StreamingMosaicFilterBase ()
 
void GenerateOutputInformation (void) override
 
void GenerateInputRequestedRegion (void) override
 
void AfterThreadedGenerateData () override
 
void BeforeThreadedGenerateData () override
 
virtual void ImageToExtent (InputImageType *image, InputImagePointType &extentInf, InputImagePointType &extentSup)
 
virtual bool OutputRegionToInputRegion (const OutputImageRegionType &mosaicRegion, InputImageRegionType &inputRegion, InputImageType *&inputImage)
 
virtual void NormalizePixelValue (InternalValueType &pixelValue)
 
virtual bool IsPixelNotEmpty (InputImagePixelType &inputPixel)
 
virtual void AddUsedInputImageIndex (unsigned int index)
 
virtual unsigned int GetUsedInputImageIndice (unsigned int i)
 
virtual unsigned int GetNumberOfUsedInputImages ()
 
virtual void ComputeOutputParameters ()
 
virtual unsigned int GetNumberOfInputImages ()
 
virtual unsigned int GetNumberOfBands ()
 
virtual void ComputeRequestedRegionOfInputImage (unsigned int inputImageIndex)
 
virtual void ShiftScaleValue (InternalValueType &value, const unsigned int &imageIndex, unsigned int &band)
 
virtual void CheckShiftScaleMatrices ()
 
virtual void PrepareImageAccessors (typename std::vector< InputImageType * > &image, typename std::vector< InterpolatorPointerType > &interpolator)
 

Private Member Functions

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

Detailed Description

template<class TInputImage, class TOutputImage, class TPrecisionType>
class otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >

This filter is the base class for all mosaic filter persisting data through multiple update. For instance, a filter computing global statistics on an mosaic with streaming capabilities will have to keep the temporary results for each streamed piece of the image in order to synthesize the global statistics at the end. This filter is an itk::ImageToImageFilter, providing two additional methods. The first one, Synthetize(), allows the user to synthesize temporary data produced by the multiple updates on different pieces of the image to the global result. The second one, Reset(), allows the user to reset the temporary data for a new input image for instance.

Note
This class contains pure virtual method, and can not be instantiated.
See also
PersistentMosaicFilter
StreamingStatisticsMosaicFilter

Definition at line 48 of file otbPersistentMosaicFilter.h.

Member Typedef Documentation

◆ ConstIteratorType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::ConstIteratorType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::ConstIteratorType

Definition at line 91 of file otbPersistentMosaicFilter.h.

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef itk::SmartPointer<const Self> otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::ConstPointer

Definition at line 55 of file otbPersistentMosaicFilter.h.

◆ ContinuousIndexType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::ContinuousIndexType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::ContinuousIndexType

Definition at line 84 of file otbPersistentMosaicFilter.h.

◆ DefaultInterpolatorType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::DefaultInterpolatorType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::DefaultInterpolatorType

Definition at line 87 of file otbPersistentMosaicFilter.h.

◆ InputImageIndexType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageIndexType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageIndexType

Definition at line 65 of file otbPersistentMosaicFilter.h.

◆ InputImageInternalPixelType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageInternalPixelType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageInternalPixelType

Definition at line 68 of file otbPersistentMosaicFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImagePixelType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImagePixelType

Definition at line 64 of file otbPersistentMosaicFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImagePointer otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImagePointer

Definition at line 62 of file otbPersistentMosaicFilter.h.

◆ InputImagePointType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImagePointType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImagePointType

Definition at line 63 of file otbPersistentMosaicFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageRegionType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageRegionType

Definition at line 69 of file otbPersistentMosaicFilter.h.

◆ InputImageSizeType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageSizeType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageSizeType

Definition at line 66 of file otbPersistentMosaicFilter.h.

◆ InputImageSpacingType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageSpacingType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageSpacingType

Definition at line 67 of file otbPersistentMosaicFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InputImageType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InputImageType

Input image typedefs.

Definition at line 58 of file otbPersistentMosaicFilter.h.

◆ InternalImageType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InternalImageType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InternalImageType

Definition at line 88 of file otbPersistentMosaicFilter.h.

◆ InternalPixelType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InternalPixelType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InternalPixelType

Definition at line 89 of file otbPersistentMosaicFilter.h.

◆ InternalValueType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InternalValueType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InternalValueType

Internal computing typedef support.

Definition at line 83 of file otbPersistentMosaicFilter.h.

◆ InterpolatorPointerType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InterpolatorPointerType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InterpolatorPointerType

Definition at line 86 of file otbPersistentMosaicFilter.h.

◆ InterpolatorType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::InterpolatorType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::InterpolatorType

Definition at line 85 of file otbPersistentMosaicFilter.h.

◆ IteratorType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::IteratorType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::IteratorType

Definition at line 90 of file otbPersistentMosaicFilter.h.

◆ OutputImageIndexType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageIndexType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageIndexType

Definition at line 76 of file otbPersistentMosaicFilter.h.

◆ OutputImageInternalPixelType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageInternalPixelType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageInternalPixelType

Definition at line 79 of file otbPersistentMosaicFilter.h.

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImagePixelType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImagePixelType

Definition at line 75 of file otbPersistentMosaicFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImagePointer otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImagePointer

Definition at line 73 of file otbPersistentMosaicFilter.h.

◆ OutputImagePointType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImagePointType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImagePointType

Definition at line 74 of file otbPersistentMosaicFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageRegionType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageRegionType

Definition at line 80 of file otbPersistentMosaicFilter.h.

◆ OutputImageSizeType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageSizeType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageSizeType

Definition at line 77 of file otbPersistentMosaicFilter.h.

◆ OutputImageSpacingType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageSpacingType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageSpacingType

Definition at line 78 of file otbPersistentMosaicFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::OutputImageType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::OutputImageType

Output image typedefs.

Definition at line 72 of file otbPersistentMosaicFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef itk::SmartPointer<Self> otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::Pointer

Definition at line 54 of file otbPersistentMosaicFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef PersistentMosaicFilter otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::Self

Standard typedefs

Definition at line 52 of file otbPersistentMosaicFilter.h.

◆ StreamingTraitsType

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef Superclass::StreamingTraitsType otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::StreamingTraitsType

Definition at line 92 of file otbPersistentMosaicFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TPrecisionType >
typedef otb::StreamingMosaicFilterBase<TInputImage, TOutputImage, TPrecisionType> otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::Superclass

Definition at line 53 of file otbPersistentMosaicFilter.h.

Constructor & Destructor Documentation

◆ PersistentMosaicFilter() [1/2]

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

Constructor

Definition at line 106 of file otbPersistentMosaicFilter.h.

◆ ~PersistentMosaicFilter()

template<class TInputImage , class TOutputImage , class TPrecisionType >
otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::~PersistentMosaicFilter ( )
inlineoverrideprotected

Destructor

Definition at line 111 of file otbPersistentMosaicFilter.h.

◆ PersistentMosaicFilter() [2/2]

template<class TInputImage , class TOutputImage , class TPrecisionType >
otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::PersistentMosaicFilter ( const Self )
private

Member Function Documentation

◆ GetNameOfClass()

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

Creation through object factory macro

◆ operator=()

template<class TInputImage , class TOutputImage , class TPrecisionType >
void otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::operator= ( const Self )
private

◆ PrintSelf()

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

PrintSelf method

Definition at line 116 of file otbPersistentMosaicFilter.h.

◆ Reset()

template<class TInputImage , class TOutputImage , class TPrecisionType >
virtual void otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::Reset ( void  )
pure virtual

Reset the persistent data of the filter.

Implemented in otb::PersistentStatisticsMosaicFilter< TInputImage, TOutputImage, TInternalValueType >.

◆ Synthetize()

template<class TInputImage , class TOutputImage , class TPrecisionType >
virtual void otb::PersistentMosaicFilter< TInputImage, TOutputImage, TPrecisionType >::Synthetize ( void  )
pure virtual

Synthesize the persistent data of the filter.

Implemented in otb::PersistentStatisticsMosaicFilter< TInputImage, TOutputImage, TInternalValueType >.


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