OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::PrintableImageFilter< TInputImage, TMaskImage > Class Template Reference
Group Core » Module OTBImageManipulation

#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< Self > Pointer
 
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
 
const ChannelsType GetChannelList ()
 
const ChannelsType GetChannels (void) const
 
MaskImageType * GetInputMask (void)
 
virtual const char * GetNameOfClass () const
 
virtual bool GetUseMask ()
 
 otbGetObjectMemberMacro (Rescaler, AutomaticInputMinMaxComputation, bool)
 
 otbGetObjectMemberMacro (Rescaler, InputMaximum, InputPixelType)
 
 otbGetObjectMemberMacro (Rescaler, InputMinimum, InputPixelType)
 
 otbSetObjectMemberMacro (Rescaler, AutomaticInputMinMaxComputation, bool)
 
 otbSetObjectMemberMacro (Rescaler, InputMaximum, InputPixelType)
 
 otbSetObjectMemberMacro (Rescaler, InputMinimum, InputPixelType)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void SetChannel (unsigned int channel)
 
void SetChannelList (ChannelsType chList)
 
void SetInputMask (const MaskImageType *mask)
 
virtual void SetUseMask (bool _arg)
 

Static Public Member Functions

static Pointer New ()
 
VectorRescalerType::Pointer m_Rescaler
 
ChannelExtractorType::Pointer m_Extractor
 
FunctorFilterPointerType m_MaskFilter
 
OutputPixelType m_ObjectColor
 
bool m_UseMask
 
ChannelsType m_ChannelList
 
MaskPixelType m_BackgroundMaskValue
 
void SetObjectColor (OutputPixelType val)
 
virtual OutputPixelType GetObjectColor ()
 
void SetBackgroundMaskValue (MaskPixelType val)
 
virtual MaskPixelType GetBackgroundMaskValue ()
 
void GenerateOutputInformation () override
 
 PrintableImageFilter ()
 
void BeforeGenerateData ()
 
void GenerateData () override
 
 PrintableImageFilter (Self &)
 
void operator= (const Self &)
 

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 124 of file otbPrintableImageFilter.h.

Member Typedef Documentation

◆ ChannelExtractorType

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

Definition at line 144 of file otbPrintableImageFilter.h.

◆ ChannelsType

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

Definition at line 145 of file otbPrintableImageFilter.h.

◆ ConstPointer

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

Definition at line 130 of file otbPrintableImageFilter.h.

◆ FunctorFilterPointerType

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

Definition at line 151 of file otbPrintableImageFilter.h.

◆ FunctorFilterType

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 150 of file otbPrintableImageFilter.h.

◆ FunctorType

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

Definition at line 149 of file otbPrintableImageFilter.h.

◆ InputImageType

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

Definition at line 132 of file otbPrintableImageFilter.h.

◆ InputInternalPixelType

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

Definition at line 134 of file otbPrintableImageFilter.h.

◆ InputPixelType

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

Definition at line 133 of file otbPrintableImageFilter.h.

◆ MaskImagePointerType

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

Definition at line 141 of file otbPrintableImageFilter.h.

◆ MaskImageType

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

Definition at line 140 of file otbPrintableImageFilter.h.

◆ MaskPixelType

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

Definition at line 142 of file otbPrintableImageFilter.h.

◆ OutputImageType

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

Definition at line 137 of file otbPrintableImageFilter.h.

◆ OutputInternalPixelType

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

Definition at line 136 of file otbPrintableImageFilter.h.

◆ OutputPixelType

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

Definition at line 138 of file otbPrintableImageFilter.h.

◆ Pointer

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

Definition at line 129 of file otbPrintableImageFilter.h.

◆ Self

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

Definition at line 127 of file otbPrintableImageFilter.h.

◆ Superclass

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 128 of file otbPrintableImageFilter.h.

◆ VectorRescalerType

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

Definition at line 147 of file otbPrintableImageFilter.h.

Constructor & Destructor Documentation

◆ PrintableImageFilter() [1/2]

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

Output Mask Object color.

Definition at line 31 of file otbPrintableImageFilter.hxx.

◆ PrintableImageFilter() [2/2]

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

Output Mask Object color.

Member Function Documentation

◆ BeforeGenerateData()

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

Output Mask Object color.

Definition at line 91 of file otbPrintableImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateData()

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::GenerateData
overrideprotected

Output Mask Object color.

Definition at line 128 of file otbPrintableImageFilter.hxx.

◆ GenerateOutputInformation()

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::GenerateOutputInformation
override

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::GenerateOutputInformation()

Definition at line 81 of file otbPrintableImageFilter.hxx.

◆ GetBackgroundMaskValue()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
virtual MaskPixelType otb::PrintableImageFilter< TInputImage, TMaskImage >::GetBackgroundMaskValue ( )
virtual

Output Mask Object color.

◆ GetChannelList()

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

Definition at line 187 of file otbPrintableImageFilter.h.

◆ GetChannels()

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

Definition at line 58 of file otbPrintableImageFilter.hxx.

◆ GetInputMask()

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 71 of file otbPrintableImageFilter.hxx.

◆ GetNameOfClass()

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

Run-time type information

◆ GetObjectColor()

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

Output Mask Object color.

◆ GetUseMask()

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

◆ New()

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

Method for creation through object factory

◆ operator=()

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

Output Mask Object color.

◆ otbGetObjectMemberMacro() [1/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
AutomaticInputMinMaxComputation  ,
bool   
)

◆ otbGetObjectMemberMacro() [2/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
InputMaximum  ,
InputPixelType   
)

◆ otbGetObjectMemberMacro() [3/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
InputMinimum  ,
InputPixelType   
)

◆ otbSetObjectMemberMacro() [1/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
AutomaticInputMinMaxComputation  ,
bool   
)

◆ otbSetObjectMemberMacro() [2/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
InputMaximum  ,
InputPixelType   
)

◆ otbSetObjectMemberMacro() [3/3]

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
InputMinimum  ,
InputPixelType   
)

◆ PrintSelf()

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
override

Display

Definition at line 169 of file otbPrintableImageFilter.hxx.

◆ SetBackgroundMaskValue()

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

Output Mask Object color.

Definition at line 216 of file otbPrintableImageFilter.h.

◆ SetChannel()

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

Definition at line 50 of file otbPrintableImageFilter.hxx.

◆ SetChannelList()

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

Definition at line 192 of file otbPrintableImageFilter.h.

◆ SetInputMask()

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 64 of file otbPrintableImageFilter.hxx.

◆ SetObjectColor()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetObjectColor ( OutputPixelType  val)
inline

Output Mask Object color.

Definition at line 203 of file otbPrintableImageFilter.h.

◆ SetUseMask()

template<class TInputImage , class TMaskImage = otb::Image<unsigned char, 2>>
virtual void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetUseMask ( bool  _arg)
virtual

Member Data Documentation

◆ m_BackgroundMaskValue

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

Output Mask Object color.

Definition at line 257 of file otbPrintableImageFilter.h.

◆ m_ChannelList

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

Output Mask Object color.

Definition at line 253 of file otbPrintableImageFilter.h.

◆ m_Extractor

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

Output Mask Object color.

Definition at line 245 of file otbPrintableImageFilter.h.

◆ m_MaskFilter

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

Output Mask Object color.

Definition at line 247 of file otbPrintableImageFilter.h.

◆ m_ObjectColor

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

Output Mask Object color.

Definition at line 249 of file otbPrintableImageFilter.h.

◆ m_Rescaler

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

Output Mask Object color.

Definition at line 244 of file otbPrintableImageFilter.h.

◆ m_UseMask

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

Output Mask Object color.

Definition at line 251 of file otbPrintableImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:23 for OTB with   doxygen 1.8.17