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

#include <otbStreamingMinMaxImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
StatFilterType::IndexObjectType 
IndexObjectType
 
typedef StatFilterType::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef
StatFilterType::PixelObjectType 
PixelObjectType
 
typedef StatFilterType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingMinMaxImageFilter Self
 
typedef Superclass::FilterType StatFilterType
 
typedef
PersistentFilterStreamingDecorator
< PersistentMinMaxImageFilter
< TInputImage > > 
Superclass
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef
PersistentMinMaxImageFilter
< TInputImage > 
FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
PersistentFilterStreamingDecorator 
Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef
StreamingImageVirtualWriter
< ImageType
StreamerType
 
typedef itk::ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetInput ()
 
IndexType GetMaximumIndex () const
 
IndexObjectTypeGetMaximumIndexOutput ()
 
const IndexObjectTypeGetMaximumIndexOutput () const
 
PixelType GetMinimum () const
 
IndexType GetMinimumIndex () const
 
IndexObjectTypeGetMinimumIndexOutput ()
 
const IndexObjectTypeGetMinimumIndexOutput () const
 
PixelObjectTypeGetMinimumOutput ()
 
const PixelObjectTypeGetMinimumOutput () const
 
virtual const char * GetNameOfClass () const
 
void SetInput (InputImageType *input)
 
PixelType GetMaximum () const
 
PixelObjectTypeGetMaximumOutput ()
 
const PixelObjectTypeGetMaximumOutput () const
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< 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
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 StreamingMinMaxImageFilter ()
 
 ~StreamingMinMaxImageFilter () override
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > >
void GenerateData (void) override
 
 PersistentFilterStreamingDecorator ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentFilterStreamingDecorator () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentMinMaxImageFilter< TInputImage > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TInputImage>
class otb::StreamingMinMaxImageFilter< TInputImage >

This class streams the whole input image through the PersistentMinMaxImageFilter.

This way, it allows computing the minimum and maximum of this image.

It calls the Reset() method of the PersistentMinMaxImageFilter before streaming the image and the Synthetize() method of the PersistentMinMaxImageFilter after having streamed the image to compute the statistics.

This filter can be used as:

MinMaxType::Pointer minmax = MinMaxType::New();
minmax->SetInput(reader->GetOutput());
minmax->Update();
std::cout << minmax-> GetMaximum() << std::endl;
std::cout << minmax-> GetMinimum() << std::endl;
std::cout << minmax-> GetMaximumIndex() << std::endl;
std::cout << minmax-> GetMinimumIndex() << std::endl;
See Also
PersistentMinMaxImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 197 of file otbStreamingMinMaxImageFilter.h.

Member Typedef Documentation

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

Definition at line 206 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
typedef StatFilterType::IndexObjectType otb::StreamingMinMaxImageFilter< TInputImage >::IndexObjectType

Definition at line 218 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
typedef StatFilterType::IndexType otb::StreamingMinMaxImageFilter< TInputImage >::IndexType

Definition at line 216 of file otbStreamingMinMaxImageFilter.h.

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

Definition at line 219 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
typedef StatFilterType::PixelObjectType otb::StreamingMinMaxImageFilter< TInputImage >::PixelObjectType

Definition at line 217 of file otbStreamingMinMaxImageFilter.h.

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

Definition at line 215 of file otbStreamingMinMaxImageFilter.h.

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

Definition at line 205 of file otbStreamingMinMaxImageFilter.h.

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

Standard Self typedef

Definition at line 202 of file otbStreamingMinMaxImageFilter.h.

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

Definition at line 212 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
typedef PersistentFilterStreamingDecorator<PersistentMinMaxImageFilter<TInputImage> > otb::StreamingMinMaxImageFilter< TInputImage >::Superclass

Definition at line 204 of file otbStreamingMinMaxImageFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 290 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
otb::StreamingMinMaxImageFilter< TInputImage >::~StreamingMinMaxImageFilter ( )
inlineoverrideprotected

Destructor

Definition at line 293 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
otb::StreamingMinMaxImageFilter< TInputImage >::StreamingMinMaxImageFilter ( const Self )
privatedelete

Member Function Documentation

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

Reimplemented from itk::Object.

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

Definition at line 226 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
PixelType otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximum ( ) const
inline

Return the computed Maximum.

Definition at line 246 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
IndexType otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndex ( ) const
inline

Return the computed Maximum.

Definition at line 275 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndexOutput ( )
inline

Definition at line 279 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
const IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumIndexOutput ( ) const
inline

Definition at line 283 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
PixelObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumOutput ( )
inline

Return the computed Maximum.

Definition at line 250 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
const PixelObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMaximumOutput ( ) const
inline

Return the computed Maximum.

Definition at line 254 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
PixelType otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimum ( ) const
inline

Return the computed Minimum.

Definition at line 232 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
IndexType otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndex ( ) const
inline

Return the computed Minimum.

Definition at line 261 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndexOutput ( )
inline

Definition at line 265 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
const IndexObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumIndexOutput ( ) const
inline

Definition at line 269 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
PixelObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumOutput ( )
inline

Definition at line 236 of file otbStreamingMinMaxImageFilter.h.

template<class TInputImage >
const PixelObjectType* otb::StreamingMinMaxImageFilter< TInputImage >::GetMinimumOutput ( ) const
inline

Definition at line 240 of file otbStreamingMinMaxImageFilter.h.

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

Creation through object factory macro

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

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

Type macro

template<class TInputImage >
void otb::StreamingMinMaxImageFilter< TInputImage >::operator= ( const Self )
privatedelete
template<class TInputImage >
void otb::StreamingMinMaxImageFilter< TInputImage >::SetInput ( InputImageType input)
inline

Definition at line 222 of file otbStreamingMinMaxImageFilter.h.


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