Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::PolyLineParametricPathWithValue< TValue, VDimension > Class Template Reference

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. More...

#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< SelfPointer
 
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 Types inherited from itk::PolyLineParametricPath< VDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Index< VDimension > IndexType
 
typedef Superclass::InputType InputType
 
typedef Offset< VDimension > OffsetType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< double, VDimension > PointType
 
typedef PolyLineParametricPath Self
 
typedef ParametricPath
< VDimension > 
Superclass
 
typedef Vector< double,
VDimension > 
VectorType
 
typedef VertexListType::Pointer VertexListPointer
 
typedef VectorContainer
< unsigned, VertexType
VertexListType
 
typedef ContinuousIndexType VertexType
 
- Public Types inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Index< VDimension > IndexType
 
typedef double InputType
 
typedef Offset< VDimension > OffsetType
 
typedef ContinuousIndex
< SpacePrecisionType,
VDimension > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Path Self
 
typedef DataObject Superclass
 

Public Member Functions

virtual void AddVertex (const ContinuousIndexType &vertex)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual RegionType GetBoundingRegion (void) const
 
virtual std::string GetKey ()
 
virtual double GetLength () const
 
virtual const char * GetNameOfClass () const
 
ValueType GetValue (void) const
 
void SetValue (ValueType value)
 
- Public Member Functions inherited from itk::PolyLineParametricPath< VDimension >
void AddVertex (const ContinuousIndexType &vertex)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual InputType EndOfInput () const
 
virtual OutputType Evaluate (const InputType &input) const
 
virtual VectorType EvaluateDerivative (const InputType &input) const
 
virtual VertexListTypeGetModifiableVertexList ()
 
virtual const VertexListTypeGetVertexList () const
 
virtual OffsetType IncrementInput (InputType &input) const
 
virtual void Initialize (void)
 
- Public Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType EvaluateToIndex (const InputType &input) const =0
 
virtual InputType StartOfInput () const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::PolyLineParametricPath< VDimension >
static Pointer New ()
 

Protected Member Functions

 PolyLineParametricPathWithValue ()
 
virtual ~PolyLineParametricPathWithValue ()
 
virtual void ComputeBoundingRegion () const
 
virtual void ComputeLength () const
 
virtual void Modified () const
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::PolyLineParametricPath< VDimension >
 PolyLineParametricPath ()
 
 ~PolyLineParametricPath ()
 
- Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
 Path ()
 
 ~Path ()
 
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 

Private Member Functions

 PolyLineParametricPathWithValue (const Self &)
 
void operator= (const Self &)
 

Private Attributes

RegionType m_BoundingRegion
 
bool m_BoundingRegionIsValid
 
std::string m_Key
 
double m_Length
 
bool m_LengthIsValid
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
static const unsigned int PathDimension
 

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.
Examples:
FeatureExtraction/ExtractRoadByStepsExample.cxx, and FeatureExtraction/ExtractRoadExample.cxx.

Definition at line 37 of file otbPolyLineParametricPathWithValue.h.

Member Typedef Documentation

template<class TValue, unsigned int VDimension = 2>
typedef itk::SmartPointer<const Self> otb::PolyLineParametricPathWithValue< TValue, VDimension >::ConstPointer

Definition at line 45 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 59 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 65 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
typedef itk::SmartPointer<Self> otb::PolyLineParametricPathWithValue< TValue, VDimension >::Pointer

Definition at line 44 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
typedef otb::RemoteSensingRegion<double> otb::PolyLineParametricPathWithValue< TValue, VDimension >::RegionType

Definition at line 63 of file otbPolyLineParametricPathWithValue.h.

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

Standard typedefs

Definition at line 42 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 64 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
typedef itk::PolyLineParametricPath<VDimension> otb::PolyLineParametricPathWithValue< TValue, VDimension >::Superclass

Definition at line 43 of file otbPolyLineParametricPathWithValue.h.

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

Template parameters typedefs

Definition at line 51 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
typedef VertexListType::ConstIterator otb::PolyLineParametricPathWithValue< TValue, VDimension >::VertexListConstIteratorType

Definition at line 60 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 58 of file otbPolyLineParametricPathWithValue.h.

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

Derived typedefs

Definition at line 57 of file otbPolyLineParametricPathWithValue.h.

Constructor & Destructor Documentation

template<class TValue , unsigned int VDimension>
otb::PolyLineParametricPathWithValue< TValue, VDimension >::PolyLineParametricPathWithValue ( )
protected

Constructor

Definition at line 32 of file otbPolyLineParametricPathWithValue.txx.

References itk::NumericTraits< T >::ZeroValue().

template<class TValue, unsigned int VDimension = 2>
virtual otb::PolyLineParametricPathWithValue< TValue, VDimension >::~PolyLineParametricPathWithValue ( )
inlineprotectedvirtual

Destructor

Definition at line 108 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
otb::PolyLineParametricPathWithValue< TValue, VDimension >::PolyLineParametricPathWithValue ( const Self )
private

Member Function Documentation

template<class TValue , unsigned int VDimension>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::AddVertex ( const ContinuousIndexType vertex)
virtual

Reimplemented in otb::Polygon< TValue >.

Definition at line 43 of file otbPolyLineParametricPathWithValue.txx.

template<class TValue , unsigned int VDimension>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::ComputeBoundingRegion ( ) const
protectedvirtual
template<class TValue , unsigned int VDimension>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::ComputeLength ( ) const
protectedvirtual
template<class TValue, unsigned int VDimension = 2>
virtual::itk::LightObject::Pointer otb::PolyLineParametricPathWithValue< TValue, VDimension >::CreateAnother ( void  ) const
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 120 of file otbPolyLineParametricPathWithValue.txx.

template<class TValue, unsigned int VDimension = 2>
virtual std::string otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetKey ( )
virtual
template<class TValue , unsigned int VDimension>
double otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetLength ( ) const
virtual

Return the path length (perimeter).

Returns
The length.

Reimplemented in otb::Polygon< TValue >.

Definition at line 51 of file otbPolyLineParametricPathWithValue.txx.

template<class TValue, unsigned int VDimension = 2>
virtual const char* otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

Reimplemented from itk::PolyLineParametricPath< VDimension >.

Reimplemented in otb::Polygon< TValue >.

template<class TValue, unsigned int VDimension = 2>
ValueType otb::PolyLineParametricPathWithValue< TValue, VDimension >::GetValue ( void  ) const
inline

Definition at line 75 of file otbPolyLineParametricPathWithValue.h.

template<class TValue , unsigned int VDimension>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::Modified ( void  ) const
protectedvirtual

Reimplemented in otb::Polygon< TValue >.

Definition at line 199 of file otbPolyLineParametricPathWithValue.txx.

template<class TValue, unsigned int VDimension = 2>
static Pointer otb::PolyLineParametricPathWithValue< TValue, VDimension >::New ( )
static

Type macro

template<class TValue, unsigned int VDimension = 2>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::operator= ( const Self )
private
template<class TValue , unsigned int VDimension>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
template<class TValue, unsigned int VDimension = 2>
void otb::PolyLineParametricPathWithValue< TValue, VDimension >::SetValue ( ValueType  value)
inline

Definition at line 69 of file otbPolyLineParametricPathWithValue.h.

Member Data Documentation

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

Definition at line 122 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 123 of file otbPolyLineParametricPathWithValue.h.

template<class TValue, unsigned int VDimension = 2>
std::string otb::PolyLineParametricPathWithValue< TValue, VDimension >::m_Key
private

Definition at line 119 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 120 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 121 of file otbPolyLineParametricPathWithValue.h.


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