OTB  5.0.0
Orfeo Toolbox
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

#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 Types inherited from itk::ImageToImageFilter< TInputImage, otb::VectorImage< unsigned char, 2 > >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource
< otb::VectorImage< unsigned
char, 2 > > 
Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateOutputInformation ()
 
virtual MaskPixelType GetBackgroundMaskValue ()
 
ChannelsType const GetChannelList ()
 
const ChannelsType GetChannels (void) const
 
MaskImageTypeGetInputMask (void)
 
virtual const char * GetNameOfClass () const
 
virtual bool GetUseMask ()
 
 otbGetObjectMemberMacro (Rescaler, AutomaticInputMinMaxComputation, bool)
 
 otbGetObjectMemberMacro (Rescaler, InputMinimum, InputPixelType)
 
 otbGetObjectMemberMacro (Rescaler, InputMaximum, InputPixelType)
 
 otbSetObjectMemberMacro (Rescaler, AutomaticInputMinMaxComputation, bool)
 
 otbSetObjectMemberMacro (Rescaler, InputMinimum, InputPixelType)
 
 otbSetObjectMemberMacro (Rescaler, InputMaximum, InputPixelType)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void SetBackgroundMaskValue (MaskPixelType val)
 
void SetChannel (unsigned int channel)
 
void SetChannelList (ChannelsType chList)
 
void SetInputMask (const MaskImageType *mask)
 
virtual void SetUseMask (bool _arg)
 
void SetObjectColor (OutputPixelType val)
 
virtual OutputPixelType GetObjectColor ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, otb::VectorImage< unsigned char, 2 > >
virtual double GetCoordinateTolerance () const
 
virtual double GetDirectionTolerance () const
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual void SetDirectionTolerance (double _arg)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
const OutputImageTypeGetOutput (void) const
 
OutputImageTypeGetOutput (void)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void BeforeGenerateData ()
 
void GenerateData ()
 
 PrintableImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, otb::VectorImage< unsigned char, 2 > >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void GenerateInputRequestedRegion ()
 
 ImageToImageFilter ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
virtual void VerifyInputInformation ()
 
 ~ImageToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &)
 
 PrintableImageFilter (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
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, otb::VectorImage< unsigned char, 2 > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, otb::VectorImage< unsigned char, 2 > >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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 121 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 144 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 145 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 129 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 153 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 152 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 150 of file otbPrintableImageFilter.h.

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

Definition at line 131 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 133 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 132 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 140 of file otbPrintableImageFilter.h.

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

Definition at line 139 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 141 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 136 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 135 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 137 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 128 of file otbPrintableImageFilter.h.

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

Definition at line 125 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 127 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 148 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
virtual

Reimplemented from itk::Object.

template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::GenerateData ( void  )
protectedvirtual

Reimplemented from itk::ImageSource< TOutputImage >.

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

Reimplemented from itk::ProcessObject.

Definition at line 91 of file otbPrintableImageFilter.txx.

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

References itk::ProcessObject::GetInput().

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

Output Mask Object color.

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 = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
AutomaticInputMinMaxComputation  ,
bool   
)
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
InputMinimum  ,
InputPixelType   
)
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbGetObjectMemberMacro ( Rescaler  ,
InputMaximum  ,
InputPixelType   
)
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
AutomaticInputMinMaxComputation  ,
bool   
)
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
InputMinimum  ,
InputPixelType   
)
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
otb::PrintableImageFilter< TInputImage, TMaskImage >::otbSetObjectMemberMacro ( Rescaler  ,
InputMaximum  ,
InputPixelType   
)
template<class TInputImage , class TMaskImage >
void otb::PrintableImageFilter< TInputImage, TMaskImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
virtual
template<class TInputImage, class TMaskImage = otb::Image<unsigned char, 2>>
void otb::PrintableImageFilter< TInputImage, TMaskImage >::SetBackgroundMaskValue ( MaskPixelType  val)
inline

Definition at line 219 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 195 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.

References itk::ProcessObject::SetNthInput().

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

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 262 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 258 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 250 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 252 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 254 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 249 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 256 of file otbPrintableImageFilter.h.


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