otb::PersistentImageSampleExtractorFilter< TInputImage > Class Template Reference

#include <otbImageSampleExtractorFilter.h>

Inheritance diagram for otb::PersistentImageSampleExtractorFilter< TInputImage >:

Collaboration diagram for otb::PersistentImageSampleExtractorFilter< TInputImage >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::DataObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::Pointer	InputImagePointer
typedef TInputImage	InputImageType
typedef InputImageType::InternalPixelType	InternalPixelType
typedef ogr::DataSource::Pointer	OGRDataPointer
typedef ogr::DataSource	OGRDataType
typedef InputImageType::PixelType	PixelType
typedef itk::SmartPointer< Self >	Pointer
typedef InputImageType::PointType	PointType
typedef InputImageType::RegionType	RegionType
typedef PersistentImageSampleExtractorFilter	Self
typedef PersistentSamplingFilterBase< TInputImage >	Superclass
Public Types inherited from otb::PersistentSamplingFilterBase< TInputImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef otb::Image< unsigned char, 2 >	MaskImageType
typedef ogr::DataSource::Pointer	OGRDataPointer
typedef itk::SmartPointer< Self >	Pointer
typedef TInputImage::RegionType	RegionType
typedef PersistentSamplingFilterBase	Self
typedef PersistentImageFilter< TInputImage, TInputImage >	Superclass
Public Types inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TInputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef PersistentImageFilter	Self
typedef itk::ImageToImageFilter< TInputImage, TInputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
ogr::DataSource *	GetOutputSamples ()
const std::vector< std::string > &	GetSampleFieldNames ()
virtual std::string	GetSampleFieldPrefix ()
void	Reset (void) override
void	SetOutputSamples (ogr::DataSource *data)
void	SetSampleFieldNames (std::vector< std::string > &names)
virtual void	SetSampleFieldPrefix (std::string _arg)
void	Synthetize (void) override
Public Member Functions inherited from otb::PersistentSamplingFilterBase< TInputImage >
const otb::Image< unsigned char, 2 > *	GetMask ()
virtual const char *	GetNameOfClass () const
const ogr::DataSource *	GetOGRData ()
const std::vector< std::string > &	GetOGRLayerCreationOptions ()
void	SetMask (const otb::Image< unsigned char, 2 > *mask)
void	SetOGRData (const ogr::DataSource *vector)
void	SetOGRLayerCreationOptions (const std::vector< std::string > &options)
virtual void	SetFieldName (std::string _arg)
virtual std::string	GetFieldName ()
virtual int	GetFieldIndex ()
virtual void	SetLayerIndex (int _arg)
virtual int	GetLayerIndex ()
virtual void	SetOutLayerName (std::string _arg)
virtual std::string	GetOutLayerName ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
	PersistentImageSampleExtractorFilter ()
void	ThreadedGenerateVectorData (const ogr::Layer &layerForThread, itk::ThreadIdType threadid) override
	~PersistentImageSampleExtractorFilter () override
Protected Member Functions inherited from otb::PersistentSamplingFilterBase< TInputImage >
	PersistentSamplingFilterBase ()
	~PersistentSamplingFilterBase () override
void	GenerateOutputInformation () override
void	GenerateInputRequestedRegion () override
void	GenerateData (void) override
void	AllocateOutputs (void) override
void	ExploreGeometry (const ogr::Feature &feature, OGRGeometry *geom, RegionType &region, itk::ThreadIdType &threadid)
virtual void	ProcessLine (const ogr::Feature &feature, OGRLineString *line, RegionType &region, itk::ThreadIdType &threadid)
virtual void	ProcessPolygon (const ogr::Feature &feature, OGRPolygon *polygon, RegionType &region, itk::ThreadIdType &threadid)
virtual void	ProcessSample (const ogr::Feature &feature, typename TInputImage::IndexType &imgIndex, typename TInputImage::PointType &imgPoint, itk::ThreadIdType &threadid)
virtual void	PrepareFeature (const ogr::Feature &feature, itk::ThreadIdType &threadid)
bool	IsSampleInsidePolygon (OGRPolygon *poly, OGRPoint *tmpPoint)
bool	IsSampleOnLine (OGRLineString *line, typename TInputImage::PointType &position, typename TInputImage::SpacingType &absSpacing, OGRPolygon &tmpPolygon)
RegionType	FeatureBoundingRegion (const TInputImage *image, otb::ogr::Layer::const_iterator &featIt) const
virtual void	DispatchInputVectors (void)
virtual void	GatherOutputVectors (void)
virtual void	FillOneOutput (unsigned int outIdx, ogr::DataSource *outDS, bool update)
virtual void	InitializeOutputDataSource (ogr::DataSource *inputDS, ogr::DataSource *outputDS)
void	ClearAdditionalFields ()
void	CreateAdditionalField (std::string name, OGRFieldType type, int width=0, int precision=0)
const std::vector< SimpleFieldDefn > &	GetAdditionalFields ()
ogr::Layer	GetInMemoryInput (unsigned int threadId)
ogr::Layer	GetInMemoryOutput (unsigned int threadId, unsigned int index=0)
Protected Member Functions inherited from otb::PersistentImageFilter< TInputImage, TInputImage >
	PersistentImageFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~PersistentImageFilter () override

Private Member Functions
void	InitializeFields ()
void	operator= (const Self &)=delete
	PersistentImageSampleExtractorFilter (const Self &)=delete

Private Attributes
std::vector< std::string >	m_SampleFieldNames
std::string	m_SampleFieldPrefix

Additional Inherited Members
Static Protected Member Functions inherited from otb::PersistentSamplingFilterBase< TInputImage >
static ITK_THREAD_RETURN_TYPE	VectorThreaderCallback (void *arg)

Detailed Description

template<class TInputImage>
class otb::PersistentImageSampleExtractorFilter< TInputImage >

Persistent filter to extract sample values from an image.

Definition at line 41 of file otbImageSampleExtractorFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage >

typedef itk::SmartPointer<const Self> otb::PersistentImageSampleExtractorFilter< TInputImage >::ConstPointer

Definition at line 49 of file otbImageSampleExtractorFilter.h.

DataObjectPointerArraySizeType

template<class TInputImage >

typedef itk::DataObject::DataObjectPointerArraySizeType otb::PersistentImageSampleExtractorFilter< TInputImage >::DataObjectPointerArraySizeType

Definition at line 62 of file otbImageSampleExtractorFilter.h.

IndexType

template<class TInputImage >

typedef InputImageType::IndexType otb::PersistentImageSampleExtractorFilter< TInputImage >::IndexType

Definition at line 55 of file otbImageSampleExtractorFilter.h.

InputImagePointer

template<class TInputImage >

typedef InputImageType::Pointer otb::PersistentImageSampleExtractorFilter< TInputImage >::InputImagePointer

Definition at line 52 of file otbImageSampleExtractorFilter.h.

InputImageType

template<class TInputImage >

typedef TInputImage otb::PersistentImageSampleExtractorFilter< TInputImage >::InputImageType

Definition at line 51 of file otbImageSampleExtractorFilter.h.

InternalPixelType

template<class TInputImage >

typedef InputImageType::InternalPixelType otb::PersistentImageSampleExtractorFilter< TInputImage >::InternalPixelType

Definition at line 57 of file otbImageSampleExtractorFilter.h.

OGRDataPointer

template<class TInputImage >

typedef ogr::DataSource::Pointer otb::PersistentImageSampleExtractorFilter< TInputImage >::OGRDataPointer

Definition at line 60 of file otbImageSampleExtractorFilter.h.

OGRDataType

template<class TInputImage >

typedef ogr::DataSource otb::PersistentImageSampleExtractorFilter< TInputImage >::OGRDataType

Definition at line 59 of file otbImageSampleExtractorFilter.h.

PixelType

template<class TInputImage >

typedef InputImageType::PixelType otb::PersistentImageSampleExtractorFilter< TInputImage >::PixelType

Definition at line 56 of file otbImageSampleExtractorFilter.h.

Pointer

template<class TInputImage >

typedef itk::SmartPointer<Self> otb::PersistentImageSampleExtractorFilter< TInputImage >::Pointer

Definition at line 48 of file otbImageSampleExtractorFilter.h.

PointType

template<class TInputImage >

typedef InputImageType::PointType otb::PersistentImageSampleExtractorFilter< TInputImage >::PointType

Definition at line 54 of file otbImageSampleExtractorFilter.h.

RegionType

template<class TInputImage >

typedef InputImageType::RegionType otb::PersistentImageSampleExtractorFilter< TInputImage >::RegionType

Definition at line 53 of file otbImageSampleExtractorFilter.h.

Self

template<class TInputImage >

typedef PersistentImageSampleExtractorFilter otb::PersistentImageSampleExtractorFilter< TInputImage >::Self

Standard Self typedef

Definition at line 46 of file otbImageSampleExtractorFilter.h.

Superclass

template<class TInputImage >

typedef PersistentSamplingFilterBase<TInputImage> otb::PersistentImageSampleExtractorFilter< TInputImage >::Superclass

Definition at line 47 of file otbImageSampleExtractorFilter.h.

Constructor & Destructor Documentation

PersistentImageSampleExtractorFilter() [1/2]

template<class TInputImage >

otb::PersistentImageSampleExtractorFilter< TInputImage >::PersistentImageSampleExtractorFilter

protected

Constructor

Definition at line 33 of file otbImageSampleExtractorFilter.hxx.

~PersistentImageSampleExtractorFilter()

template<class TInputImage >

otb::PersistentImageSampleExtractorFilter< TInputImage >::~PersistentImageSampleExtractorFilter ( )

inlineoverrideprotected

Destructor

Definition at line 98 of file otbImageSampleExtractorFilter.h.

PersistentImageSampleExtractorFilter() [2/2]

template<class TInputImage >

otb::PersistentImageSampleExtractorFilter< TInputImage >::PersistentImageSampleExtractorFilter ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

template<class TInputImage >

virtual::itk::LightObject::Pointer otb::PersistentImageSampleExtractorFilter< TInputImage >::CreateAnother

(

void

)

const

GenerateInputRequestedRegion()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::GenerateInputRequestedRegion

overrideprotected

Definition at line 144 of file otbImageSampleExtractorFilter.hxx.

GenerateOutputInformation()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::GenerateOutputInformation

overrideprotected

Definition at line 106 of file otbImageSampleExtractorFilter.hxx.

References otb::ogr::Layer::GetSpatialRef().

GetNameOfClass()

template<class TInputImage >

virtual const char* otb::PersistentImageSampleExtractorFilter< TInputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

GetOutputSamples()

template<class TInputImage >

ogr::DataSource * otb::PersistentImageSampleExtractorFilter< TInputImage >::GetOutputSamples

Get the output samples OGR container

Definition at line 46 of file otbImageSampleExtractorFilter.hxx.

GetSampleFieldNames()

template<class TInputImage >

const std::vector< std::string > & otb::PersistentImageSampleExtractorFilter< TInputImage >::GetSampleFieldNames

Get the sample names

Definition at line 100 of file otbImageSampleExtractorFilter.hxx.

GetSampleFieldPrefix()

template<class TInputImage >

virtual std::string otb::PersistentImageSampleExtractorFilter< TInputImage >::GetSampleFieldPrefix ( )

virtual

InitializeFields()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::InitializeFields

private

Initialize fields to store extracted values (Real type)

Definition at line 214 of file otbImageSampleExtractorFilter.hxx.

New()

template<class TInputImage >

static Pointer otb::PersistentImageSampleExtractorFilter< TInputImage >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::operator= ( const Self &  )

privatedelete

Reset()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::Reset ( void  )

overridevirtual

Reset method called before starting the streaming

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 56 of file otbImageSampleExtractorFilter.hxx.

SetOutputSamples()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::SetOutputSamples

(

ogr::DataSource *

data

)

Set the output samples OGR container (shall be equal to the input container for an 'update' mode)

Definition at line 40 of file otbImageSampleExtractorFilter.hxx.

SetSampleFieldNames()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::SetSampleFieldNames

(

std::vector< std::string > &

names

)

Directly set the output field names (the prefix won't be used)

Definition at line 90 of file otbImageSampleExtractorFilter.hxx.

SetSampleFieldPrefix()

template<class TInputImage >

virtual void otb::PersistentImageSampleExtractorFilter< TInputImage >::SetSampleFieldPrefix ( std::string  _arg )

virtual

Synthetize()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::Synthetize ( void  )

inlineoverridevirtual

Synthesize the persistent data of the filter.

Implements otb::PersistentImageFilter< TInputImage, TInputImage >.

Definition at line 77 of file otbImageSampleExtractorFilter.h.

ThreadedGenerateVectorData()

template<class TInputImage >

void otb::PersistentImageSampleExtractorFilter< TInputImage >::ThreadedGenerateVectorData ( const ogr::Layer &  layerForThread, itk::ThreadIdType  threadid  )

overrideprotectedvirtual

process only points

Reimplemented from otb::PersistentSamplingFilterBase< TInputImage >.

Definition at line 153 of file otbImageSampleExtractorFilter.hxx.

References otb::ogr::Layer::begin(), otb::ogr::Layer::CreateFeature(), otb::ogr::Layer::end(), otb::ogr::Layer::GetFeatureCount(), otb::ogr::Layer::GetLayerDefn(), otbWarningMacro, otb::ogr::Feature::SetFID(), and otb::ogr::Feature::SetFrom().

Member Data Documentation

m_SampleFieldNames

template<class TInputImage >

std::vector<std::string> otb::PersistentImageSampleExtractorFilter< TInputImage >::m_SampleFieldNames

private

List of field names for each component

Definition at line 121 of file otbImageSampleExtractorFilter.h.

m_SampleFieldPrefix

template<class TInputImage >

std::string otb::PersistentImageSampleExtractorFilter< TInputImage >::m_SampleFieldPrefix

private

Prefix to generate field names for each input channel (ignored if the field names are given directly)

Definition at line 118 of file otbImageSampleExtractorFilter.h.

---

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

• otbImageSampleExtractorFilter.h
• otbImageSampleExtractorFilter.hxx