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

Base class used to implement filter to model regions by rectangles. More...

#include <otbRegionImageToRectangularPathListFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::Pointer InputImagePointer
 
typedef
Superclass::InputImageRegionType 
InputImageRegionType
 
typedef Superclass::InputImageType InputImageType
 
typedef
Superclass::OutputPathListType 
OutputPathListType
 
typedef
Superclass::OutputPathPointerType 
OutputPathPointerType
 
typedef Superclass::OutputPathType OutputPathType
 
typedef InputImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef otb::Image< RealType,
InputImageDimension
RealImageType
 
typedef RealImageType::IndexType RealImageTypeIndexType
 
typedef RealImageType::Pointer RealImageTypePointer
 
typedef double RealType
 
typedef
RegionImageToRectangularPathListFilter 
Self
 
typedef InputImageType::SizeType SizeType
 
typedef ImageToPathListFilter
< TInputImage, TOutputPath > 
Superclass
 
typedef InputImageType::ValueType ValueType
 
- Public Types inherited from otb::ImageToPathListFilter< TInputImage, TOutputPath >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputPathListType 
OutputPathListType
 
typedef
Superclass::OutputPathPointerType 
OutputPathPointerType
 
typedef Superclass::OutputPathType OutputPathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef ImageToPathListFilter Self
 
typedef InputImageType::SizeType SizeType
 
typedef PathListSource
< TOutputPath > 
Superclass
 
typedef InputImageType::ValueType ValueType
 
- Public Types inherited from otb::PathListSource< TOutputPath >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef
OutputPathListType::ConstPointer 
OutputPathListConstPointerType
 
typedef OutputPathListType::Pointer OutputPathListPointerType
 
typedef Superclass::OutputListType OutputPathListType
 
typedef OutputPathType::Pointer OutputPathPointerType
 
typedef TOutputPath OutputPathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PathListSource Self
 
typedef ObjectListSource
< ObjectList< TOutputPath > > 
Superclass
 
- Public Types inherited from otb::ObjectListSource< ObjectList< TOutputPath > >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef ObjectList
< TOutputPath >::Pointer 
OutputListPointer
 
typedef ObjectList< TOutputPath > OutputListType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ObjectListSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const double & GetMinimumFit ()
 
virtual const double & GetMinimumSize ()
 
virtual const char * GetNameOfClass () const
 
virtual void SetMinimumFit (double _arg)
 
virtual void SetMinimumSize (double _arg)
 
- Public Member Functions inherited from otb::ImageToPathListFilter< TInputImage, TOutputPath >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputImageTypeGetInput (void)
 
virtual void SetInput (const InputImageType *image)
 
- Public Member Functions inherited from otb::PathListSource< TOutputPath >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
- Public Member Functions inherited from otb::ObjectListSource< ObjectList< TOutputPath > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputListTypeGetOutput (void)
 
OutputListTypeGetOutput (unsigned int idx)
 
void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 
void GraftOutput (itk::DataObject *graft)
 
virtual DataObjectPointer MakeOutput (unsigned int idx)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageToPathListFilter< TInputImage, TOutputPath >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::PathListSource< TOutputPath >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::ObjectListSource< ObjectList< TOutputPath > >
static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int NDimensions = TInputImage::ImageDimension
 
- Static Public Attributes inherited from otb::ImageToPathListFilter< TInputImage, TOutputPath >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Types

typedef Image< unsigned char,
itkGetStaticConstMacro(NDimensions)> 
MarkerImageType
 

Protected Member Functions

 RegionImageToRectangularPathListFilter ()
 
virtual ~RegionImageToRectangularPathListFilter ()
 
virtual void GenerateData ()
 
virtual void GenerateOutputInformation ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::ImageToPathListFilter< TInputImage, TOutputPath >
 ImageToPathListFilter ()
 
virtual ~ImageToPathListFilter ()
 
- Protected Member Functions inherited from otb::PathListSource< TOutputPath >
 PathListSource ()
 
virtual ~PathListSource ()
 
- Protected Member Functions inherited from otb::ObjectListSource< ObjectList< TOutputPath > >
 ObjectListSource ()
 
virtual ~ObjectListSource ()
 
virtual void AllocateOutputs ()
 

Protected Attributes

int m_CrossTermFormula
 
double m_MinimumFit
 
double m_MinimumSize
 
MarkerImageType::Pointer markerImage
 

Private Member Functions

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

Detailed Description

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

Base class used to implement filter to model regions by rectangles.

Definition at line 39 of file otbRegionImageToRectangularPathListFilter.h.

Member Typedef Documentation

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

Definition at line 46 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef InputImageType::ConstPointer otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::InputImageConstPointer

Definition at line 65 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef InputImageType::Pointer otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::InputImagePointer

Definition at line 64 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::InputImageRegionType otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::InputImageRegionType

Definition at line 63 of file otbRegionImageToRectangularPathListFilter.h.

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

Definition at line 62 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions)> otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::MarkerImageType
protected

Definition at line 112 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef Superclass::OutputPathListType otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::OutputPathListType

Some convenient typedefs.

Definition at line 60 of file otbRegionImageToRectangularPathListFilter.h.

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

Definition at line 73 of file otbRegionImageToRectangularPathListFilter.h.

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

Definition at line 71 of file otbRegionImageToRectangularPathListFilter.h.

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

Definition at line 69 of file otbRegionImageToRectangularPathListFilter.h.

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

Definition at line 45 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef otb::Image<RealType, InputImageDimension> otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::RealImageType

Definition at line 79 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef RealImageType::IndexType otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::RealImageTypeIndexType

Definition at line 81 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef RealImageType::Pointer otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::RealImageTypePointer

Definition at line 80 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef double otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::RealType

Definition at line 77 of file otbRegionImageToRectangularPathListFilter.h.

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

Standard class typedefs.

Definition at line 43 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef InputImageType::SizeType otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::SizeType

Definition at line 67 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef ImageToPathListFilter<TInputImage, TOutputPath> otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::Superclass

Definition at line 44 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
typedef InputImageType::ValueType otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::ValueType

Definition at line 68 of file otbRegionImageToRectangularPathListFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 48 of file otbRegionImageToRectangularPathListFilter.txx.

template<class TInputImage , class TOutputPath >
otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::~RegionImageToRectangularPathListFilter ( )
protectedvirtual

Destructor

Definition at line 58 of file otbRegionImageToRectangularPathListFilter.txx.

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

Member Function Documentation

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

ObjectListSource can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See Also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

GenerateData

Reimplemented from otb::ObjectListSource< ObjectList< TOutputPath > >.

Definition at line 67 of file otbRegionImageToRectangularPathListFilter.txx.

References otb::ObjectList< TObject >::Clear(), itk::NumericTraits< T >::max(), otb::ObjectList< TObject >::PushBack(), and itk::ConstantBoundaryCondition< TInputImage, TOutputImage >::SetConstant().

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

Definition at line 102 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
virtual const double& otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::GetMinimumFit ( )
virtual
template<class TInputImage , class TOutputPath >
virtual const double& otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::GetMinimumSize ( )
virtual
template<class TInputImage , class TOutputPath >
virtual const char* otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

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

Method for creation through the object factory.

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

PrintSelf method

PrintSelf Method

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

Definition at line 422 of file otbRegionImageToRectangularPathListFilter.txx.

template<class TInputImage , class TOutputPath >
virtual void otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::SetMinimumFit ( double  _arg)
virtual

The minimum rectangular fit of returned rectangles.

template<class TInputImage , class TOutputPath >
virtual void otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::SetMinimumSize ( double  _arg)
virtual

The minimum size of returned rectangles.

Member Data Documentation

template<class TInputImage , class TOutputPath >
const unsigned int otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 57 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
int otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::m_CrossTermFormula
protected

Definition at line 107 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
double otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::m_MinimumFit
protected

Definition at line 105 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
double otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::m_MinimumSize
protected

Definition at line 106 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
MarkerImageType::Pointer otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::markerImage
protected

Definition at line 113 of file otbRegionImageToRectangularPathListFilter.h.

template<class TInputImage , class TOutputPath >
const unsigned int otb::RegionImageToRectangularPathListFilter< TInputImage, TOutputPath >::NDimensions = TInputImage::ImageDimension
static

Dimension of the image the iterator walks. This constant is needed so that functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

Definition at line 96 of file otbRegionImageToRectangularPathListFilter.h.


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