OTB  7.4.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::PersistentGridHistogramFilter< TInputImage > Class Template Reference

#include <otbSARStreamingGridHistogramFilter.h>

+ Inheritance diagram for otb::PersistentGridHistogramFilter< TInputImage >:
+ Collaboration diagram for otb::PersistentGridHistogramFilter< TInputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef ImageType::IndexValueType IndexValueType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef itk::SimpleDataObjectDecorator< long > LongObjectType
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef TInputImage::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef itk::NumericTraits< double >::RealType RealType
 
typedef itk::SimpleDataObjectDecorator< std::vector< RealType > * > RealVectorObjectType
 
typedef TInputImage::RegionType RegionType
 
typedef PersistentGridHistogramFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef ImageType::SizeValueType SizeValueType
 
typedef PersistentImageFilter< TInputImage, TInputImage > Superclass
 
- Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage InputImageType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TInputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual int GetDimension ()
 
virtual RealType GetMeanShift ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetNumberHist ()
 
virtual RealType GetStepHist ()
 
virtual float GetThreshold ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) ITK_OVERRIDE
 
virtual void SetDimension (int _arg)
 
virtual void SetMeanShift (RealType _arg)
 
virtual void SetNumberHist (int _arg)
 
virtual void SetStepHist (RealType _arg)
 
virtual void SetThreshold (float _arg)
 
std::vector< RealType > * GetVectorShifts () const
 
RealVectorObjectTypeGetVectorShifts_Output ()
 
const RealVectorObjectTypeGetVectorShifts_Output () const
 
void Synthetize (void) ITK_OVERRIDE
 
void Reset (void) ITK_OVERRIDE
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Member Functions

virtual void GenerateInputRequestedRegion () ITK_OVERRIDE
 
 PersistentGridHistogramFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const ITK_OVERRIDE
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, itk::ThreadIdType threadId) ITK_OVERRIDE
 
 ~PersistentGridHistogramFilter () ITK_OVERRIDE
 
void AllocateOutputs () ITK_OVERRIDE
 
void GenerateOutputInformation () ITK_OVERRIDE
 
- Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
 PersistentImageFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentImageFilter () override
 

Private Member Functions

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

Private Attributes

int m_Dimension
 
RealType m_MeanShift
 
int m_NumberHist
 
RealType m_StepHist
 
std::vector< std::vector< RealType > *> m_Thread_Shifts
 
float m_Threshold
 

Detailed Description

template<class TInputImage>
class otb::PersistentGridHistogramFilter< TInputImage >

Retrive some shifts from the input grid. The grid is a vector image of three components : shift_range, shift_azimut and correlation_rate. The selection on shifts depends on the correlation rate, the mean shift into the choosen dimension and the step of current histogram.

This filter persists its temporary data. It means that if you Update it n times on n different requested regions, the output statistics will be the statitics of the whole set of n regions.

To reset the temporary data, one should call the Reset() function.

To get the wanted values once the regions have been processed via the pipeline, use the Synthetize() method.

Definition at line 56 of file otbSARStreamingGridHistogramFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage>
typedef itk::SmartPointer<const Self> otb::PersistentGridHistogramFilter< TInputImage >::ConstPointer

Definition at line 64 of file otbSARStreamingGridHistogramFilter.h.

◆ DataObjectPointer

template<class TInputImage>
typedef itk::DataObject::Pointer otb::PersistentGridHistogramFilter< TInputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 95 of file otbSARStreamingGridHistogramFilter.h.

◆ DataObjectPointerArraySizeType

template<class TInputImage>
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::PersistentGridHistogramFilter< TInputImage >::DataObjectPointerArraySizeType

Definition at line 96 of file otbSARStreamingGridHistogramFilter.h.

◆ ImageType

template<class TInputImage>
typedef TInputImage otb::PersistentGridHistogramFilter< TInputImage >::ImageType

Image related typedefs.

Definition at line 70 of file otbSARStreamingGridHistogramFilter.h.

◆ IndexType

template<class TInputImage>
typedef TInputImage::IndexType otb::PersistentGridHistogramFilter< TInputImage >::IndexType

Definition at line 78 of file otbSARStreamingGridHistogramFilter.h.

◆ IndexValueType

template<class TInputImage>
typedef ImageType::IndexValueType otb::PersistentGridHistogramFilter< TInputImage >::IndexValueType

Definition at line 80 of file otbSARStreamingGridHistogramFilter.h.

◆ InputImagePointer

template<class TInputImage>
typedef TInputImage::Pointer otb::PersistentGridHistogramFilter< TInputImage >::InputImagePointer

Definition at line 74 of file otbSARStreamingGridHistogramFilter.h.

◆ LongObjectType

template<class TInputImage>
typedef itk::SimpleDataObjectDecorator<long> otb::PersistentGridHistogramFilter< TInputImage >::LongObjectType

Definition at line 101 of file otbSARStreamingGridHistogramFilter.h.

◆ PixelObjectType

template<class TInputImage>
typedef itk::SimpleDataObjectDecorator<PixelType> otb::PersistentGridHistogramFilter< TInputImage >::PixelObjectType

Definition at line 102 of file otbSARStreamingGridHistogramFilter.h.

◆ PixelType

template<class TInputImage>
typedef TInputImage::PixelType otb::PersistentGridHistogramFilter< TInputImage >::PixelType

Definition at line 79 of file otbSARStreamingGridHistogramFilter.h.

◆ Pointer

template<class TInputImage>
typedef itk::SmartPointer<Self> otb::PersistentGridHistogramFilter< TInputImage >::Pointer

Definition at line 63 of file otbSARStreamingGridHistogramFilter.h.

◆ RealObjectType

template<class TInputImage>
typedef itk::SimpleDataObjectDecorator<RealType> otb::PersistentGridHistogramFilter< TInputImage >::RealObjectType

Type of DataObjects used for scalar outputs

Definition at line 99 of file otbSARStreamingGridHistogramFilter.h.

◆ RealType

template<class TInputImage>
typedef itk::NumericTraits<double>::RealType otb::PersistentGridHistogramFilter< TInputImage >::RealType

Type to use for computations.

Definition at line 92 of file otbSARStreamingGridHistogramFilter.h.

◆ RealVectorObjectType

template<class TInputImage>
typedef itk::SimpleDataObjectDecorator<std::vector<RealType> *> otb::PersistentGridHistogramFilter< TInputImage >::RealVectorObjectType

Definition at line 100 of file otbSARStreamingGridHistogramFilter.h.

◆ RegionType

template<class TInputImage>
typedef TInputImage::RegionType otb::PersistentGridHistogramFilter< TInputImage >::RegionType

Definition at line 76 of file otbSARStreamingGridHistogramFilter.h.

◆ Self

template<class TInputImage>
typedef PersistentGridHistogramFilter otb::PersistentGridHistogramFilter< TInputImage >::Self

Standard Self typedef

Definition at line 61 of file otbSARStreamingGridHistogramFilter.h.

◆ SizeType

template<class TInputImage>
typedef TInputImage::SizeType otb::PersistentGridHistogramFilter< TInputImage >::SizeType

Definition at line 77 of file otbSARStreamingGridHistogramFilter.h.

◆ SizeValueType

template<class TInputImage>
typedef ImageType::SizeValueType otb::PersistentGridHistogramFilter< TInputImage >::SizeValueType

Definition at line 81 of file otbSARStreamingGridHistogramFilter.h.

◆ Superclass

template<class TInputImage>
typedef PersistentImageFilter<TInputImage, TInputImage> otb::PersistentGridHistogramFilter< TInputImage >::Superclass

Definition at line 62 of file otbSARStreamingGridHistogramFilter.h.

Constructor & Destructor Documentation

◆ PersistentGridHistogramFilter() [1/2]

template<class TInputImage>
otb::PersistentGridHistogramFilter< TInputImage >::PersistentGridHistogramFilter ( )
protected

◆ ~PersistentGridHistogramFilter()

template<class TInputImage>
otb::PersistentGridHistogramFilter< TInputImage >::~PersistentGridHistogramFilter ( )
inlineprotected

Definition at line 140 of file otbSARStreamingGridHistogramFilter.h.

◆ PersistentGridHistogramFilter() [2/2]

template<class TInputImage>
otb::PersistentGridHistogramFilter< TInputImage >::PersistentGridHistogramFilter ( const Self )
private

Member Function Documentation

◆ AllocateOutputs()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::AllocateOutputs ( )
protected

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

◆ CreateAnother()

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

◆ GenerateInputRequestedRegion()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::GenerateInputRequestedRegion ( )
protectedvirtual

PersistentGridHistogramFilter needs a input requested region with the same size of the output requested region.

See also
ProcessObject::GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::GenerateOutputInformation ( )
protected

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

◆ GetDimension()

template<class TInputImage>
virtual int otb::PersistentGridHistogramFilter< TInputImage >::GetDimension ( )
virtual

◆ GetMeanShift()

template<class TInputImage>
virtual RealType otb::PersistentGridHistogramFilter< TInputImage >::GetMeanShift ( )
virtual

◆ GetNameOfClass()

template<class TInputImage>
virtual const char* otb::PersistentGridHistogramFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

Reimplemented from otb::PersistentImageFilter< TInputImage, TInputImage >.

◆ GetNumberHist()

template<class TInputImage>
virtual int otb::PersistentGridHistogramFilter< TInputImage >::GetNumberHist ( )
virtual

◆ GetStepHist()

template<class TInputImage>
virtual RealType otb::PersistentGridHistogramFilter< TInputImage >::GetStepHist ( )
virtual

◆ GetThreshold()

template<class TInputImage>
virtual float otb::PersistentGridHistogramFilter< TInputImage >::GetThreshold ( )
virtual

◆ GetVectorShifts()

template<class TInputImage>
std::vector<RealType>* otb::PersistentGridHistogramFilter< TInputImage >::GetVectorShifts ( ) const
inline

Return the vectors of selected shifts for the two dimensions.

Definition at line 105 of file otbSARStreamingGridHistogramFilter.h.

◆ GetVectorShifts_Output() [1/2]

template<class TInputImage>
RealVectorObjectType* otb::PersistentGridHistogramFilter< TInputImage >::GetVectorShifts_Output ( )

Return the vectors of selected shifts for the two dimensions.

◆ GetVectorShifts_Output() [2/2]

template<class TInputImage>
const RealVectorObjectType* otb::PersistentGridHistogramFilter< TInputImage >::GetVectorShifts_Output ( ) const

Return the vectors of selected shifts for the two dimensions.

◆ MakeOutput()

template<class TInputImage>
DataObjectPointer otb::PersistentGridHistogramFilter< TInputImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)

Make a DataObject of the correct type to be used as the specified output.

◆ New()

template<class TInputImage>
static Pointer otb::PersistentGridHistogramFilter< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::operator= ( const Self )
private

◆ PrintSelf()

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

◆ Reset()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::Reset ( void  )
virtual

Synthetize and Reset function called by our PersistentFilterStreamingDecorator

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

◆ SetDimension()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::SetDimension ( int  _arg)
virtual

◆ SetMeanShift()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::SetMeanShift ( RealType  _arg)
virtual

◆ SetNumberHist()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::SetNumberHist ( int  _arg)
virtual

◆ SetStepHist()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::SetStepHist ( RealType  _arg)
virtual

◆ SetThreshold()

template<class TInputImage>
virtual void otb::PersistentGridHistogramFilter< TInputImage >::SetThreshold ( float  _arg)
virtual

◆ Synthetize()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::Synthetize ( void  )
virtual

Synthetize and Reset function called by our PersistentFilterStreamingDecorator

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

◆ ThreadedGenerateData()

template<class TInputImage>
void otb::PersistentGridHistogramFilter< TInputImage >::ThreadedGenerateData ( const RegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

Multi-thread version GenerateData.

Member Data Documentation

◆ ImageDimension

template<class TInputImage>
const unsigned int otb::PersistentGridHistogramFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension
static

Image related typedefs.

Definition at line 88 of file otbSARStreamingGridHistogramFilter.h.

◆ InputImageDimension

template<class TInputImage>
const unsigned int otb::PersistentGridHistogramFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

Definition at line 84 of file otbSARStreamingGridHistogramFilter.h.

◆ m_Dimension

template<class TInputImage>
int otb::PersistentGridHistogramFilter< TInputImage >::m_Dimension
private

Definition at line 171 of file otbSARStreamingGridHistogramFilter.h.

◆ m_MeanShift

template<class TInputImage>
RealType otb::PersistentGridHistogramFilter< TInputImage >::m_MeanShift
private

Definition at line 169 of file otbSARStreamingGridHistogramFilter.h.

◆ m_NumberHist

template<class TInputImage>
int otb::PersistentGridHistogramFilter< TInputImage >::m_NumberHist
private

Definition at line 175 of file otbSARStreamingGridHistogramFilter.h.

◆ m_StepHist

template<class TInputImage>
RealType otb::PersistentGridHistogramFilter< TInputImage >::m_StepHist
private

Definition at line 168 of file otbSARStreamingGridHistogramFilter.h.

◆ m_Thread_Shifts

template<class TInputImage>
std::vector<std::vector<RealType> * > otb::PersistentGridHistogramFilter< TInputImage >::m_Thread_Shifts
private

Definition at line 165 of file otbSARStreamingGridHistogramFilter.h.

◆ m_Threshold

template<class TInputImage>
float otb::PersistentGridHistogramFilter< TInputImage >::m_Threshold
private

Definition at line 173 of file otbSARStreamingGridHistogramFilter.h.


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