otb::ImageToPointSetFilter< TInputImage, TOutputPointSet > Class Template Reference

#include <otbImageToPointSetFilter.h>

Inheritance diagram for otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >:

Collaboration diagram for otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >:

Classes
struct	ThreadStruct

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputPointSetPointer	OutputPointSetPointer
typedef Superclass::OutputPointSetType	OutputPointSetType
typedef Superclass::PointDataContainerType	PointDataContainerType
typedef itk::SmartPointer< Self >	Pointer
typedef Superclass::PointsContainerType	PointsContainerType
typedef itk::ProcessObject	ProcessObjectType
typedef ImageToPointSetFilter	Self
typedef PointSetSource< TOutputPointSet >	Superclass
Public Types inherited from otb::PointSetSource< TOutputPointSet >
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 const char *	GetNameOfClass () const
Public Member Functions inherited from otb::PointSetSource< TOutputPointSet >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
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

Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
typedef std::vector< typename OutputPointSetType::PointsContainer::Pointer >	OutputPointsContainerForThreadType
typedef std::vector< typename OutputPointSetType::PointDataContainer::Pointer >	OutputPointDataContainerForThreadType
typedef RAMDrivenAdaptativeStreamingManager< InputImageType >	StreamingManagerType
typedef StreamingManagerType::Pointer	StreamingManagerPointer
OutputPointsContainerForThreadType	m_PointsContainerPerThread
OutputPointDataContainerForThreadType	m_PointDataContainerPerThread
StreamingManagerPointer	m_StreamingManager
void	SetInput (unsigned int idx, const InputImageType *input)
void	SetInput (const InputImageType *input)
const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput ()
void	GenerateOutputInformation (void) override
	ImageToPointSetFilter ()
	~ImageToPointSetFilter () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateData (void) override
virtual void	BeforeThreadedGenerateData ()
virtual void	AfterThreadedGenerateData ()
virtual int	SplitRequestedRegion (int i, int num, InputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const InputImageRegionType &inputRegionForThread, itk::ThreadIdType threadId)
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	ImageToPointSetFilter (const ImageToPointSetFilter &)=delete
void	operator= (const ImageToPointSetFilter &)=delete

Additional Inherited Members
Static Public Member Functions inherited from otb::PointSetSource< TOutputPointSet >
static Pointer	New ()
Protected Member Functions inherited from otb::PointSetSource< TOutputPointSet >
	PointSetSource ()
	~PointSetSource () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateInputRequestedRegion () override

Detailed Description

template<class TInputImage, class TOutputPointSet>
class otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >

Base class to output PointSet data with image data as input.

ImageToPointSetFilter is the base class for all process objects that output Point Set data and require image data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

Definition at line 44 of file otbImageToPointSetFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputPointSet >

typedef itk::SmartPointer<const Self> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ConstPointer

Definition at line 51 of file otbImageToPointSetFilter.h.

InputImageConstPointer

template<class TInputImage , class TOutputPointSet >

typedef InputImageType::ConstPointer otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageConstPointer

Definition at line 59 of file otbImageToPointSetFilter.h.

InputImagePixelType

template<class TInputImage , class TOutputPointSet >

typedef InputImageType::PixelType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImagePixelType

Definition at line 61 of file otbImageToPointSetFilter.h.

InputImagePointer

template<class TInputImage , class TOutputPointSet >

typedef InputImageType::Pointer otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImagePointer

Definition at line 58 of file otbImageToPointSetFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputPointSet >

typedef InputImageType::RegionType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageRegionType

Definition at line 60 of file otbImageToPointSetFilter.h.

InputImageType

template<class TInputImage , class TOutputPointSet >

typedef TInputImage otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageType

Some Image related typedefs.

Definition at line 54 of file otbImageToPointSetFilter.h.

OutputPointDataContainerForThreadType

template<class TInputImage , class TOutputPointSet >

typedef std::vector<typename OutputPointSetType::PointDataContainer::Pointer> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::OutputPointDataContainerForThreadType

protected

Multi-threading implementation

Definition at line 97 of file otbImageToPointSetFilter.h.

OutputPointsContainerForThreadType

template<class TInputImage , class TOutputPointSet >

typedef std::vector<typename OutputPointSetType::PointsContainer::Pointer> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::OutputPointsContainerForThreadType

protected

Multi-threading implementation

Definition at line 96 of file otbImageToPointSetFilter.h.

OutputPointSetPointer

template<class TInputImage , class TOutputPointSet >

typedef Superclass::OutputPointSetPointer otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::OutputPointSetPointer

Definition at line 66 of file otbImageToPointSetFilter.h.

OutputPointSetType

template<class TInputImage , class TOutputPointSet >

typedef Superclass::OutputPointSetType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::OutputPointSetType

Some PointSet related typedefs.

Definition at line 65 of file otbImageToPointSetFilter.h.

PointDataContainerType

template<class TInputImage , class TOutputPointSet >

typedef Superclass::PointDataContainerType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::PointDataContainerType

Definition at line 68 of file otbImageToPointSetFilter.h.

Pointer

template<class TInputImage , class TOutputPointSet >

typedef itk::SmartPointer<Self> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::Pointer

Definition at line 50 of file otbImageToPointSetFilter.h.

PointsContainerType

template<class TInputImage , class TOutputPointSet >

typedef Superclass::PointsContainerType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::PointsContainerType

Definition at line 67 of file otbImageToPointSetFilter.h.

ProcessObjectType

template<class TInputImage , class TOutputPointSet >

typedef itk::ProcessObject otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ProcessObjectType

Definition at line 69 of file otbImageToPointSetFilter.h.

Self

template<class TInputImage , class TOutputPointSet >

typedef ImageToPointSetFilter otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::Self

Standard class typedefs.

Definition at line 48 of file otbImageToPointSetFilter.h.

StreamingManagerPointer

template<class TInputImage , class TOutputPointSet >

typedef StreamingManagerType::Pointer otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::StreamingManagerPointer

protected

Multi-threading implementation

Definition at line 125 of file otbImageToPointSetFilter.h.

StreamingManagerType

template<class TInputImage , class TOutputPointSet >

typedef RAMDrivenAdaptativeStreamingManager<InputImageType> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::StreamingManagerType

protected

End Multi-threading implementation Setup for streaming

Definition at line 124 of file otbImageToPointSetFilter.h.

Superclass

template<class TInputImage , class TOutputPointSet >

typedef PointSetSource<TOutputPointSet> otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::Superclass

Definition at line 49 of file otbImageToPointSetFilter.h.

Constructor & Destructor Documentation

ImageToPointSetFilter() [1/2]

template<class TInputImage , class TOutputPointSet >

otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ImageToPointSetFilter

protected

Multi-threading implementation

Definition at line 33 of file otbImageToPointSetFilter.hxx.

~ImageToPointSetFilter()

template<class TInputImage , class TOutputPointSet >

otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::~ImageToPointSetFilter ( )

inlineoverrideprotected

Multi-threading implementation

Definition at line 87 of file otbImageToPointSetFilter.h.

ImageToPointSetFilter() [2/2]

template<class TInputImage , class TOutputPointSet >

otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ImageToPointSetFilter ( const ImageToPointSetFilter< TInputImage, TOutputPointSet > &  )

privatedelete

Multi-threading implementation

Member Function Documentation

AfterThreadedGenerateData()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::AfterThreadedGenerateData

protectedvirtual

Multi-threading implementation

Definition at line 188 of file otbImageToPointSetFilter.hxx.

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::BeforeThreadedGenerateData

protectedvirtual

Multi-threading implementation

Definition at line 183 of file otbImageToPointSetFilter.hxx.

GenerateData()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::GenerateData ( void  )

overrideprotected

GenerateData

Loop over the number of pieces, execute the upstream pipeline on each piece, and copy the results into the output image.

Definition at line 117 of file otbImageToPointSetFilter.hxx.

GenerateOutputInformation()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::GenerateOutputInformation ( void  )

override

Prepare the output

copy information from first input to all outputs This is a void implementation to prevent the ProcessObject version to be called

Definition at line 109 of file otbImageToPointSetFilter.hxx.

GetInput() [1/2]

template<class TInputImage , class TOutputPointSet >

const ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageType * otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::GetInput

Multi-threading implementation

Definition at line 86 of file otbImageToPointSetFilter.hxx.

GetInput() [2/2]

template<class TInputImage , class TOutputPointSet >

const ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageType * otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::GetInput

(

unsigned int

idx

)

Get the input image of this process object.

Definition at line 76 of file otbImageToPointSetFilter.hxx.

GetNameOfClass()

template<class TInputImage , class TOutputPointSet >

virtual const char* otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from otb::PointSetSource< TOutputPointSet >.

Reimplemented in otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >, otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >, and otb::SiftFastImageFilter< TInputImage, TOutputPointSet >.

operator=()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::operator= ( const ImageToPointSetFilter< TInputImage, TOutputPointSet > &  )

privatedelete

Multi-threading implementation

PrintSelf()

template<class TInputImage , class TOutputPointSet >

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

overrideprotected

Multi-threading implementation

Definition at line 98 of file otbImageToPointSetFilter.hxx.

SetInput() [1/2]

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::SetInput

(

const InputImageType *

input

)

Multi-threading implementation

Definition at line 64 of file otbImageToPointSetFilter.hxx.

SetInput() [2/2]

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::SetInput	(	unsigned int	idx,
		const InputImageType *	input
	)

Multi-threading implementation

Definition at line 53 of file otbImageToPointSetFilter.hxx.

SplitRequestedRegion()

template<class TInputImage , class TOutputPointSet >

int otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::SplitRequestedRegion ( int  i, int  num, InputImageRegionType &  splitRegion  )

protectedvirtual

Multi-threading implementation

Definition at line 269 of file otbImageToPointSetFilter.hxx.

ThreadedGenerateData()

template<class TInputImage , class TOutputPointSet >

void otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ThreadedGenerateData ( const InputImageRegionType &  inputRegionForThread, itk::ThreadIdType  threadId  )

protectedvirtual

Multi-threading implementation

Reimplemented in otb::ThresholdImageToPointSetFilter< TInputImage, TOutputPointSet >.

Definition at line 225 of file otbImageToPointSetFilter.hxx.

ThreaderCallback()

template<class TInputImage , class TOutputPointSet >

ITK_THREAD_RETURN_TYPE otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::ThreaderCallback ( void *  arg )

staticprotected

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

Definition at line 239 of file otbImageToPointSetFilter.hxx.

Member Data Documentation

InputImageDimension

template<class TInputImage , class TOutputPointSet >

const unsigned int otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::InputImageDimension = TInputImage::ImageDimension

static

Definition at line 62 of file otbImageToPointSetFilter.h.

m_PointDataContainerPerThread

template<class TInputImage , class TOutputPointSet >

OutputPointDataContainerForThreadType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::m_PointDataContainerPerThread

protected

Multi-threading implementation

Definition at line 119 of file otbImageToPointSetFilter.h.

m_PointsContainerPerThread

template<class TInputImage , class TOutputPointSet >

OutputPointsContainerForThreadType otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::m_PointsContainerPerThread

protected

Multi-threading implementation

Definition at line 118 of file otbImageToPointSetFilter.h.

m_StreamingManager

template<class TInputImage , class TOutputPointSet >

StreamingManagerPointer otb::ImageToPointSetFilter< TInputImage, TOutputPointSet >::m_StreamingManager

protected

Multi-threading implementation

Definition at line 127 of file otbImageToPointSetFilter.h.

---

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

• otbImageToPointSetFilter.h
• otbImageToPointSetFilter.hxx