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::ImageToEdgePathFilter< TInputImage, TOutputPath > Class Template Reference

#include <otbImageToEdgePathFilter.h>

+ Inheritance diagram for otb::ImageToEdgePathFilter< TInputImage, TOutputPath >:
+ Collaboration diagram for otb::ImageToEdgePathFilter< TInputImage, TOutputPath >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
OutputPathType::ContinuousIndexType 
ContinuousIndexType
 
typedef
Superclass::InputImagePointerType 
InputImagePointerType
 
typedef Superclass::InputImageType InputImageType
 
typedef
Superclass::OutputPathPointerType 
OutputPathPointerType
 
typedef Superclass::OutputPathType OutputPathType
 
typedef InputImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageToEdgePathFilter Self
 
typedef ImageToPathFilter
< TInputImage, TOutputPath > 
Superclass
 
- Public Types inherited from otb::ImageToPathFilter< TInputImage, TOutputPath >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputImageType::Pointer InputImagePointerType
 
typedef TInputImage InputImageType
 
typedef OutputPathType::Pointer OutputPathPointerType
 
typedef TOutputPath OutputPathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef ImageToPathFilter Self
 
typedef itk::PathSource
< TOutputPath > 
Superclass
 
- Public Types inherited from itk::PathSource< TOutputPath >
typedef SmartPointer< const SelfConstPointer
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputPathType::IndexType OutputPathIndexType
 
typedef OutputPathType::InputType OutputPathInputType
 
typedef OutputPathType::OffsetType OutputPathOffsetType
 
typedef OutputPathType::OutputType OutputPathOutputType
 
typedef OutputPathType::Pointer OutputPathPointer
 
typedef TOutputFourierSeriesPath OutputPathType
 
typedef SmartPointer< SelfPointer
 
typedef PathSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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 ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetForegroundValue (PixelType _arg)
 
virtual PixelType GetForegroundValue () const
 
- Public Member Functions inherited from otb::ImageToPathFilter< TInputImage, TOutputPath >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetInput (void)
 
virtual void SetInput (const InputImageType *Image)
 
- Public Member Functions inherited from itk::PathSource< TOutputPath >
OutputPathTypeGetOutput (unsigned int idx)
 
OutputPathTypeGetOutput (void)
 
virtual void GraftNthOutput (unsigned int idx, OutputPathType *output)
 
virtual void GraftOutput (OutputPathType *output)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) ITK_OVERRIDE
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- 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 Modified () 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 otb::ImageToPathFilter< TInputImage, TOutputPath >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::PathSource< TOutputPath >
static Pointer New ()
 
- 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 GenerateData ()
 
virtual void GenerateOutputInformation ()
 
 ImageToEdgePathFilter ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
virtual ~ImageToEdgePathFilter ()
 
- Protected Member Functions inherited from otb::ImageToPathFilter< TInputImage, TOutputPath >
 ImageToPathFilter ()
 
virtual ~ImageToPathFilter ()
 
- Protected Member Functions inherited from itk::PathSource< TOutputPath >
 PathSource ()
 
virtual ~PathSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- 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

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

Private Attributes

PixelType m_ForegroundValue
 

Additional Inherited Members

- Static Public Attributes inherited from otb::ImageToPathFilter< TInputImage, TOutputPath >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

template<class TInputImage, class TOutputPath>
class otb::ImageToEdgePathFilter< TInputImage, TOutputPath >

This filter compute the closed edge path of a labelled object in an image (for example coming from a segmentation filter). Its output is a Path.

The input image is first surrounded by a 1 pixel wide border-line using the ConstantPadImageFilter in order to deal with stuck-to-the-border objects. The padding constant is chosen as regard to the ForegroundValue (label of the object) to avoid confusion on foreground and background values.

The edge computation is divided into two steps.

First, a linear search is perfomed to detect a first pixel belonging to the edge of the object.

From that pixel and until the algorithm comes back to this position, the neighborhood is iteratively and clock-wise searched to detect the next pixel in the edge.

In case of linear object (in fact open edge), the algorithm will walk the object twice in opposite directions, thus producing an edge with a null surface and twice the length of the object as perimeter.

This leads to consistant result for geometric descriptors (for instance compacity).

See Also
ImageToPathFilter

Definition at line 55 of file otbImageToEdgePathFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputPath >
typedef itk::SmartPointer<const Self> otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::ConstPointer

Definition at line 63 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef OutputPathType::ContinuousIndexType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::ContinuousIndexType

Definition at line 75 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::InputImagePointerType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::InputImagePointerType

Definition at line 72 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::InputImageType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::InputImageType

Template parameters typedef.

Definition at line 68 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::OutputPathPointerType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::OutputPathPointerType

Definition at line 74 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::OutputPathType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::OutputPathType

Definition at line 73 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef InputImageType::PixelType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::PixelType

Definition at line 77 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef itk::SmartPointer<Self> otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::Pointer

Definition at line 62 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef ImageToEdgePathFilter otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::Self

standards typedefs

Definition at line 60 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
typedef ImageToPathFilter<TInputImage, TOutputPath> otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::Superclass

Definition at line 61 of file otbImageToEdgePathFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputPath >
otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::ImageToEdgePathFilter ( )
protected

Definition at line 34 of file otbImageToEdgePathFilter.txx.

template<class TInputImage , class TOutputPath >
virtual otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::~ImageToEdgePathFilter ( )
inlineprotectedvirtual

Definition at line 86 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::ImageToEdgePathFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputPath >
virtual::itk::LightObject::Pointer otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::PathSource< TOutputPath >.

template<class TInputImage , class TOutputPath >
void otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::GenerateData ( void  )
protectedvirtual

Main computation method.

Reimplemented from itk::ProcessObject.

Definition at line 44 of file otbImageToEdgePathFilter.txx.

References otbMsgDebugMacro.

template<class TInputImage , class TOutputPath >
virtual void otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::GenerateOutputInformation ( void  )
inlineprotectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 88 of file otbImageToEdgePathFilter.h.

template<class TInputImage , class TOutputPath >
virtual PixelType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::GetForegroundValue ( ) const
virtual

Set and Get foreground value

template<class TInputImage , class TOutputPath >
virtual const char* otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::GetNameOfClass ( ) const
virtual

Runtime information.

Reimplemented from otb::ImageToPathFilter< TInputImage, TOutputPath >.

template<class TInputImage , class TOutputPath >
static Pointer otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::New ( )
static

Creation through the object factory.

template<class TInputImage , class TOutputPath >
void otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::operator= ( const Self )
private
template<class TInputImage , class TOutputPath >
void otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

PrintSelf Method.

Reimplemented from otb::ImageToPathFilter< TInputImage, TOutputPath >.

Definition at line 207 of file otbImageToEdgePathFilter.txx.

template<class TInputImage , class TOutputPath >
virtual void otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::SetForegroundValue ( PixelType  _arg)
virtual

Set and Get foreground value

Member Data Documentation

template<class TInputImage , class TOutputPath >
PixelType otb::ImageToEdgePathFilter< TInputImage, TOutputPath >::m_ForegroundValue
private

Definition at line 95 of file otbImageToEdgePathFilter.h.


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