OTB  5.0.0
Orfeo Toolbox
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

#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::ParametricPath< VDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< SpacePrecisionType,
VDimension > 
ContinuousIndexType
 
typedef Index< VDimension > IndexType
 
typedef Superclass::InputType InputType
 
typedef Offset< VDimension > OffsetType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef ParametricPath Self
 
typedef Path< double,
ContinuousIndexType,
VDimension > 
Superclass
 
typedef Vector< double,
VDimension > 
VectorType
 
- 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 Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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 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::ParametricPath< VDimension >
virtual VectorType EvaluateDerivative (const InputType &input) const
 
virtual IndexType EvaluateToIndex (const InputType &input) const
 
virtual const InputTypeGetDefaultInputStepSize () const
 
virtual OffsetType IncrementInput (InputType &input) const
 
virtual void SetDefaultInputStepSize (InputType _arg)
 
- Public Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual OutputType Evaluate (const InputType &input) const =0
 
virtual IndexType EvaluateToIndex (const InputType &input) const =0
 
virtual OffsetType IncrementInput (InputType &input) const =0
 
virtual InputType StartOfInput () const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::PolyLineParametricPath< VDimension >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void ComputeBoundingRegion () const
 
virtual void ComputeLength () const
 
virtual void Modified () const
 
virtual ~PolyLineParametricPathWithValue ()
 
 PolyLineParametricPathWithValue ()
 
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::ParametricPath< VDimension >
 ParametricPath ()
 
 ~ParametricPath ()
 
- Protected Member Functions inherited from itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 
 Path ()
 
 ~Path ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &)
 
 PolyLineParametricPathWithValue (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
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ParametricPath< VDimension >
InputType m_DefaultInputStepSize
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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 38 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 46 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 60 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 66 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 45 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 64 of file otbPolyLineParametricPathWithValue.h.

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

Standard typedefs

Definition at line 43 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 65 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 44 of file otbPolyLineParametricPathWithValue.h.

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

Template parameters typedefs

Definition at line 52 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 61 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 59 of file otbPolyLineParametricPathWithValue.h.

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

Derived typedefs

Definition at line 58 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 110 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 44 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
virtual
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 122 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 52 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 76 of file otbPolyLineParametricPathWithValue.h.

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

Reimplemented from itk::Object.

Reimplemented in otb::Polygon< TValue >.

Definition at line 201 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 70 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 125 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 126 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 122 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 123 of file otbPolyLineParametricPathWithValue.h.

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

Definition at line 124 of file otbPolyLineParametricPathWithValue.h.


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