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::PrintableImageFilter< TInputImage, TMaskImage > Class Template Reference

This class is a helper class to turn a vector image to a generic 8 bytes RGB image. A mask can be used to highlight some objects represented by the same value. The mask is a binary image. Background MaskValue is used to precise which value of the mask are objects (default 0). Output object color can be set using m_ObjectColor (default white). The output is a 3 channel image, each channel is a channel of the input image. They can be selected using m_ChannelList or SetChannel(int ch ) method. More...

#include <otbPrintableImageFilter.h>

+ Inheritance diagram for otb::PrintableImageFilter< TInputImage, TMaskImage >:
+ Collaboration diagram for otb::PrintableImageFilter< TInputImage, TMaskImage >:

Public Types

typedef
otb::MultiChannelExtractROI
< InputInternalPixelType,
InputInternalPixelType
ChannelExtractorType
 
typedef
ChannelExtractorType::ChannelsType 
ChannelsType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef FunctorFilterType::Pointer FunctorFilterPointerType
 
typedef
itk::BinaryFunctorImageFilter
< OutputImageType,
MaskImageType, OutputImageType,
FunctorType
FunctorFilterType
 
typedef Functor::MaskFunctor
< InputPixelType,
MaskPixelType, OutputPixelType
FunctorType
 
typedef TInputImage InputImageType
 
typedef
InputImageType::InternalPixelType 
InputInternalPixelType
 
typedef InputImageType::PixelType InputPixelType
 
typedef MaskImageType::Pointer MaskImagePointerType
 
typedef TMaskImage MaskImageType
 
typedef MaskImageType::PixelType MaskPixelType
 
typedef VectorImage
< OutputInternalPixelType, 2 > 
OutputImageType
 
typedef unsigned char OutputInternalPixelType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PrintableImageFilter Self
 
typedef
itk::ImageToImageFilter
< TInputImage,
otb::VectorImage< unsigned
char, 2 > > 
Superclass
 
typedef
VectorRescaleIntensityImageFilter
< typename
ChannelExtractorType::OutputImageType,
OutputImageType
VectorRescalerType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateOutputInformation ()
 
virtual bool GetAutomaticInputMinMaxComputation ()
 
virtual MaskPixelType GetBackgroundMaskValue ()
 
ChannelsType const GetChannelList ()
 
const ChannelsType GetChannels (void) const
 
MaskImageTypeGetInputMask (void)
 
virtual InputPixelType GetInputMaximum ()
 
virtual InputPixelType GetInputMinimum ()
 
virtual const char * GetNameOfClass () const
 
virtual OutputPixelType GetObjectColor ()
 
virtual bool GetUseMask ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
virtual void SetAutomaticInputMinMaxComputation (const bool _arg)
 
void SetBackgroundMaskValue (MaskPixelType val)
 
void SetChannel (unsigned int channel)
 
void SetChannelList (ChannelsType chList)
 
void SetInputMask (const MaskImageType *mask)
 
virtual void SetInputMaximum (const InputPixelType _arg)
 
virtual void SetInputMinimum (const InputPixelType _arg)
 
void SetObjectColor (OutputPixelType val)
 
virtual void SetUseMask (bool _arg)
 

Static Public Member Functions

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

Protected Member Functions

 PrintableImageFilter ()
 
void BeforeGenerateData ()
 
void GenerateData ()
 

Private Member Functions

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

Private Attributes

MaskPixelType m_BackgroundMaskValue
 
ChannelsType m_ChannelList
 
ChannelExtractorType::Pointer m_Extractor
 
FunctorFilterPointerType m_MaskFilter
 
OutputPixelType m_ObjectColor
 
VectorRescalerType::Pointer m_Rescaler
 
bool m_UseMask
 

Detailed Description

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
class otb::PrintableImageFilter< TInputImage, TMaskImage >

This class is a helper class to turn a vector image to a generic 8 bytes RGB image. A mask can be used to highlight some objects represented by the same value. The mask is a binary image. Background MaskValue is used to precise which value of the mask are objects (default 0). Output object color can be set using m_ObjectColor (default white). The output is a 3 channel image, each channel is a channel of the input image. They can be selected using m_ChannelList or SetChannel(int ch ) method.

It is useful for publications for instance.

See Also
itkImageToImageFilter
Examples:
Fusion/PanSharpeningExample.cxx.

Definition at line 117 of file otbPrintableImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef otb::MultiChannelExtractROI<InputInternalPixelType, InputInternalPixelType> otb::PrintableImageFilter< TInputImage, TMaskImage >::ChannelExtractorType

Definition at line 140 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef ChannelExtractorType::ChannelsType otb::PrintableImageFilter< TInputImage, TMaskImage >::ChannelsType

Definition at line 141 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::SmartPointer<const Self> otb::PrintableImageFilter< TInputImage, TMaskImage >::ConstPointer

Definition at line 125 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef FunctorFilterType::Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::FunctorFilterPointerType

Definition at line 149 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::BinaryFunctorImageFilter<OutputImageType, MaskImageType, OutputImageType, FunctorType> otb::PrintableImageFilter< TInputImage, TMaskImage >::FunctorFilterType

Definition at line 148 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef Functor::MaskFunctor<InputPixelType, MaskPixelType, OutputPixelType> otb::PrintableImageFilter< TInputImage, TMaskImage >::FunctorType

Definition at line 146 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TInputImage otb::PrintableImageFilter< TInputImage, TMaskImage >::InputImageType

Definition at line 127 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef InputImageType::InternalPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::InputInternalPixelType

Definition at line 129 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef InputImageType::PixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::InputPixelType

Definition at line 128 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef MaskImageType::Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::MaskImagePointerType

Definition at line 136 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef TMaskImage otb::PrintableImageFilter< TInputImage, TMaskImage >::MaskImageType

Definition at line 135 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef MaskImageType::PixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::MaskPixelType

Definition at line 137 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef VectorImage<OutputInternalPixelType, 2> otb::PrintableImageFilter< TInputImage, TMaskImage >::OutputImageType

Definition at line 132 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef unsigned char otb::PrintableImageFilter< TInputImage, TMaskImage >::OutputInternalPixelType

Definition at line 131 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef OutputImageType::PixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::OutputPixelType

Definition at line 133 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::SmartPointer<Self> otb::PrintableImageFilter< TInputImage, TMaskImage >::Pointer

Definition at line 124 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef PrintableImageFilter otb::PrintableImageFilter< TInputImage, TMaskImage >::Self

Definition at line 121 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef itk::ImageToImageFilter<TInputImage, otb::VectorImage<unsigned char, 2> > otb::PrintableImageFilter< TInputImage, TMaskImage >::Superclass

Definition at line 123 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
typedef VectorRescaleIntensityImageFilter<typename ChannelExtractorType::OutputImageType, OutputImageType> otb::PrintableImageFilter< TInputImage, TMaskImage >::VectorRescalerType

Definition at line 144 of file otbPrintableImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TMaskImage >
otb::PrintableImageFilter< TInputImage, TMaskImage >::PrintableImageFilter ( )
protected

Definition at line 31 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::PrintableImageFilter ( Self )
private

Member Function Documentation

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::BeforeGenerateData ( )
protected

Definition at line 103 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual::itk::LightObject::Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::CreateAnother ( void  ) const
template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::GenerateData ( void  )
protected

Definition at line 143 of file otbPrintableImageFilter.txx.

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::GenerateOutputInformation ( void  )
virtual

PrintableImageFilter can produce an image which is a different resolution than its input image. As such, PrintableImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See Also
ProcessObject::GenerateOutputInformaton()

Definition at line 91 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual bool otb::PrintableImageFilter< TInputImage, TMaskImage >::GetAutomaticInputMinMaxComputation ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual MaskPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetBackgroundMaskValue ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
ChannelsType const otb::PrintableImageFilter< TInputImage, TMaskImage >::GetChannelList ( )
inline

Definition at line 186 of file otbPrintableImageFilter.h.

template<class TInputImage , class TMaskImage >
const PrintableImageFilter< TInputImage, TMaskImage >::ChannelsType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetChannels ( void  ) const

Definition at line 62 of file otbPrintableImageFilter.txx.

template<class TInputImage , class TMaskImage >
PrintableImageFilter< TInputImage, TMaskImage >::MaskImageType * otb::PrintableImageFilter< TInputImage, TMaskImage >::GetInputMask ( void  )

Get the input mask.

Returns
The mask.

Definition at line 79 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual InputPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetInputMaximum ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual InputPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetInputMinimum ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual const char* otb::PrintableImageFilter< TInputImage, TMaskImage >::GetNameOfClass ( ) const
virtual

Run-time type information

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual OutputPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetObjectColor ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual bool otb::PrintableImageFilter< TInputImage, TMaskImage >::GetUseMask ( )
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
static Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::New ( )
static

Method for creation through object factory

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::operator= ( const Self )
private
template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const

Display

Definition at line 187 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetAutomaticInputMinMaxComputation ( const bool  _arg)
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetBackgroundMaskValue ( MaskPixelType  val)
inline

Definition at line 214 of file otbPrintableImageFilter.h.

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetChannel ( unsigned int  channel)

Definition at line 52 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetChannelList ( ChannelsType  chList)
inline

Definition at line 191 of file otbPrintableImageFilter.h.

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetInputMask ( const MaskImageType mask)

If set, only pixels within the mask will be classified.

Parameters
maskThe input mask.

Definition at line 70 of file otbPrintableImageFilter.txx.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetInputMaximum ( const InputPixelType  _arg)
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetInputMinimum ( const InputPixelType  _arg)
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetObjectColor ( OutputPixelType  val)
inline
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetUseMask ( bool  _arg)
virtual

Member Data Documentation

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
MaskPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::m_BackgroundMaskValue
private

Definition at line 257 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
ChannelsType otb::PrintableImageFilter< TInputImage, TMaskImage >::m_ChannelList
private

Definition at line 253 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
ChannelExtractorType::Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::m_Extractor
private

Definition at line 245 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
FunctorFilterPointerType otb::PrintableImageFilter< TInputImage, TMaskImage >::m_MaskFilter
private

Definition at line 247 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
OutputPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::m_ObjectColor
private

Definition at line 249 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
VectorRescalerType::Pointer otb::PrintableImageFilter< TInputImage, TMaskImage >::m_Rescaler
private

Definition at line 244 of file otbPrintableImageFilter.h.

template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
bool otb::PrintableImageFilter< TInputImage, TMaskImage >::m_UseMask
private

Definition at line 251 of file otbPrintableImageFilter.h.


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