OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage > Class Template Reference

#include <otbDrawPathListFilter.h>

+ Inheritance diagram for otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >:
+ Collaboration diagram for otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::ConstPointer InputImageConstPointerType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointerType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef TInputImage InputImageType
 
typedef InputImageType::ValueType InputImageValueType
 
typedef InputPathListType::ConstPointer InputPathListConstPointerType
 
typedef InputPathListType::Pointer InputPathListPointerType
 
typedef otb::ObjectList< InputPathTypeInputPathListType
 
typedef InputPathType::Pointer InputPathPointerType
 
typedef TInputPath InputPathType
 
typedef OutputImageType::ConstPointer OutputImageConstPointerType
 
typedef OutputImageType::IndexType OutputImageIndexType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::SizeType OutputImageSizeType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::ValueType OutputImageValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef DrawPathListFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual void AddValueOff ()
 
virtual void AddValueOn ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual bool GetAddValue ()
 
virtual const char * GetNameOfClass () const
 
virtual OutputImagePixelType GetPathValue ()
 
virtual bool GetUseInternalPathValue ()
 
virtual void SetAddValue (bool _arg)
 
virtual void SetPathValue (OutputImagePixelType _arg)
 
virtual void SetUseInternalPathValue (bool _arg)
 
virtual void UseInternalPathValueOff ()
 
virtual void UseInternalPathValueOn ()
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
OutputImagePixelType m_PathValue
 
bool m_UseInternalPathValue
 
bool m_AddValue
 
virtual void SetInputPath (InputPathListType *path)
 
const InputPathListTypeGetInputPath (void)
 
 DrawPathListFilter ()
 
 ~DrawPathListFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateData () override
 
 DrawPathListFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TInputPath, class TOutputImage>
class otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >

This class can be used to draw a list of path on an image.

This filter first copy the input image to the output, with default casting operators. It then uses the otb::PolyLineImageIterator to draw each polyline. This iterator uses the general Bresenham algorithm known to be efficient in segment drawing.

If the UsePathInternalValue is toggled, the filter check if the metadata dictionary of the input path has a "Value" key. If it is the case, it will use this value to draw the Path instead of the default value. If not, it will use the default value.

See also
PolyLineParametricPathWithValue
MetaDataDictionary

Definition at line 50 of file otbDrawPathListFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::ConstPointer

Definition at line 57 of file otbDrawPathListFilter.h.

◆ InputImageConstPointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::ConstPointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageConstPointerType

Definition at line 68 of file otbDrawPathListFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::PixelType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImagePixelType

Definition at line 70 of file otbDrawPathListFilter.h.

◆ InputImagePointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImagePointerType

Definition at line 67 of file otbDrawPathListFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::RegionType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageRegionType

Definition at line 69 of file otbDrawPathListFilter.h.

◆ InputImageSizeType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::SizeType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageSizeType

Definition at line 71 of file otbDrawPathListFilter.h.

◆ InputImageType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TInputImage otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 63 of file otbDrawPathListFilter.h.

◆ InputImageValueType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputImageType::ValueType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageValueType

Definition at line 72 of file otbDrawPathListFilter.h.

◆ InputPathListConstPointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathListType::ConstPointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathListConstPointerType

Definition at line 77 of file otbDrawPathListFilter.h.

◆ InputPathListPointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathListType::Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathListPointerType

Definition at line 78 of file otbDrawPathListFilter.h.

◆ InputPathListType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef otb::ObjectList<InputPathType> otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathListType

Definition at line 76 of file otbDrawPathListFilter.h.

◆ InputPathPointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef InputPathType::Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathPointerType

Definition at line 75 of file otbDrawPathListFilter.h.

◆ InputPathType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TInputPath otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathType

Definition at line 74 of file otbDrawPathListFilter.h.

◆ OutputImageConstPointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::ConstPointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageConstPointerType

Definition at line 82 of file otbDrawPathListFilter.h.

◆ OutputImageIndexType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::IndexType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageIndexType

Definition at line 87 of file otbDrawPathListFilter.h.

◆ OutputImagePixelType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::PixelType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePixelType

Definition at line 84 of file otbDrawPathListFilter.h.

◆ OutputImagePointerType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePointerType

Definition at line 81 of file otbDrawPathListFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::RegionType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageRegionType

Definition at line 83 of file otbDrawPathListFilter.h.

◆ OutputImageSizeType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::SizeType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageSizeType

Definition at line 85 of file otbDrawPathListFilter.h.

◆ OutputImageType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef TOutputImage otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageType

Definition at line 80 of file otbDrawPathListFilter.h.

◆ OutputImageValueType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef OutputImageType::ValueType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::OutputImageValueType

Definition at line 86 of file otbDrawPathListFilter.h.

◆ Pointer

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::SmartPointer<Self> otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::Pointer

Definition at line 56 of file otbDrawPathListFilter.h.

◆ ProcessObjectType

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::ProcessObject otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::ProcessObjectType

Definition at line 89 of file otbDrawPathListFilter.h.

◆ Self

template<class TInputImage , class TInputPath , class TOutputImage >
typedef DrawPathListFilter otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::Self

Standard class typedefs.

Definition at line 54 of file otbDrawPathListFilter.h.

◆ Superclass

template<class TInputImage , class TInputPath , class TOutputImage >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::Superclass

Definition at line 55 of file otbDrawPathListFilter.h.

Constructor & Destructor Documentation

◆ DrawPathListFilter() [1/2]

template<class TInputImage , class TInputPath , class TOutputImage >
otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::DrawPathListFilter
protected

Constructor

Definition at line 37 of file otbDrawPathListFilter.hxx.

◆ ~DrawPathListFilter()

template<class TInputImage , class TInputPath , class TOutputImage >
otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::~DrawPathListFilter ( )
inlineoverrideprotected

Destructor

Definition at line 115 of file otbDrawPathListFilter.h.

◆ DrawPathListFilter() [2/2]

template<class TInputImage , class TInputPath , class TOutputImage >
otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::DrawPathListFilter ( const Self )
privatedelete

Default value to draw

Member Function Documentation

◆ AddValueOff()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::AddValueOff ( )
virtual

◆ AddValueOn()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::AddValueOn ( )
virtual

◆ CreateAnother()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual::itk::LightObject::Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GenerateData
overrideprotected

Main computation method

Definition at line 68 of file otbDrawPathListFilter.hxx.

◆ GetAddValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual bool otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GetAddValue ( )
virtual

◆ GetInputPath()

template<class TInputImage , class TInputPath , class TOutputImage >
const DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputPathListType * otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GetInputPath ( void  )

Default value to draw

Definition at line 55 of file otbDrawPathListFilter.hxx.

◆ GetNameOfClass()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual const char* otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetPathValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual OutputImagePixelType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GetPathValue ( )
virtual

◆ GetUseInternalPathValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual bool otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::GetUseInternalPathValue ( )
virtual

◆ New()

template<class TInputImage , class TInputPath , class TOutputImage >
static Pointer otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::operator= ( const Self )
privatedelete

Default value to draw

◆ PrintSelf()

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Printself method

Definition at line 123 of file otbDrawPathListFilter.hxx.

◆ SetAddValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::SetAddValue ( bool  _arg)
virtual

◆ SetInputPath()

template<class TInputImage , class TInputPath , class TOutputImage >
void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::SetInputPath ( InputPathListType path)
virtual

Set/Get the path input of this process object.

Definition at line 48 of file otbDrawPathListFilter.hxx.

◆ SetPathValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::SetPathValue ( OutputImagePixelType  _arg)
virtual

◆ SetUseInternalPathValue()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::SetUseInternalPathValue ( bool  _arg)
virtual

◆ UseInternalPathValueOff()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::UseInternalPathValueOff ( )
virtual

◆ UseInternalPathValueOn()

template<class TInputImage , class TInputPath , class TOutputImage >
virtual void otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::UseInternalPathValueOn ( )
virtual

Member Data Documentation

◆ InputImageDimension

template<class TInputImage , class TInputPath , class TOutputImage >
const unsigned int otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 103 of file otbDrawPathListFilter.h.

◆ m_AddValue

template<class TInputImage , class TInputPath , class TOutputImage >
bool otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::m_AddValue
private

Default value to draw

Definition at line 135 of file otbDrawPathListFilter.h.

◆ m_PathValue

template<class TInputImage , class TInputPath , class TOutputImage >
OutputImagePixelType otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::m_PathValue
private

Default value to draw

Definition at line 130 of file otbDrawPathListFilter.h.

◆ m_UseInternalPathValue

template<class TInputImage , class TInputPath , class TOutputImage >
bool otb::DrawPathListFilter< TInputImage, TInputPath, TOutputImage >::m_UseInternalPathValue
private

If set to true, the algorithm try to use path internal metadata dictionary value

Definition at line 133 of file otbDrawPathListFilter.h.


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