#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< Self >	Pointer

typedef OutputPointSetType::PointsContainer	PointsContainerType

typedef PointSetSource	Self

typedef itk::ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()

int	m_GenerateDataRegion

int	m_GenerateDataNumberOfRegions

OutputPointSetType *	GetOutput (void)

OutputPointSetType *	GetOutput (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

	PointSetSource ()

	~PointSetSource () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

void	GenerateInputRequestedRegion () override

	PointSetSource (const Self &)=delete

void	operator= (const Self &)=delete

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

◆ ConstPointer

template<class TOutputPointSet >

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

Definition at line 52 of file otbPointSetSource.h.

◆ DataObjectPointer

template<class TOutputPointSet >

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

Definition at line 62 of file otbPointSetSource.h.

◆ DataObjectPointerArraySizeType

template<class TOutputPointSet >

typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::PointSetSource< TOutputPointSet >::DataObjectPointerArraySizeType

Some convenient typedefs.

Definition at line 58 of file otbPointSetSource.h.

◆ OutputPointSetPointer

template<class TOutputPointSet >

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

Definition at line 64 of file otbPointSetSource.h.

◆ OutputPointSetType

template<class TOutputPointSet >

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

Definition at line 63 of file otbPointSetSource.h.

◆ PointDataContainerType

template<class TOutputPointSet >

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

Definition at line 66 of file otbPointSetSource.h.

◆ Pointer

template<class TOutputPointSet >

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

Definition at line 51 of file otbPointSetSource.h.

◆ PointsContainerType

template<class TOutputPointSet >

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

Definition at line 65 of file otbPointSetSource.h.

◆ Self

template<class TOutputPointSet >

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

Standard class typedefs.

Definition at line 49 of file otbPointSetSource.h.

◆ Superclass

template<class TOutputPointSet >

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

Definition at line 50 of file otbPointSetSource.h.

Constructor & Destructor Documentation

◆ PointSetSource() [1/2]

template<class TOutputPointSet >

otb::PointSetSource< TOutputPointSet >::PointSetSource

protected

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

Definition at line 33 of file otbPointSetSource.hxx.

◆ ~PointSetSource()

template<class TOutputPointSet >

otb::PointSetSource< TOutputPointSet >::~PointSetSource ( )

inlineoverrideprotected

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

Definition at line 137 of file otbPointSetSource.h.

◆ PointSetSource() [2/2]

template<class TOutputPointSet >

otb::PointSetSource< TOutputPointSet >::PointSetSource ( const Self & )

privatedelete

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

Member Function Documentation

◆ CreateAnother()

template<class TOutputPointSet >

virtual::itk::LightObject::Pointer otb::PointSetSource< TOutputPointSet >::CreateAnother ( void ) const

◆ GenerateInputRequestedRegion()

template<class TOutputPointSet >

void otb::PointSetSource< TOutputPointSet >::GenerateInputRequestedRegion

overrideprotected

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.

Definition at line 94 of file otbPointSetSource.hxx.

◆ GetNameOfClass()

template<class TOutputPointSet >

virtual const char* otb::PointSetSource< TOutputPointSet >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >, otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >, otb::TransformPointSetFilter< TInputPointSet, TOutputPointSet, TTransform >, otb::PointSetExtractROI< TInputPointSet, TOutputPointSet >, otb::SiftFastImageFilter< TInputImage, TOutputPointSet >, otb::RandomPointSetSource< TOutputPointSet >, otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >, otb::ImageToPointSetFilter< TInputImage, itk::PointSet< typename TInputImage::PixelType, 2 > >, and otb::PointSetToPointSetFilter< TInputPointSet, TOutputPointSet >.

◆ GetOutput() [1/2]

template<class TOutputPointSet >

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

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

Definition at line 73 of file otbPointSetSource.hxx.

◆ GetOutput() [2/2]

template<class TOutputPointSet >

PointSetSource< TOutputPointSet >::OutputPointSetType * otb::PointSetSource< TOutputPointSet >::GetOutput ( void )

Get the point set output of this process object.

Definition at line 59 of file otbPointSetSource.hxx.

◆ GraftNthOutput()

template<class TOutputPointSet >

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

virtual

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

Definition at line 112 of file otbPointSetSource.hxx.

◆ GraftOutput()

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 103 of file otbPointSetSource.hxx.

◆ MakeOutput()

template<class TOutputPointSet >

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

override

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().

Definition at line 50 of file otbPointSetSource.hxx.

◆ New()

template<class TOutputPointSet >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TOutputPointSet >

void otb::PointSetSource< TOutputPointSet >::operator= ( const Self & )

privatedelete

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

◆ PrintSelf()

template<class TOutputPointSet >

void otb::PointSetSource< TOutputPointSet >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overrideprotected

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

Definition at line 134 of file otbPointSetSource.hxx.

◆ SetOutput()

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 82 of file otbPointSetSource.hxx.

Member Data Documentation

◆ m_GenerateDataNumberOfRegions

template<class TOutputPointSet >

int otb::PointSetSource< TOutputPointSet >::m_GenerateDataNumberOfRegions

private

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

Definition at line 154 of file otbPointSetSource.h.

◆ m_GenerateDataRegion

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 153 of file otbPointSetSource.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointer

◆ DataObjectPointerArraySizeType

◆ OutputPointSetPointer

◆ OutputPointSetType

◆ PointDataContainerType

◆ Pointer

◆ PointsContainerType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PointSetSource() [1/2]

◆ ~PointSetSource()

◆ PointSetSource() [2/2]

Member Function Documentation

◆ CreateAnother()

◆ GenerateInputRequestedRegion()

◆ GetNameOfClass()

◆ GetOutput() [1/2]

◆ GetOutput() [2/2]

◆ GraftNthOutput()

◆ GraftOutput()

◆ MakeOutput()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetOutput()

Member Data Documentation

◆ m_GenerateDataNumberOfRegions

◆ m_GenerateDataRegion

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