Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage > Class Template Reference

Base class for filters that take a SpatialObject as input and produce an image as output. By default, if the user does not specify the size of the output image, the maximum size of the object's bounding box is used. The spacing of the image is given by the spacing of the input Spatial object. More...

#include <otbSpatialObjectToImageDrawingFilter.h>

+ Inheritance diagram for otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >:
+ Collaboration diagram for otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >:

Public Types

typedef
TInputSpatialObject::ChildrenListType 
ChildrenListType
 
typedef
SpatialObjectType::ChildrenListType
ChildrenType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
InputSpatialObjectType::ConstPointer 
InputSpatialObjectConstPointer
 
typedef
InputSpatialObjectType::Pointer 
InputSpatialObjectPointer
 
typedef TInputSpatialObject InputSpatialObjectType
 
typedef
SpatialObjectType::ChildrenListType::iterator 
IteratorType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TOutputImage::PointType PointType
 
typedef
SpatialObjectToImageDrawingFilter 
Self
 
typedef TOutputImage::SizeType SizeType
 
typedef
OutputImageType::SpacingType 
SpacingType
 
typedef itk::SpatialObject
< InputSpatialObjectType::ObjectDimension > 
SpatialObjectType
 
typedef itk::ImageSource
< TOutputImage > 
Superclass
 
typedef OutputImageType::ValueType ValueType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual unsigned int GetChildrenDepth ()
 
const InputSpatialObjectTypeGetInput (void)
 
const InputSpatialObjectTypeGetInput (unsigned int idx)
 
virtual ValueType GetInsideValue ()
 
virtual const char * GetNameOfClass () const
 
virtual const double * GetOrigin () const
 
virtual ValueType GetOutsideValue ()
 
virtual SizeType GetSize ()
 
virtual const double * GetSpacing () const
 
virtual bool GetUseObjectValue ()
 
virtual void SetChildrenDepth (unsigned int _arg)
 
virtual void SetInput (const InputSpatialObjectType *object)
 
virtual void SetInput (unsigned int, const InputSpatialObjectType *object)
 
virtual void SetInsideValue (ValueType _arg)
 
virtual void SetOrigin (const PointType &origin)
 
virtual void SetOrigin (const double *origin)
 
virtual void SetOrigin (const float *origin)
 
virtual void SetOutsideValue (ValueType _arg)
 
virtual void SetSize (SizeType _arg)
 
virtual void SetSpacing (const SpacingType &spacing)
 
virtual void SetSpacing (const double *spacing)
 
virtual void SetSpacing (const float *spacing)
 
virtual void SetUseObjectValue (bool _arg)
 

Static Public Member Functions

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

Static Public Attributes

static const unsigned int ObjectDimension = InputSpatialObjectType::ObjectDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

 SpatialObjectToImageDrawingFilter ()
 
virtual ~SpatialObjectToImageDrawingFilter ()
 
virtual void GenerateData ()
 
virtual void GenerateOutputInformation ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Protected Attributes

unsigned int m_ChildrenDepth
 
ValueType m_InsideValue
 
double m_Origin [OutputImageDimension]
 
ValueType m_OutsideValue
 
SizeType m_Size
 
double m_Spacing [OutputImageDimension]
 
bool m_UseObjectValue
 

Private Member Functions

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

Detailed Description

template<class TInputSpatialObject, class TOutputImage>
class otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >

Base class for filters that take a SpatialObject as input and produce an image as output. By default, if the user does not specify the size of the output image, the maximum size of the object's bounding box is used. The spacing of the image is given by the spacing of the input Spatial object.

Definition at line 37 of file otbSpatialObjectToImageDrawingFilter.h.

Member Typedef Documentation

template<class TInputSpatialObject, class TOutputImage>
typedef TInputSpatialObject::ChildrenListType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::ChildrenListType

Definition at line 65 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SpatialObjectType::ChildrenListType* otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::ChildrenType

Definition at line 132 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef itk::SmartPointer<const Self> otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::ConstPointer

Definition at line 44 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef InputSpatialObjectType::ConstPointer otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectConstPointer

Definition at line 64 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef InputSpatialObjectType::Pointer otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectPointer

Definition at line 63 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TInputSpatialObject otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectType

Some convenient typedefs.

Definition at line 62 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SpatialObjectType::ChildrenListType::iterator otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::IteratorType

Definition at line 133 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::Pointer otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::OutputImagePointer

Definition at line 48 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef Superclass::OutputImageRegionType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Definition at line 56 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::OutputImageType

Definition at line 47 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef itk::SmartPointer<Self> otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::Pointer

Definition at line 43 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage::PointType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::PointType

Definition at line 46 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SpatialObjectToImageDrawingFilter otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::Self

Standard class typedefs.

Definition at line 41 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage::SizeType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SizeType

Definition at line 45 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::SpacingType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SpacingType

Definition at line 50 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef itk::SpatialObject<InputSpatialObjectType::ObjectDimension> otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SpatialObjectType

Definition at line 129 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef itk::ImageSource<TOutputImage> otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::Superclass

Definition at line 42 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::ValueType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::ValueType

Definition at line 49 of file otbSpatialObjectToImageDrawingFilter.h.

Constructor & Destructor Documentation

template<class TInputSpatialObject , class TOutputImage >
otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SpatialObjectToImageDrawingFilter ( )
protected

Constructor

Definition at line 30 of file otbSpatialObjectToImageDrawingFilter.txx.

References m_OutsideValue.

template<class TInputSpatialObject , class TOutputImage >
otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::~SpatialObjectToImageDrawingFilter ( )
protectedvirtual

Destructor

Definition at line 50 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SpatialObjectToImageDrawingFilter ( const Self )
private

Member Function Documentation

template<class TInputSpatialObject, class TOutputImage>
virtual::itk::LightObject::Pointer otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::CreateAnother ( void  ) const
template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GenerateData ( void  )
protectedvirtual

Update

Definition at line 389 of file otbSpatialObjectToImageDrawingFilter.txx.

References m_OutsideValue.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GenerateOutputInformation ( void  )
protectedvirtual

Definition at line 261 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual unsigned int otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetChildrenDepth ( )
virtual
template<class TInputSpatialObject , class TOutputImage >
const SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectType * otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetInput ( void  )

Get the input Spatial Object

Definition at line 81 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
const SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectType * otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetInput ( unsigned int  idx)

Get the input Spatial Object

Definition at line 96 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual ValueType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetInsideValue ( )
virtual
template<class TInputSpatialObject, class TOutputImage>
virtual const char* otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputSpatialObject , class TOutputImage >
const double * otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetOrigin ( void  ) const
virtual

Definition at line 253 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual ValueType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetOutsideValue ( )
virtual
template<class TInputSpatialObject, class TOutputImage>
virtual SizeType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetSize ( )
virtual
template<class TInputSpatialObject , class TOutputImage >
const double * otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetSpacing ( void  ) const
virtual

Definition at line 174 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual bool otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::GetUseObjectValue ( )
virtual
template<class TInputSpatialObject, class TOutputImage>
static Pointer otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::New ( )
static

Method for creation through the object factory.

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

Definition at line 452 of file otbSpatialObjectToImageDrawingFilter.txx.

References m_OutsideValue.

template<class TInputSpatialObject, class TOutputImage>
virtual void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetChildrenDepth ( unsigned int  _arg)
virtual

The spatial object being transformed can be part of a hierarchy. How deep in the hierarchy should we descend in generating the image? A ChildrenDepth of 0 means to only include the object itself.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetInput ( const InputSpatialObjectType input)
virtual

Set/Get the image input of this process object.

Set the Input SpatialObject

Definition at line 58 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetInput ( unsigned int  index,
const InputSpatialObjectType object 
)
virtual

Connect one of the operands

Definition at line 70 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetInsideValue ( ValueType  _arg)
virtual

Set/Get the value for pixels inside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const PointType origin)
virtual

The origin of the output image. The origin is the geometric coordinates of the index (0, 0, ..., 0). It is stored internally as double but may be set from float.

See Also
GetOrigin()

Definition at line 183 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const double *  origin)
virtual

Definition at line 207 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const float *  origin)
virtual

Definition at line 230 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetOutsideValue ( ValueType  _arg)
virtual

Set/Get the value for pixels outside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject, class TOutputImage>
virtual void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetSize ( SizeType  _arg)
virtual

Set/Get Size

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const SpacingType spacing)
virtual

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See Also
GetSpacing()

Definition at line 106 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const double *  spacing)
virtual

Definition at line 130 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject , class TOutputImage >
void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const float *  spacing)
virtual

Definition at line 152 of file otbSpatialObjectToImageDrawingFilter.txx.

template<class TInputSpatialObject, class TOutputImage>
virtual void otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::SetUseObjectValue ( bool  _arg)
virtual

If UseObjectValue is set to true, then the filter uses the ValueAt() function instead of IsInside()

Member Data Documentation

template<class TInputSpatialObject, class TOutputImage>
unsigned int otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_ChildrenDepth
protected

Definition at line 145 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
ValueType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_InsideValue
protected

Definition at line 146 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
double otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_Origin[OutputImageDimension]
protected

Definition at line 144 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
ValueType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_OutsideValue
protected

Definition at line 147 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
SizeType otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_Size
protected

Definition at line 142 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
double otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_Spacing[OutputImageDimension]
protected

Definition at line 143 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
bool otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::m_UseObjectValue
protected

Definition at line 148 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
const unsigned int otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::ObjectDimension = InputSpatialObjectType::ObjectDimension
static

ImageDimension constants

Definition at line 69 of file otbSpatialObjectToImageDrawingFilter.h.

template<class TInputSpatialObject, class TOutputImage>
const unsigned int otb::SpatialObjectToImageDrawingFilter< TInputSpatialObject, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

Definition at line 71 of file otbSpatialObjectToImageDrawingFilter.h.


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