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 | Private Member Functions | Private Attributes | List of all members
otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType > Class Template Reference

Extract a spatial or spectral subset of a multi-channel image. More...

#include <otbMultiChannelExtractROI.h>

+ Inheritance diagram for otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >:
+ Collaboration diagram for otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >:

Public Types

typedef std::vector< unsigned int > ChannelsType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef Superclass::InputImageType InputImageType
 
typedef OutputImageType::IndexType OutputImageIndexType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::SizeType OutputImageSizeType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef
OutputImageType::InternalPixelType 
OutputValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MultiChannelExtractROI Self
 
typedef ExtractROIBase
< VectorImage< TInputPixelType, 2 >
, VectorImage
< TOutputPixelType, 2 > > 
Superclass
 
- Public Types inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension)> 
ExtractROIBaseRegionCopierType
 
typedef VectorImage
< TInputPixelType, 2 >
::IndexType 
InputImageIndexType
 
typedef VectorImage
< TInputPixelType, 2 >
::PixelType 
InputImagePixelType
 
typedef VectorImage
< TInputPixelType, 2 >
::RegionType 
InputImageRegionType
 
typedef VectorImage
< TInputPixelType, 2 >
::SizeType 
InputImageSizeType
 
typedef VectorImage
< TInputPixelType, 2 > 
InputImageType
 
typedef VectorImage
< TOutputPixelType, 2 >
::IndexType 
OutputImageIndexType
 
typedef VectorImage
< TOutputPixelType, 2 >
::PixelType 
OutputImagePixelType
 
typedef VectorImage
< TOutputPixelType, 2 >
::RegionType 
OutputImageRegionType
 
typedef VectorImage
< TOutputPixelType, 2 >
::SizeType 
OutputImageSizeType
 
typedef VectorImage
< TOutputPixelType, 2 > 
OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ExtractROIBase Self
 
typedef
itk::ImageToImageFilter
< VectorImage< TInputPixelType, 2 >
, VectorImage
< TOutputPixelType, 2 > > 
Superclass
 

Public Member Functions

void ClearChannels (void)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
ChannelsType GetChannels () const
 
virtual unsigned int GetFirstChannel () const
 
virtual unsigned int GetLastChannel () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNbChannels () const
 
void SetChannel (unsigned int channel)
 
void SetFirstChannel (unsigned int id)
 
void SetLastChannel (unsigned int id)
 
- Public Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual InputImageRegionType GetExtractionRegion ()
 
virtual unsigned long GetSizeX () const
 
virtual unsigned long GetSizeY () const
 
virtual unsigned long GetStartX () const
 
virtual unsigned long GetStartY () const
 
void SetExtractionRegion (InputImageRegionType roi)
 
virtual void SetSizeX (unsigned long _arg)
 
virtual void SetSizeY (unsigned long _arg)
 
virtual void SetStartX (unsigned long _arg)
 
virtual void SetStartY (unsigned long _arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Static Public Attributes

static const unsigned int InputImageDimension = InputImageType::ImageDimension
 
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Protected Member Functions

 MultiChannelExtractROI ()
 
virtual ~MultiChannelExtractROI ()
 
void ChannelsReInitialization ()
 
virtual void GenerateOutputInformation ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void SetChannelsWorkWithLimits ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
- Protected Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
 ExtractROIBase ()
 
virtual ~ExtractROIBase ()
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void GenerateInputRequestedRegion ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void SetInternalExtractionRegion (InputImageRegionType extractRegion)
 
void ThreadedGenerateData (const OutputImageRegionType &, itk::ThreadIdType)
 

Private Member Functions

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

Private Attributes

ChannelsType m_Channels
 
int m_ChannelsKind
 
ChannelsType m_ChannelsWorks
 
unsigned int m_FirstChannel
 
unsigned int m_LastChannel
 

Additional Inherited Members

- Protected Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
InputImageRegionType m_ExtractionRegion
 
OutputImageRegionType m_OutputImageRegion
 

Detailed Description

template<class TInputPixelType, class TOutputPixelType>
class otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >

Extract a spatial or spectral subset of a multi-channel image.

It is possible to extract all the channels from the input image or only those specified by the user. The SetChannel() method allows to select one channel. The SetFirstChannel() and SetLastChannel() methods allow the user to define a list of channels.

Note
If no channels are specified, then all channels from the input image are selected.
The image manipulated inside this class are of type otb::VectorImage.
Examples:
FeatureExtraction/CloudDetectionExample.cxx, FeatureExtraction/ExtractRoadByStepsExample.cxx, and Fusion/BayesianFusionImageFilter.cxx.

Definition at line 41 of file otbMultiChannelExtractROI.h.

Member Typedef Documentation

template<class TInputPixelType , class TOutputPixelType >
typedef std::vector<unsigned int> otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ChannelsType

Typedef Liste des canaux

Definition at line 81 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef itk::SmartPointer<const Self> otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ConstPointer

Definition at line 49 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef InputImageType::IndexType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImageIndexType

Definition at line 74 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef InputImageType::PixelType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImagePixelType

Definition at line 70 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef InputImageType::RegionType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImageRegionType

Definition at line 66 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef InputImageType::SizeType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImageSizeType

Definition at line 76 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef Superclass::InputImageType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImageType

Image type information.

Definition at line 55 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::IndexType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 73 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::PixelType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 69 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::RegionType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 65 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::SizeType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImageSizeType

Definition at line 75 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef Superclass::OutputImageType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImageType

Definition at line 59 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::InternalPixelType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputValueType

Pixel type information

Definition at line 62 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef itk::SmartPointer<Self> otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::Pointer

Definition at line 48 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef MultiChannelExtractROI otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::Self

Standard class typedefs.

Definition at line 46 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
typedef ExtractROIBase<VectorImage<TInputPixelType, 2>, VectorImage<TOutputPixelType, 2> > otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::Superclass

Definition at line 47 of file otbMultiChannelExtractROI.h.

Constructor & Destructor Documentation

template<class TInputPixelType , class TOutputPixelType >
otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI ( )
protected

Definition at line 37 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
virtual otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::~MultiChannelExtractROI ( )
inlineprotectedvirtual

Definition at line 113 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI ( const Self )
private

Member Function Documentation

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ChannelsReInitialization ( )
protected

Reinitialize channels vector for multiple Update.

Definition at line 129 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ClearChannels ( void  )

Clear channels selection

Definition at line 106 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
virtual::itk::LightObject::Pointer otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::CreateAnother ( void  ) const
template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GenerateOutputInformation ( void  )
protectedvirtual

MultiChannelExtractROI can produce an image which is a different resolution than its input image. As such, MultiChannelExtractROI 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()

ExtractImageFilter can produce an image which is a different resolution than its input image. As such, ExtractImageFilter 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 otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >.

Examples:
FeatureExtraction/ExtractRoadByStepsExample.cxx, and Fusion/BayesianFusionImageFilter.cxx.

Definition at line 208 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetChannels ( void  ) const
inline
Returns
The list of processed channels

Definition at line 87 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetFirstChannel ( ) const
virtual
template<class TInputPixelType , class TOutputPixelType >
virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetLastChannel ( ) const
virtual
template<class TInputPixelType , class TOutputPixelType >
virtual const char* otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNbChannels ( ) const
inline
Returns
The number of processed channels

Definition at line 93 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
static Pointer otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::New ( )
static

Method for creation through the object factory.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::operator= ( const Self )
private
template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 121 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::SetChannel ( unsigned int  channel)

Select a channel to process

Parameters
channelThe channel to process

Definition at line 52 of file otbMultiChannelExtractROI.txx.

Referenced by otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData().

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::SetChannelsWorkWithLimits ( )
protected

If the user set m_First/LastChannel, chack avaliability or fill m_Channels Work.

Definition at line 173 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::SetFirstChannel ( unsigned int  id)

Definition at line 69 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::SetLastChannel ( unsigned int  id)

Definition at line 86 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

ExtractImageFilter can be implemented as a multithreaded filter.

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

Definition at line 259 of file otbMultiChannelExtractROI.txx.

Member Data Documentation

template<class TInputPixelType , class TOutputPixelType >
const unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::InputImageDimension = InputImageType::ImageDimension
static

ImageDimension enumeration

Definition at line 107 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_Channels
private

List of channels to process [1...]

Definition at line 145 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_ChannelsKind
private

Used to know if the user has set m_First/LastChannel (1) or m_Channels (3)

Definition at line 149 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_ChannelsWorks
private

List of channels actually being processed [1...]

Definition at line 147 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_FirstChannel
private

First/ last channel to process [1...]

Definition at line 142 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_LastChannel
private

Definition at line 143 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
const unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputImageDimension = OutputImageType::ImageDimension
static

Definition at line 109 of file otbMultiChannelExtractROI.h.


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