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::DrawPathFilter< TInputImage, TInputPath, TOutputImage > Class Template Reference

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

#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< SelfPointer
 
typedef DrawPathFilter Self
 
typedef
itk::ImageAndPathToImageFilter
< TInputImage, TInputPath,
TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
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::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageAndPathToImageFilter Self
 
typedef ImageToImageFilter
< TInputImage, 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 ()
 
void SetInputPath (const TInputPath *path)
 
virtual void SetValue (OutputImagePixelType _arg)
 
- Public Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetImageInput (void)
 
const InputPathTypeGetPathInput (void)
 
virtual void SetImageInput (const TInputImage *image)
 
virtual void SetPathInput (const TInputPath *path)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 DrawPathFilter ()
 
virtual ~DrawPathFilter ()
 
virtual void GenerateData ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
 ImageAndPathToImageFilter ()
 
virtual ~ImageAndPathToImageFilter ()
 
InputImageTypeGetNonConstImageInput (void)
 
InputPathTypeGetNonConstPathInput (void)
 

Private Member Functions

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

Private Attributes

OutputImagePixelType m_Value
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

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 41 of file otbDrawPathFilter.h.

Member Typedef Documentation

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

Definition at line 48 of file otbDrawPathFilter.h.

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

Definition at line 59 of file otbDrawPathFilter.h.

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

Definition at line 61 of file otbDrawPathFilter.h.

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

Definition at line 58 of file otbDrawPathFilter.h.

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

Definition at line 60 of file otbDrawPathFilter.h.

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

Some convenient typedefs.

Definition at line 54 of file otbDrawPathFilter.h.

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

Definition at line 64 of file otbDrawPathFilter.h.

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

Definition at line 67 of file otbDrawPathFilter.h.

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

Definition at line 65 of file otbDrawPathFilter.h.

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

Definition at line 68 of file otbDrawPathFilter.h.

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

Definition at line 66 of file otbDrawPathFilter.h.

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

Definition at line 63 of file otbDrawPathFilter.h.

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

Definition at line 62 of file otbDrawPathFilter.h.

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

Definition at line 71 of file otbDrawPathFilter.h.

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

Definition at line 74 of file otbDrawPathFilter.h.

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

Definition at line 70 of file otbDrawPathFilter.h.

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

Definition at line 73 of file otbDrawPathFilter.h.

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

Definition at line 69 of file otbDrawPathFilter.h.

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

Definition at line 75 of file otbDrawPathFilter.h.

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

Definition at line 47 of file otbDrawPathFilter.h.

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

Standard class typedefs.

Definition at line 45 of file otbDrawPathFilter.h.

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

Definition at line 46 of file otbDrawPathFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::DrawPathFilter ( )
protected

Constructor

Definition at line 32 of file otbDrawPathFilter.txx.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::~DrawPathFilter ( )
inlineprotectedvirtual

Definition at line 88 of file otbDrawPathFilter.h.

template<class TInputImage , class TInputPath , class TOutputImage >
otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::DrawPathFilter ( const Self )
private

Member Function Documentation

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

Main computation method.

Definition at line 57 of file otbDrawPathFilter.txx.

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

Definition at line 46 of file otbDrawPathFilter.txx.

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

Reimplemented from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >.

template<class TInputImage , class TInputPath , class TOutputImage >
virtual const OutputImagePixelType& otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::GetValue ( )
virtual
template<class TInputImage , class TInputPath , class TOutputImage >
static Pointer otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::New ( )
static

Method for creation through the object factory.

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

Printself Method

Reimplemented from itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage >.

Definition at line 80 of file otbDrawPathFilter.txx.

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 39 of file otbDrawPathFilter.txx.

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

Member Data Documentation

template<class TInputImage , class TInputPath , class TOutputImage >
OutputImagePixelType otb::DrawPathFilter< TInputImage, TInputPath, TOutputImage >::m_Value
private

Definition at line 97 of file otbDrawPathFilter.h.


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