otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage > Class Template Reference

#include <otbDrawPathFilter.h>

Inheritance diagram for otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >:

Collaboration diagram for otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef InputPathType::ConstPointer	InputPathConstPointer
typedef InputPathType::IndexType	InputPathIndexType
typedef InputPathType::InputType	InputPathInputType
typedef InputPathType::OffsetType	InputPathOffsetType
typedef InputPathType::OutputType	InputPathOutputType
typedef InputPathType::Pointer	InputPathPointer
typedef TInputPath	InputPathType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::ValueType	OutputImageValueType
typedef itk::SmartPointer< Self >	Pointer
typedef DrawPathFilter	Self
typedef itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const TInputPath *	GetInputPath (void)
virtual const char *	GetNameOfClass () const
virtual const OutputImagePixelType &	GetValue () const
void	SetInputPath (const TInputPath *path)
virtual void	SetValue (OutputImagePixelType _arg)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	DrawPathFilter ()
	~DrawPathFilter () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateData () override

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

Private Attributes
OutputImagePixelType	m_Value

Detailed Description

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

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

It encapsulates the use of the otb::DrawPathListFilter by internally creating an otb::ObjectList<TInputPath> of size one and passing it to a DrawPathListFilter.

Please note that iterating this filter to draw several path is NOT efficient. If you have several path to draw, consider using the otb::DrawPathListFilter.

See also

DrawPathListFilter

Definition at line 46 of file otbDrawPathFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::ConstPointer

Definition at line 53 of file otbDrawPathFilter.h.

InputImageConstPointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputImageType::ConstPointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageConstPointer

Definition at line 64 of file otbDrawPathFilter.h.

InputImagePixelType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputImageType::PixelType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputImagePixelType

Definition at line 66 of file otbDrawPathFilter.h.

InputImagePointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputImageType::Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputImagePointer

Definition at line 63 of file otbDrawPathFilter.h.

InputImageRegionType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputImageType::RegionType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageRegionType

Definition at line 65 of file otbDrawPathFilter.h.

InputImageType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef TInputImage otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 59 of file otbDrawPathFilter.h.

InputPathConstPointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::ConstPointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathConstPointer

Definition at line 69 of file otbDrawPathFilter.h.

InputPathIndexType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::IndexType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathIndexType

Definition at line 72 of file otbDrawPathFilter.h.

InputPathInputType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::InputType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathInputType

Definition at line 70 of file otbDrawPathFilter.h.

InputPathOffsetType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::OffsetType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathOffsetType

Definition at line 73 of file otbDrawPathFilter.h.

InputPathOutputType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::OutputType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathOutputType

Definition at line 71 of file otbDrawPathFilter.h.

InputPathPointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef InputPathType::Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathPointer

Definition at line 68 of file otbDrawPathFilter.h.

InputPathType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef TInputPath otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::InputPathType

Definition at line 67 of file otbDrawPathFilter.h.

OutputImageConstPointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef OutputImageType::ConstPointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageConstPointer

Definition at line 76 of file otbDrawPathFilter.h.

OutputImagePixelType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef OutputImageType::PixelType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePixelType

Definition at line 79 of file otbDrawPathFilter.h.

OutputImagePointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef OutputImageType::Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImagePointer

Definition at line 75 of file otbDrawPathFilter.h.

OutputImageRegionType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef OutputImageType::RegionType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageRegionType

Definition at line 78 of file otbDrawPathFilter.h.

OutputImageType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef TOutputImage otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageType

Definition at line 74 of file otbDrawPathFilter.h.

OutputImageValueType

template<class TInputImage , class TInputPath , class TOutputImage >

typedef OutputImageType::ValueType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::OutputImageValueType

Definition at line 80 of file otbDrawPathFilter.h.

Pointer

template<class TInputImage , class TInputPath , class TOutputImage >

typedef itk::SmartPointer<Self> otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::Pointer

Definition at line 52 of file otbDrawPathFilter.h.

Self

template<class TInputImage , class TInputPath , class TOutputImage >

typedef DrawPathFilter otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::Self

Standard class typedefs.

Definition at line 50 of file otbDrawPathFilter.h.

Superclass

template<class TInputImage , class TInputPath , class TOutputImage >

typedef itk::ImageAndPathToImageFilter<TInputImage, TInputPath, TOutputImage> otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::Superclass

Definition at line 51 of file otbDrawPathFilter.h.

Constructor & Destructor Documentation

DrawPathFilter() [1/2]

template<class TInputImage , class TInputPath , class TOutputImage >

otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::DrawPathFilter

protected

Constructor

Definition at line 34 of file otbDrawPathFilter.hxx.

~DrawPathFilter()

template<class TInputImage , class TInputPath , class TOutputImage >

otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::~DrawPathFilter ( )

inlineoverrideprotected

Definition at line 93 of file otbDrawPathFilter.h.

DrawPathFilter() [2/2]

template<class TInputImage , class TInputPath , class TOutputImage >

otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::DrawPathFilter ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

template<class TInputImage , class TInputPath , class TOutputImage >

virtual::itk::LightObject::Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::CreateAnother

(

void

)

const

GenerateData()

template<class TInputImage , class TInputPath , class TOutputImage >

void otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::GenerateData

overrideprotected

Main computation method.

Definition at line 55 of file otbDrawPathFilter.hxx.

GetInputPath()

template<class TInputImage , class TInputPath , class TOutputImage >

const TInputPath * otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::GetInputPath

(

void

)

Definition at line 46 of file otbDrawPathFilter.hxx.

GetNameOfClass()

template<class TInputImage , class TInputPath , class TOutputImage >

virtual const char* otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetValue()

template<class TInputImage , class TInputPath , class TOutputImage >

virtual const OutputImagePixelType& otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::GetValue ( ) const

virtual

New()

template<class TInputImage , class TInputPath , class TOutputImage >

static Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TInputPath , class TOutputImage >

void otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::operator= ( const Self &  )

privatedelete

PrintSelf()

template<class TInputImage , class TInputPath , class TOutputImage >

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

overrideprotected

Printself Method

Definition at line 77 of file otbDrawPathFilter.hxx.

SetInputPath()

template<class TInputImage , class TInputPath , class TOutputImage >

void otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::SetInputPath ( const TInputPath *  path )

inline

Set/Get the path input of this process object. Note: these methods are adding to get the proper name

Definition at line 40 of file otbDrawPathFilter.hxx.

SetValue()

template<class TInputImage , class TInputPath , class TOutputImage >

virtual void otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::SetValue ( OutputImagePixelType  _arg )

virtual

Member Data Documentation

m_Value

template<class TInputImage , class TInputPath , class TOutputImage >

OutputImagePixelType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::m_Value

private

Definition at line 104 of file otbDrawPathFilter.h.

---

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

• otbDrawPathFilter.h
• otbDrawPathFilter.hxx