OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType > Class Template Reference
Group Core » Module OTBImageBase

#include <otbMultiToMonoChannelExtractROI.h>

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

Public Types

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::ValueType OutputValueType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef MultiToMonoChannelExtractROI Self
 
typedef ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > > Superclass
 
- Public Types inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
typedef itk::SmartPointer< const Self > ConstPointer
 
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 Image< TOutputPixelType, 2 > ::IndexType OutputImageIndexType
 
typedef Image< TOutputPixelType, 2 > ::PixelType OutputImagePixelType
 
typedef Image< TOutputPixelType, 2 > ::RegionType OutputImageRegionType
 
typedef Image< TOutputPixelType, 2 > ::SizeType OutputImageSizeType
 
typedef Image< TOutputPixelType, 2 > OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ExtractROIBase Self
 
typedef itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > > Superclass
 
typedef itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> ExtractROIBaseRegionCopierType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual InputImageRegionType GetExtractionRegion ()
 
void SetExtractionRegion (InputImageRegionType roi)
 
virtual void SetStartX (unsigned long _arg)
 
virtual unsigned long GetStartX () const
 
virtual void SetStartY (unsigned long _arg)
 
virtual unsigned long GetStartY () const
 
virtual void SetSizeX (unsigned long _arg)
 
virtual unsigned long GetSizeX () const
 
virtual void SetSizeY (unsigned long _arg)
 
virtual unsigned long GetSizeY () const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
static Pointer New ()
 
static const unsigned int InputImageDimension = InputImageType::ImageDimension
 
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
unsigned int m_Channel
 
virtual void SetChannel (unsigned int _arg)
 
virtual unsigned int GetChannel () const
 
 MultiToMonoChannelExtractROI ()
 
 ~MultiToMonoChannelExtractROI () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateOutputInformation () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 MultiToMonoChannelExtractROI (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Static Public Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Protected Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
 ExtractROIBase ()
 
 ~ExtractROIBase () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion) override
 
void ThreadedGenerateData (const OutputImageRegionType &, itk::ThreadIdType) override
 
void SetInternalExtractionRegion (InputImageRegionType extractRegion)
 
- Protected Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
InputImageRegionType m_ExtractionRegion
 
OutputImageRegionType m_OutputImageRegion
 

Detailed Description

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

Extract a mono channel part of a multi-channel image.

This filter extracts either all channels or only those specified by the user. The SetChannel method allows selecting the channels to process.

Note
If nothing is specified, only the first channel is processed.
This class is templated over the pixel types of the input and output images. The input image has to be an otb::VectorImage, whereas the output image has to be an otb::Image.

Definition at line 46 of file otbMultiToMonoChannelExtractROI.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 56 of file otbMultiToMonoChannelExtractROI.h.

◆ InputImageIndexType

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

Definition at line 81 of file otbMultiToMonoChannelExtractROI.h.

◆ InputImagePixelType

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

Definition at line 77 of file otbMultiToMonoChannelExtractROI.h.

◆ InputImageRegionType

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

Definition at line 73 of file otbMultiToMonoChannelExtractROI.h.

◆ InputImageSizeType

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

Definition at line 83 of file otbMultiToMonoChannelExtractROI.h.

◆ InputImageType

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

Image type information.

Definition at line 62 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImageIndexType

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

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

Definition at line 80 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImagePixelType

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

Typedef to describe the type of pixel.

Definition at line 76 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImageRegionType

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

Typedef to describe the output and input image region types.

Definition at line 72 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImageSizeType

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

Definition at line 82 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImageType

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

Definition at line 66 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputValueType

template<class TInputPixelType , class TOutputPixelType >
typedef OutputImageType::ValueType otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::OutputValueType

Pixel type information

Definition at line 69 of file otbMultiToMonoChannelExtractROI.h.

◆ Pointer

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

Definition at line 55 of file otbMultiToMonoChannelExtractROI.h.

◆ Self

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

Standard class typedefs.

Definition at line 52 of file otbMultiToMonoChannelExtractROI.h.

◆ Superclass

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

Definition at line 54 of file otbMultiToMonoChannelExtractROI.h.

Constructor & Destructor Documentation

◆ MultiToMonoChannelExtractROI() [1/2]

template<class TInputPixelType , class TOutputPixelType >
otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiToMonoChannelExtractROI
protected

ImageDimension enumeration

Definition at line 33 of file otbMultiToMonoChannelExtractROI.hxx.

◆ ~MultiToMonoChannelExtractROI()

template<class TInputPixelType , class TOutputPixelType >
otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::~MultiToMonoChannelExtractROI ( )
inlineoverrideprotected

ImageDimension enumeration

Definition at line 97 of file otbMultiToMonoChannelExtractROI.h.

◆ MultiToMonoChannelExtractROI() [2/2]

template<class TInputPixelType , class TOutputPixelType >
otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiToMonoChannelExtractROI ( const Self &  )
privatedelete

ImageDimension enumeration

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::GenerateOutputInformation
overrideprotected

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

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

Definition at line 57 of file otbMultiToMonoChannelExtractROI.hxx.

◆ GetChannel()

template<class TInputPixelType , class TOutputPixelType >
virtual unsigned int otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::GetChannel ( ) const
virtual

ImageDimension enumeration

◆ GetNameOfClass()

template<class TInputPixelType , class TOutputPixelType >
virtual const char* otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::operator= ( const Self &  )
privatedelete

ImageDimension enumeration

◆ PrintSelf()

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

ImageDimension enumeration

Definition at line 42 of file otbMultiToMonoChannelExtractROI.hxx.

◆ SetChannel()

template<class TInputPixelType , class TOutputPixelType >
virtual void otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::SetChannel ( unsigned int  _arg)
virtual

Select the channel to process

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

◆ ThreadedGenerateData()

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

ExtractImageFilter can be implemented as a multithreaded filter.

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

Definition at line 74 of file otbMultiToMonoChannelExtractROI.hxx.

Member Data Documentation

◆ InputImageDimension

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

ImageDimension enumeration

Definition at line 91 of file otbMultiToMonoChannelExtractROI.h.

◆ m_Channel

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >::m_Channel
private

Channel to process [1...]

Definition at line 122 of file otbMultiToMonoChannelExtractROI.h.

◆ OutputImageDimension

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

ImageDimension enumeration

Definition at line 92 of file otbMultiToMonoChannelExtractROI.h.

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