OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members

#include <otbSARStreamingGridHistogramFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef TInputImage InputImageType
 
typedef itk::SimpleDataObjectDecorator< long > LongObjectType
 
typedef itk::SimpleDataObjectDecorator< PixelTypePixelObjectType
 
typedef StatFilterType::PixelType PixelType
 
using Point2DType = itk::Point< double, 2 >
 
using Point3DType = itk::Point< double, 3 >
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SimpleDataObjectDecorator< RealTypeRealObjectType
 
typedef StatFilterType::RealType RealType
 
typedef itk::SimpleDataObjectDecorator< std::vector< RealType > * > RealVectorObjectType
 
typedef TInputImage::RegionType RegionType
 
typedef SARStreamingGridHistogramFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef Superclass::FilterType StatFilterType
 
typedef PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > > Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentGridHistogramFilter< TInputImage > FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentFilterStreamingDecorator Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef StreamingImageVirtualWriter< ImageTypeStreamerType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void GetGridHistogramInformation (double &step, double &meanShift)
 
const InputImageTypeGetInput ()
 
virtual const char * GetNameOfClass () const
 
void SetDimension (int dimension)
 
void SetInput (InputImageType *input)
 
void SetMeanShift (RealType meanShift)
 
void SetNumberHist (int numberHist)
 
void SetStepHist (RealType stepHist)
 
void SetThreshold (float threshold)
 
std::vector< RealType > * GetVectorShifts () const
 
RealVectorObjectTypeGetVectorShifts_Output ()
 
const RealVectorObjectTypeGetVectorShifts_Output () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterTypeGetFilter () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > >
static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

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

Private Attributes

int m_NumberHist
 

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 

Detailed Description

template<class TInputImage>
class otb::SARStreamingGridHistogramFilter< TInputImage >

This class streams the whole input image through the PersistentGridHistogramFilter.

This way, it allows computing the first order global statistics of this image. It calls the Reset() method of the PersistentGridHistogramFilter before streaming the image and the Synthetize() method of the PersistentGridHistogramFilter after having streamed the image to compute the statistics. The accessor on the results are wrapping the accessors of the internal PersistentGridHistogramFilter.

This filter can be used as:

StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->SetDimension(0);
statistics->SetStepHist(0.2);
statistics->SetThreshold(0.3);
statistics->SetMeanShift(-11.5);
statistics->SetNumberHist(256);
statistics->Update();
double step, meanShift;
statistics->GetGridHistogramInformation(step, meanShift);
std::cout << step << ", " << meanShift << std::endl;
See also
PersistentGridHistogramFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 219 of file otbSARStreamingGridHistogramFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 228 of file otbSARStreamingGridHistogramFilter.h.

◆ ImageType

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

Image related typedefs.

Definition at line 248 of file otbSARStreamingGridHistogramFilter.h.

◆ IndexType

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

Definition at line 253 of file otbSARStreamingGridHistogramFilter.h.

◆ InputImagePointer

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

Definition at line 249 of file otbSARStreamingGridHistogramFilter.h.

◆ InputImageType

template<class TInputImage >
typedef TInputImage otb::SARStreamingGridHistogramFilter< TInputImage >::InputImageType

Definition at line 239 of file otbSARStreamingGridHistogramFilter.h.

◆ LongObjectType

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

Definition at line 243 of file otbSARStreamingGridHistogramFilter.h.

◆ PixelObjectType

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

Definition at line 244 of file otbSARStreamingGridHistogramFilter.h.

◆ PixelType

template<class TInputImage >
typedef StatFilterType::PixelType otb::SARStreamingGridHistogramFilter< TInputImage >::PixelType

Definition at line 237 of file otbSARStreamingGridHistogramFilter.h.

◆ Point2DType

template<class TInputImage >
using otb::SARStreamingGridHistogramFilter< TInputImage >::Point2DType = itk::Point<double,2>

Definition at line 256 of file otbSARStreamingGridHistogramFilter.h.

◆ Point3DType

template<class TInputImage >
using otb::SARStreamingGridHistogramFilter< TInputImage >::Point3DType = itk::Point<double,3>

Definition at line 257 of file otbSARStreamingGridHistogramFilter.h.

◆ Pointer

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

Definition at line 227 of file otbSARStreamingGridHistogramFilter.h.

◆ RealObjectType

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

Type of DataObjects used for scalar outputs

Definition at line 242 of file otbSARStreamingGridHistogramFilter.h.

◆ RealType

template<class TInputImage >
typedef StatFilterType::RealType otb::SARStreamingGridHistogramFilter< TInputImage >::RealType

Definition at line 238 of file otbSARStreamingGridHistogramFilter.h.

◆ RealVectorObjectType

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

Definition at line 245 of file otbSARStreamingGridHistogramFilter.h.

◆ RegionType

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

Definition at line 251 of file otbSARStreamingGridHistogramFilter.h.

◆ Self

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

Standard Self typedef

Definition at line 224 of file otbSARStreamingGridHistogramFilter.h.

◆ SizeType

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

Definition at line 252 of file otbSARStreamingGridHistogramFilter.h.

◆ StatFilterType

template<class TInputImage >
typedef Superclass::FilterType otb::SARStreamingGridHistogramFilter< TInputImage >::StatFilterType

Definition at line 234 of file otbSARStreamingGridHistogramFilter.h.

◆ Superclass

template<class TInputImage >
typedef PersistentFilterStreamingDecorator<PersistentGridHistogramFilter<TInputImage> > otb::SARStreamingGridHistogramFilter< TInputImage >::Superclass

Definition at line 226 of file otbSARStreamingGridHistogramFilter.h.

Constructor & Destructor Documentation

◆ SARStreamingGridHistogramFilter() [1/2]

template<class TInputImage >
otb::SARStreamingGridHistogramFilter< TInputImage >::SARStreamingGridHistogramFilter ( )
inlineprotected

Constructor

Definition at line 381 of file otbSARStreamingGridHistogramFilter.h.

◆ ~SARStreamingGridHistogramFilter()

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

Destructor

Definition at line 384 of file otbSARStreamingGridHistogramFilter.h.

◆ SARStreamingGridHistogramFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetGridHistogramInformation()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::GetGridHistogramInformation ( double &  step,
double &  meanShift 
)
inline

Definition at line 318 of file otbSARStreamingGridHistogramFilter.h.

◆ GetInput()

template<class TInputImage >
const InputImageType* otb::SARStreamingGridHistogramFilter< TInputImage >::GetInput ( void  )
inline

Definition at line 264 of file otbSARStreamingGridHistogramFilter.h.

◆ GetNameOfClass()

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

Creation through object factory macro

Reimplemented from otb::PersistentFilterStreamingDecorator< PersistentGridHistogramFilter< TInputImage > >.

◆ GetVectorShifts()

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

Return vectors.

Definition at line 302 of file otbSARStreamingGridHistogramFilter.h.

◆ GetVectorShifts_Output() [1/2]

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

Return vectors.

Definition at line 306 of file otbSARStreamingGridHistogramFilter.h.

◆ GetVectorShifts_Output() [2/2]

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

Return vectors.

Definition at line 310 of file otbSARStreamingGridHistogramFilter.h.

◆ New()

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

Type macro

◆ operator=()

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

◆ SetDimension()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetDimension ( int  dimension)
inline

Definition at line 287 of file otbSARStreamingGridHistogramFilter.h.

◆ SetInput()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetInput ( InputImageType input)
inline

Definition at line 260 of file otbSARStreamingGridHistogramFilter.h.

◆ SetMeanShift()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetMeanShift ( RealType  meanShift)
inline

Definition at line 274 of file otbSARStreamingGridHistogramFilter.h.

◆ SetNumberHist()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetNumberHist ( int  numberHist)
inline

Definition at line 282 of file otbSARStreamingGridHistogramFilter.h.

◆ SetStepHist()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetStepHist ( RealType  stepHist)
inline

Definition at line 270 of file otbSARStreamingGridHistogramFilter.h.

◆ SetThreshold()

template<class TInputImage >
void otb::SARStreamingGridHistogramFilter< TInputImage >::SetThreshold ( float  threshold)
inline

Definition at line 278 of file otbSARStreamingGridHistogramFilter.h.

Member Data Documentation

◆ m_NumberHist

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

Definition at line 390 of file otbSARStreamingGridHistogramFilter.h.


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