#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< Self >	Pointer

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 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< Self >	Pointer

typedef ExtractROIBase	Self

typedef itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >	Superclass

typedef itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	ExtractROIBaseRegionCopierType

Public Member Functions
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	SetFirstChannel (unsigned int id)

void	SetLastChannel (unsigned int id)

void	SetChannel (unsigned int channel)

void	ClearChannels (void)

Public Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< 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 >, VectorImage< TOutputPixelType, 2 > >
static Pointer	New ()

static const unsigned int	InputImageDimension = InputImageType::ImageDimension

static const unsigned int	OutputImageDimension = OutputImageType::ImageDimension

unsigned int	m_FirstChannel

unsigned int	m_LastChannel

ChannelsType	m_Channels

ChannelsType	m_ChannelsWorks

int	m_ChannelsKind

	MultiChannelExtractROI ()

	~MultiChannelExtractROI () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

void	GenerateOutputInformation () override

void	ChannelsReInitialization ()

void	SetChannelsWorkWithLimits ()

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override

	MultiChannelExtractROI (const Self &)=delete

void	operator= (const Self &)=delete

Additional Inherited Members
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 inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< 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 >, 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 selecting 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, and Fusion/BayesianFusionImageFilter.cxx.

Definition at line 47 of file otbMultiChannelExtractROI.h.

Member Typedef Documentation

◆ ChannelsType

template<class TInputPixelType , class TOutputPixelType >

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

Typedef Liste des canaux

Definition at line 86 of file otbMultiChannelExtractROI.h.

◆ ConstPointer

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 54 of file otbMultiChannelExtractROI.h.

◆ InputImageIndexType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 79 of file otbMultiChannelExtractROI.h.

◆ InputImagePixelType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 75 of file otbMultiChannelExtractROI.h.

◆ InputImageRegionType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 71 of file otbMultiChannelExtractROI.h.

◆ InputImageSizeType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 81 of file otbMultiChannelExtractROI.h.

◆ InputImageType

template<class TInputPixelType , class TOutputPixelType >

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

Image type information.

Definition at line 60 of file otbMultiChannelExtractROI.h.

◆ OutputImageIndexType

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 78 of file otbMultiChannelExtractROI.h.

◆ OutputImagePixelType

template<class TInputPixelType , class TOutputPixelType >

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

Typedef to describe the type of pixel.

Definition at line 74 of file otbMultiChannelExtractROI.h.

◆ OutputImageRegionType

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 70 of file otbMultiChannelExtractROI.h.

◆ OutputImageSizeType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 80 of file otbMultiChannelExtractROI.h.

◆ OutputImageType

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 64 of file otbMultiChannelExtractROI.h.

◆ OutputValueType

template<class TInputPixelType , class TOutputPixelType >

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

Pixel type information

Definition at line 67 of file otbMultiChannelExtractROI.h.

◆ Pointer

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 53 of file otbMultiChannelExtractROI.h.

◆ Self

template<class TInputPixelType , class TOutputPixelType >

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

Standard class typedefs.

Definition at line 51 of file otbMultiChannelExtractROI.h.

◆ Superclass

template<class TInputPixelType , class TOutputPixelType >

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

Definition at line 52 of file otbMultiChannelExtractROI.h.

Constructor & Destructor Documentation

◆ MultiChannelExtractROI() [1/2]

template<class TInputPixelType , class TOutputPixelType >

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

protected

ImageDimension enumeration

Definition at line 38 of file otbMultiChannelExtractROI.hxx.

References otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ClearChannels().

◆ ~MultiChannelExtractROI()

template<class TInputPixelType , class TOutputPixelType >

otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::~MultiChannelExtractROI ( )

inlineoverrideprotected

ImageDimension enumeration

Definition at line 117 of file otbMultiChannelExtractROI.h.

◆ MultiChannelExtractROI() [2/2]

template<class TInputPixelType , class TOutputPixelType >

otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI ( const Self & )

privatedelete

ImageDimension enumeration

Member Function Documentation

◆ ChannelsReInitialization()

template<class TInputPixelType , class TOutputPixelType >

void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ChannelsReInitialization

protected

Reinitialize channels vector for multiple Update.

Definition at line 117 of file otbMultiChannelExtractROI.hxx.

◆ ClearChannels()

template<class TInputPixelType , class TOutputPixelType >

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

Clear channels selection

Definition at line 97 of file otbMultiChannelExtractROI.hxx.

Referenced by otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI().

◆ CreateAnother()

template<class TInputPixelType , class TOutputPixelType >

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

◆ GenerateOutputInformation()

template<class TInputPixelType , class TOutputPixelType >

void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GenerateOutputInformation

overrideprotected

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

Examples: Fusion/BayesianFusionImageFilter.cxx.

Definition at line 190 of file otbMultiChannelExtractROI.hxx.

◆ GetChannels()

template<class TInputPixelType , class TOutputPixelType >

ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetChannels ( ) const

inline

Returns: The list of processed channels

Definition at line 92 of file otbMultiChannelExtractROI.h.

◆ GetFirstChannel()

template<class TInputPixelType , class TOutputPixelType >

virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetFirstChannel ( ) const

virtual

◆ GetLastChannel()

template<class TInputPixelType , class TOutputPixelType >

virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetLastChannel ( ) const

virtual

◆ GetNameOfClass()

template<class TInputPixelType , class TOutputPixelType >

virtual const char* otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

◆ GetNbChannels()

template<class TInputPixelType , class TOutputPixelType >

unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNbChannels ( ) const

inline

Returns: The number of processed channels

Definition at line 98 of file otbMultiChannelExtractROI.h.

◆ New()

template<class TInputPixelType , class TOutputPixelType >

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

static

Method for creation through the object factory.

◆ operator=()

template<class TInputPixelType , class TOutputPixelType >

void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::operator= ( const Self & )

privatedelete

ImageDimension enumeration

◆ PrintSelf()

template<class TInputPixelType , class TOutputPixelType >

void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overrideprotected

ImageDimension enumeration

Definition at line 111 of file otbMultiChannelExtractROI.hxx.

◆ SetChannel()

template<class TInputPixelType , class TOutputPixelType >

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

Select a channel to process

Parameters

channel The channel to process

Definition at line 48 of file otbMultiChannelExtractROI.hxx.

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

◆ SetChannelsWorkWithLimits()

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 159 of file otbMultiChannelExtractROI.hxx.

◆ SetFirstChannel()

template<class TInputPixelType , class TOutputPixelType >

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

Select a channel to process

Parameters

channel The channel to process

Definition at line 64 of file otbMultiChannelExtractROI.hxx.

◆ SetLastChannel()

template<class TInputPixelType , class TOutputPixelType >

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

Select a channel to process

Parameters

channel The channel to process

Definition at line 79 of file otbMultiChannelExtractROI.hxx.

◆ ThreadedGenerateData()

template<class TInputPixelType , class TOutputPixelType >

void otb::MultiChannelExtractROI< 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 241 of file otbMultiChannelExtractROI.hxx.

Member Data Documentation

◆ InputImageDimension

template<class TInputPixelType , class TOutputPixelType >

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

static

ImageDimension enumeration

Definition at line 111 of file otbMultiChannelExtractROI.h.

◆ m_Channels

template<class TInputPixelType , class TOutputPixelType >

ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_Channels

private

List of channels to process [1...]

Definition at line 152 of file otbMultiChannelExtractROI.h.

◆ m_ChannelsKind

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 158 of file otbMultiChannelExtractROI.h.

◆ m_ChannelsWorks

template<class TInputPixelType , class TOutputPixelType >

ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_ChannelsWorks

private

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

Definition at line 155 of file otbMultiChannelExtractROI.h.

◆ m_FirstChannel

template<class TInputPixelType , class TOutputPixelType >

unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_FirstChannel

private

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

Definition at line 148 of file otbMultiChannelExtractROI.h.

◆ m_LastChannel

template<class TInputPixelType , class TOutputPixelType >

unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_LastChannel

private

ImageDimension enumeration

Definition at line 149 of file otbMultiChannelExtractROI.h.

◆ OutputImageDimension

template<class TInputPixelType , class TOutputPixelType >

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

static

ImageDimension enumeration

Definition at line 112 of file otbMultiChannelExtractROI.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ChannelsType

◆ ConstPointer

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageSizeType

◆ InputImageType

◆ OutputImageIndexType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ OutputImageType

◆ OutputValueType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MultiChannelExtractROI() [1/2]

◆ ~MultiChannelExtractROI()

◆ MultiChannelExtractROI() [2/2]

Member Function Documentation

◆ ChannelsReInitialization()

◆ ClearChannels()

◆ CreateAnother()

◆ GenerateOutputInformation()

◆ GetChannels()

◆ GetFirstChannel()

◆ GetLastChannel()

◆ GetNameOfClass()

◆ GetNbChannels()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetChannel()

◆ SetChannelsWorkWithLimits()

◆ SetFirstChannel()

◆ SetLastChannel()

◆ ThreadedGenerateData()

Member Data Documentation

◆ InputImageDimension

◆ m_Channels

◆ m_ChannelsKind

◆ m_ChannelsWorks

◆ m_FirstChannel

◆ m_LastChannel

◆ OutputImageDimension

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