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

#include <otbPointSetSource.h>

+ Inheritance diagram for otb::PointSetSource< TOutputPointSet >:
+ Collaboration diagram for otb::PointSetSource< TOutputPointSet >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputPointSetType::Pointer OutputPointSetPointer
 
typedef TOutputPointSet OutputPointSetType
 
typedef
OutputPointSetType::PointDataContainer 
PointDataContainerType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
OutputPointSetType::PointsContainer 
PointsContainerType
 
typedef PointSetSource Self
 
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
 
virtual const char * GetNameOfClass () const
 
OutputPointSetTypeGetOutput (void)
 
OutputPointSetTypeGetOutput (DataObjectPointerArraySizeType idx)
 
void SetOutput (OutputPointSetType *output)
 
virtual void GraftOutput (itk::DataObject *output)
 
virtual void GraftNthOutput (DataObjectPointerArraySizeType idx, itk::DataObject *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) 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 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 Update ()
 
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 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

void GenerateInputRequestedRegion () override
 
 PointSetSource ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PointSetSource () 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 GenerateData ()
 
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
 
 PointSetSource (const Self &)=delete
 

Private Attributes

int m_GenerateDataNumberOfRegions
 
int m_GenerateDataRegion
 

Additional Inherited Members

- 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 TOutputPointSet>
class otb::PointSetSource< TOutputPointSet >

Base class for all process objects that output point set data.

PointSetSource is the base class for all process objects that output point set data. Specifically, this class defines the GetOutput() method that returns a pointer to the output point set. The class also defines some internal private data members that are used to manage streaming of data.

Definition at line 45 of file otbPointSetSource.h.

Member Typedef Documentation

template<class TOutputPointSet>
typedef itk::SmartPointer<const Self> otb::PointSetSource< TOutputPointSet >::ConstPointer

Definition at line 52 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef itk::DataObject::Pointer otb::PointSetSource< TOutputPointSet >::DataObjectPointer

Definition at line 62 of file otbPointSetSource.h.

Some convenient typedefs.

Definition at line 58 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef OutputPointSetType::Pointer otb::PointSetSource< TOutputPointSet >::OutputPointSetPointer

Definition at line 64 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef TOutputPointSet otb::PointSetSource< TOutputPointSet >::OutputPointSetType

Definition at line 63 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef OutputPointSetType::PointDataContainer otb::PointSetSource< TOutputPointSet >::PointDataContainerType

Definition at line 66 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef itk::SmartPointer<Self> otb::PointSetSource< TOutputPointSet >::Pointer

Definition at line 51 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef OutputPointSetType::PointsContainer otb::PointSetSource< TOutputPointSet >::PointsContainerType

Definition at line 65 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef PointSetSource otb::PointSetSource< TOutputPointSet >::Self

Standard class typedefs.

Definition at line 49 of file otbPointSetSource.h.

template<class TOutputPointSet>
typedef itk::ProcessObject otb::PointSetSource< TOutputPointSet >::Superclass

Definition at line 50 of file otbPointSetSource.h.

Constructor & Destructor Documentation

template<class TOutputPointSet >
otb::PointSetSource< TOutputPointSet >::PointSetSource ( )
protected

Definition at line 34 of file otbPointSetSource.hxx.

template<class TOutputPointSet>
otb::PointSetSource< TOutputPointSet >::~PointSetSource ( )
inlineoverrideprotected

Definition at line 137 of file otbPointSetSource.h.

template<class TOutputPointSet>
otb::PointSetSource< TOutputPointSet >::PointSetSource ( const Self )
privatedelete

Member Function Documentation

template<class TOutputPointSet>
virtual::itk::LightObject::Pointer otb::PointSetSource< TOutputPointSet >::CreateAnother ( void  ) const
virtual
template<class TOutputPointSet >
void otb::PointSetSource< TOutputPointSet >::GenerateInputRequestedRegion ( void  )
overrideprotectedvirtual

Requested region of Point Set is specified as i of N unstructured regions. Since all DataObjects should be able to set the requested region in unstructured form, just copy output->RequestedRegion all inputs.

Reimplemented from itk::ProcessObject.

Definition at line 109 of file otbPointSetSource.hxx.

template<class TOutputPointSet>
virtual const char* otb::PointSetSource< TOutputPointSet >::GetNameOfClass ( ) const
virtual
template<class TOutputPointSet >
PointSetSource< TOutputPointSet >::OutputPointSetType * otb::PointSetSource< TOutputPointSet >::GetOutput ( void  )

Get the point set output of this process object.

Definition at line 65 of file otbPointSetSource.hxx.

template<class TOutputPointSet >
PointSetSource< TOutputPointSet >::OutputPointSetType * otb::PointSetSource< TOutputPointSet >::GetOutput ( DataObjectPointerArraySizeType  idx)

Get the point set output of this process object.

Definition at line 82 of file otbPointSetSource.hxx.

template<class TOutputPointSet >
void otb::PointSetSource< TOutputPointSet >::GraftNthOutput ( DataObjectPointerArraySizeType  idx,
itk::DataObject output 
)
virtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

// setup the mini-pipeline to process the input to this filter
firstFilterInMiniPipeline->SetInput( this->GetInput() );
// setup the mini-pipeline to calculate the correct regions
// and write to the appropriate bulk data block
lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
// execute the mini-pipeline
lastFilterInMiniPipeline->Update();
// graft the mini-pipeline output back onto this filter's output.
// this is needed to get the appropriate regions passed back.
this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Definition at line 131 of file otbPointSetSource.hxx.

References itk::DataObject::Graft().

template<class TOutputPointSet >
void otb::PointSetSource< TOutputPointSet >::GraftOutput ( itk::DataObject output)
virtual

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

// setup the mini-pipeline to process the input to this filter
firstFilterInMiniPipeline->SetInput( this->GetInput() );
// setup the mini-pipeline to calculate the correct regions
// and write to the appropriate bulk data block
lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
// execute the mini-pipeline
lastFilterInMiniPipeline->Update();
// graft the mini-pipeline output back onto this filter's output.
// this is needed to get the appropriate regions passed back.
this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Definition at line 120 of file otbPointSetSource.hxx.

template<class TOutputPointSet >
PointSetSource< TOutputPointSet >::DataObjectPointer otb::PointSetSource< TOutputPointSet >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of MeshSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Definition at line 54 of file otbPointSetSource.hxx.

template<class TOutputPointSet>
static Pointer otb::PointSetSource< TOutputPointSet >::New ( )
static

Method for creation through the object factory.

template<class TOutputPointSet>
void otb::PointSetSource< TOutputPointSet >::operator= ( const Self )
privatedelete
template<class TOutputPointSet >
void otb::PointSetSource< TOutputPointSet >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual
template<class TOutputPointSet >
void otb::PointSetSource< TOutputPointSet >::SetOutput ( OutputPointSetType output)

Set the point set output of this process object. This call is slated to be removed from ITK. You should GraftOutput() and possible DataObject::DisconnectPipeline() to properly change the output.

Definition at line 94 of file otbPointSetSource.hxx.

Member Data Documentation

template<class TOutputPointSet>
int otb::PointSetSource< TOutputPointSet >::m_GenerateDataNumberOfRegions
private

Definition at line 152 of file otbPointSetSource.h.

template<class TOutputPointSet>
int otb::PointSetSource< TOutputPointSet >::m_GenerateDataRegion
private

Used by streaming: The requested region of the output being processed by the execute method. Set in the GenerateInputRequestedRegion method.

Definition at line 151 of file otbPointSetSource.h.


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