otb::PolyLineParametricPathWithValue< TValue, VDimension > Class Template Reference

#include <otbPolyLineParametricPathWithValue.h>

Inheritance diagram for otb::PolyLineParametricPathWithValue< TValue, VDimension >:

Collaboration diagram for otb::PolyLineParametricPathWithValue< TValue, VDimension >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef RegionType::IndexType	IndexType
typedef itk::SmartPointer< Self >	Pointer
typedef otb::RemoteSensingRegion< double >	RegionType
typedef PolyLineParametricPathWithValue	Self
typedef RegionType::SizeType	SizeType
typedef itk::PolyLineParametricPath< VDimension >	Superclass
typedef TValue	ValueType
typedef VertexListType::ConstIterator	VertexListConstIteratorType
typedef Superclass::VertexListType	VertexListType
typedef Superclass::VertexType	VertexType

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual std::string	GetKey ()
virtual const char *	GetNameOfClass () const
ValueType	GetValue (void) const
void	SetValue (ValueType value)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	~PolyLineParametricPathWithValue () override

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

Private Attributes
RegionType	m_BoundingRegion
bool	m_BoundingRegionIsValid
std::string	m_Key
double	m_Length
bool	m_LengthIsValid
virtual double	GetLength () const
virtual void	AddVertex (const ContinuousIndexType &vertex)
virtual RegionType	GetBoundingRegion (void) const
	PolyLineParametricPathWithValue ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
virtual void	ComputeLength () const
virtual void	ComputeBoundingRegion () const
void	Modified () const override

Detailed Description

template<class TValue, unsigned int VDimension = 2>
class otb::PolyLineParametricPathWithValue< TValue, VDimension >

This class implement a PolyLineParametricPath for which a value can be set. The value is stored in the itk::MetaDataDictionary. The precision of the value can be set.

See also

itk::PolyLineParametricPath.

Definition at line 50 of file otbPolyLineParametricPathWithValue.h.

Member Typedef Documentation

ConstPointer

template<class TValue , unsigned int VDimension = 2>

typedef itk::SmartPointer<const Self> otb::PolyLineParametricPathWithValue< TValue, VDimension >::ConstPointer

Definition at line 57 of file otbPolyLineParametricPathWithValue.h.

ContinuousIndexType

template<class TValue , unsigned int VDimension = 2>

typedef Superclass::ContinuousIndexType otb::PolyLineParametricPathWithValue< TValue, VDimension >::ContinuousIndexType

Definition at line 71 of file otbPolyLineParametricPathWithValue.h.

IndexType

template<class TValue , unsigned int VDimension = 2>

typedef RegionType::IndexType otb::PolyLineParametricPathWithValue< TValue, VDimension >::IndexType

Definition at line 77 of file otbPolyLineParametricPathWithValue.h.

Pointer

template<class TValue , unsigned int VDimension = 2>

typedef itk::SmartPointer<Self> otb::PolyLineParametricPathWithValue< TValue, VDimension >::Pointer

Definition at line 56 of file otbPolyLineParametricPathWithValue.h.

RegionType

template<class TValue , unsigned int VDimension = 2>

typedef otb::RemoteSensingRegion<double> otb::PolyLineParametricPathWithValue< TValue, VDimension >::RegionType

Definition at line 75 of file otbPolyLineParametricPathWithValue.h.

Self

template<class TValue , unsigned int VDimension = 2>

typedef PolyLineParametricPathWithValue otb::PolyLineParametricPathWithValue< TValue, VDimension >::Self

Standard typedefs

Definition at line 54 of file otbPolyLineParametricPathWithValue.h.

SizeType

template<class TValue , unsigned int VDimension = 2>

typedef RegionType::SizeType otb::PolyLineParametricPathWithValue< TValue, VDimension >::SizeType

Definition at line 76 of file otbPolyLineParametricPathWithValue.h.

Superclass

template<class TValue , unsigned int VDimension = 2>

typedef itk::PolyLineParametricPath<VDimension> otb::PolyLineParametricPathWithValue< TValue, VDimension >::Superclass

Definition at line 55 of file otbPolyLineParametricPathWithValue.h.

ValueType

template<class TValue , unsigned int VDimension = 2>

typedef TValue otb::PolyLineParametricPathWithValue< TValue, VDimension >::ValueType

Template parameters typedefs

Definition at line 63 of file otbPolyLineParametricPathWithValue.h.

VertexListConstIteratorType

template<class TValue , unsigned int VDimension = 2>

typedef VertexListType::ConstIterator otb::PolyLineParametricPathWithValue< TValue, VDimension >::VertexListConstIteratorType

Definition at line 72 of file otbPolyLineParametricPathWithValue.h.

VertexListType

template<class TValue , unsigned int VDimension = 2>

typedef Superclass::VertexListType otb::PolyLineParametricPathWithValue< TValue, VDimension >::VertexListType

Definition at line 70 of file otbPolyLineParametricPathWithValue.h.

VertexType

template<class TValue , unsigned int VDimension = 2>

typedef Superclass::VertexType otb::PolyLineParametricPathWithValue< TValue, VDimension >::VertexType

Derived typedefs

Definition at line 69 of file otbPolyLineParametricPathWithValue.h.

Constructor & Destructor Documentation

PolyLineParametricPathWithValue() [1/2]

template<class TValue , unsigned int VDimension>

otb::PolyLineParametricPathWithValue< TValue, VDimension >::PolyLineParametricPathWithValue

protected

Constructor

Definition at line 34 of file otbPolyLineParametricPathWithValue.hxx.

~PolyLineParametricPathWithValue()

template<class TValue , unsigned int VDimension = 2>

otb::PolyLineParametricPathWithValue< TValue, VDimension >::~PolyLineParametricPathWithValue ( )

inlineoverrideprotected

Destructor

Definition at line 121 of file otbPolyLineParametricPathWithValue.h.

PolyLineParametricPathWithValue() [2/2]

template<class TValue , unsigned int VDimension = 2>

otb::PolyLineParametricPathWithValue< TValue, VDimension >::PolyLineParametricPathWithValue ( const Self &  )

privatedelete

Member Function Documentation

AddVertex()

template<class TValue , unsigned int VDimension>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::AddVertex ( const ContinuousIndexType &  vertex )

virtual

Return the path length (perimeter).

Returns

The length.

Reimplemented in otb::Polygon< TValue >.

Definition at line 44 of file otbPolyLineParametricPathWithValue.hxx.

ComputeBoundingRegion()

template<class TValue , unsigned int VDimension>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::ComputeBoundingRegion

protectedvirtual

Bounding Box computation

Definition at line 126 of file otbPolyLineParametricPathWithValue.hxx.

ComputeLength()

template<class TValue , unsigned int VDimension>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::ComputeLength

protectedvirtual

Return the path length (perimeter).

Returns

The length.

Definition at line 61 of file otbPolyLineParametricPathWithValue.hxx.

CreateAnother()

template<class TValue , unsigned int VDimension = 2>

virtual::itk::LightObject::Pointer otb::PolyLineParametricPathWithValue< TValue, VDimension >::CreateAnother

(

void

)

const

GetBoundingRegion()

template<class TValue , unsigned int VDimension>

PolyLineParametricPathWithValue< TValue, VDimension >::RegionType otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetBoundingRegion ( void  ) const

virtual

Compute the path bounding region.

Returns

The region.

Definition at line 113 of file otbPolyLineParametricPathWithValue.hxx.

GetKey()

template<class TValue , unsigned int VDimension = 2>

virtual std::string otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetKey ( )

virtual

GetLength()

template<class TValue , unsigned int VDimension>

double otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetLength

virtual

Return the path length (perimeter).

Returns

The length.

Definition at line 51 of file otbPolyLineParametricPathWithValue.hxx.

GetNameOfClass()

template<class TValue , unsigned int VDimension = 2>

virtual const char* otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetNameOfClass ( ) const

virtual

Creation through object factory macro

GetValue()

template<class TValue , unsigned int VDimension = 2>

ValueType otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetValue ( void  ) const

inline

Definition at line 87 of file otbPolyLineParametricPathWithValue.h.

Modified()

template<class TValue , unsigned int VDimension>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::Modified

overrideprotected

Return the path length (perimeter).

Returns

The length.

Definition at line 188 of file otbPolyLineParametricPathWithValue.hxx.

New()

template<class TValue , unsigned int VDimension = 2>

static Pointer otb::PolyLineParametricPathWithValue< TValue, VDimension >::New ( )

static

Type macro

operator=()

template<class TValue , unsigned int VDimension = 2>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::operator= ( const Self &  )

privatedelete

PrintSelf()

template<class TValue , unsigned int VDimension>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

PrintSelf method

PrintSelf Method

Definition at line 99 of file otbPolyLineParametricPathWithValue.hxx.

SetValue()

template<class TValue , unsigned int VDimension = 2>

void otb::PolyLineParametricPathWithValue< TValue, VDimension >::SetValue ( ValueType  value )

inline

Definition at line 81 of file otbPolyLineParametricPathWithValue.h.

Member Data Documentation

m_BoundingRegion

template<class TValue , unsigned int VDimension = 2>

RegionType otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_BoundingRegion

mutableprivate

Definition at line 138 of file otbPolyLineParametricPathWithValue.h.

m_BoundingRegionIsValid

template<class TValue , unsigned int VDimension = 2>

bool otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_BoundingRegionIsValid

mutableprivate

Definition at line 139 of file otbPolyLineParametricPathWithValue.h.

m_Key

template<class TValue , unsigned int VDimension = 2>

std::string otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_Key

private

Definition at line 135 of file otbPolyLineParametricPathWithValue.h.

m_Length

template<class TValue , unsigned int VDimension = 2>

double otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_Length

mutableprivate

Definition at line 136 of file otbPolyLineParametricPathWithValue.h.

m_LengthIsValid

template<class TValue , unsigned int VDimension = 2>

bool otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_LengthIsValid

mutableprivate

Definition at line 137 of file otbPolyLineParametricPathWithValue.h.

---

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

• otbPolyLineParametricPathWithValue.h
• otbPolyLineParametricPathWithValue.hxx