otb::ExtractROI< TInputPixel, TOutputPixel > Class Template Reference

#include <otbExtractROI.h>

Inheritance diagram for otb::ExtractROI< TInputPixel, TOutputPixel >:

Collaboration diagram for otb::ExtractROI< TInputPixel, TOutputPixel >:

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 itk::SmartPointer< Self >	Pointer
typedef ExtractROI	Self
typedef ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >	Superclass
Public Types inherited from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Image< TInputPixel, 2 > ::IndexType	InputImageIndexType
typedef Image< TInputPixel, 2 > ::PixelType	InputImagePixelType
typedef Image< TInputPixel, 2 > ::RegionType	InputImageRegionType
typedef Image< TInputPixel, 2 > ::SizeType	InputImageSizeType
typedef Image< TInputPixel, 2 >	InputImageType
typedef Image< TOutputPixel, 2 > ::IndexType	OutputImageIndexType
typedef Image< TOutputPixel, 2 > ::PixelType	OutputImagePixelType
typedef Image< TOutputPixel, 2 > ::RegionType	OutputImageRegionType
typedef Image< TOutputPixel, 2 > ::SizeType	OutputImageSizeType
typedef Image< TOutputPixel, 2 >	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef ExtractROIBase	Self
typedef itk::ImageToImageFilter< Image< TInputPixel, 2 >, Image< TOutputPixel, 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< Image< TInputPixel, 2 >, Image< TOutputPixel, 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< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >
static Pointer	New ()
static const unsigned int	InputImageDimension = InputImageType::ImageDimension
static const unsigned int	OutputImageDimension = OutputImageType::ImageDimension
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
	ExtractROI ()
	~ExtractROI () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateOutputInformation () override
	ExtractROI (const Self &)=delete
void	operator= (const Self &)=delete

Additional Inherited Members
Static Public Attributes inherited from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Protected Member Functions inherited from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 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< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >
InputImageRegionType	m_ExtractionRegion
OutputImageRegionType	m_OutputImageRegion

Detailed Description

template<class TInputPixel, class TOutputPixel>
class otb::ExtractROI< TInputPixel, TOutputPixel >

Extract a subset of a mono-channel image.

Pixel can be of a simple type or an itk::RGBPixel, etc.

Note

Parameter to this class are the input pixel type and the output pixel type.

Definition at line 43 of file otbExtractROI.h.

Member Typedef Documentation

ConstPointer

template<class TInputPixel , class TOutputPixel >

typedef itk::SmartPointer<const Self> otb::ExtractROI< TInputPixel, TOutputPixel >::ConstPointer

Definition at line 50 of file otbExtractROI.h.

InputImageIndexType

template<class TInputPixel , class TOutputPixel >

typedef InputImageType::IndexType otb::ExtractROI< TInputPixel, TOutputPixel >::InputImageIndexType

Definition at line 72 of file otbExtractROI.h.

InputImagePixelType

template<class TInputPixel , class TOutputPixel >

typedef InputImageType::PixelType otb::ExtractROI< TInputPixel, TOutputPixel >::InputImagePixelType

Definition at line 68 of file otbExtractROI.h.

InputImageRegionType

template<class TInputPixel , class TOutputPixel >

typedef InputImageType::RegionType otb::ExtractROI< TInputPixel, TOutputPixel >::InputImageRegionType

Definition at line 64 of file otbExtractROI.h.

InputImageSizeType

template<class TInputPixel , class TOutputPixel >

typedef InputImageType::SizeType otb::ExtractROI< TInputPixel, TOutputPixel >::InputImageSizeType

Definition at line 74 of file otbExtractROI.h.

InputImageType

template<class TInputPixel , class TOutputPixel >

typedef Superclass::InputImageType otb::ExtractROI< TInputPixel, TOutputPixel >::InputImageType

Image type information.

Definition at line 56 of file otbExtractROI.h.

OutputImageIndexType

template<class TInputPixel , class TOutputPixel >

typedef OutputImageType::IndexType otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImageIndexType

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

Definition at line 71 of file otbExtractROI.h.

OutputImagePixelType

template<class TInputPixel , class TOutputPixel >

typedef OutputImageType::PixelType otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 67 of file otbExtractROI.h.

OutputImageRegionType

template<class TInputPixel , class TOutputPixel >

typedef OutputImageType::RegionType otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 63 of file otbExtractROI.h.

OutputImageSizeType

template<class TInputPixel , class TOutputPixel >

typedef OutputImageType::SizeType otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImageSizeType

Definition at line 73 of file otbExtractROI.h.

OutputImageType

template<class TInputPixel , class TOutputPixel >

typedef Superclass::OutputImageType otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImageType

Definition at line 60 of file otbExtractROI.h.

Pointer

template<class TInputPixel , class TOutputPixel >

typedef itk::SmartPointer<Self> otb::ExtractROI< TInputPixel, TOutputPixel >::Pointer

Definition at line 49 of file otbExtractROI.h.

Self

template<class TInputPixel , class TOutputPixel >

typedef ExtractROI otb::ExtractROI< TInputPixel, TOutputPixel >::Self

Standard class typedefs.

Definition at line 47 of file otbExtractROI.h.

Superclass

template<class TInputPixel , class TOutputPixel >

typedef ExtractROIBase<Image<TInputPixel, 2>, Image<TOutputPixel, 2> > otb::ExtractROI< TInputPixel, TOutputPixel >::Superclass

Definition at line 48 of file otbExtractROI.h.

Constructor & Destructor Documentation

ExtractROI() [1/2]

template<class TInputPixel , class TOutputPixel >

otb::ExtractROI< TInputPixel, TOutputPixel >::ExtractROI

protected

ImageDimension enumeration

Definition at line 35 of file otbExtractROI.hxx.

~ExtractROI()

template<class TInputPixel , class TOutputPixel >

otb::ExtractROI< TInputPixel, TOutputPixel >::~ExtractROI ( )

inlineoverrideprotected

ImageDimension enumeration

Definition at line 85 of file otbExtractROI.h.

ExtractROI() [2/2]

template<class TInputPixel , class TOutputPixel >

otb::ExtractROI< TInputPixel, TOutputPixel >::ExtractROI ( const Self &  )

privatedelete

ImageDimension enumeration

Member Function Documentation

CreateAnother()

template<class TInputPixel , class TOutputPixel >

virtual::itk::LightObject::Pointer otb::ExtractROI< TInputPixel, TOutputPixel >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputPixel , class TOutputPixel >

void otb::ExtractROI< TInputPixel, TOutputPixel >::GenerateOutputInformation

overrideprotected

ExtractROI

See also

ExtractROIBase::GenerateOutputInformation()

ExtractROI can produce an image which is a different resolution than its input image. As such, ExtractROI 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 58 of file otbExtractROI.hxx.

GetNameOfClass()

template<class TInputPixel , class TOutputPixel >

virtual const char* otb::ExtractROI< TInputPixel, TOutputPixel >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

New()

template<class TInputPixel , class TOutputPixel >

static Pointer otb::ExtractROI< TInputPixel, TOutputPixel >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputPixel , class TOutputPixel >

void otb::ExtractROI< TInputPixel, TOutputPixel >::operator= ( const Self &  )

privatedelete

ImageDimension enumeration

PrintSelf()

template<class TInputPixel , class TOutputPixel >

void otb::ExtractROI< TInputPixel, TOutputPixel >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

ImageDimension enumeration

Definition at line 43 of file otbExtractROI.hxx.

ThreadedGenerateData()

template<class TInputPixel , class TOutputPixel >

void otb::ExtractROI< TInputPixel, TOutputPixel >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

override

ImageDimension enumeration

Definition at line 65 of file otbExtractROI.hxx.

Member Data Documentation

InputImageDimension

template<class TInputPixel , class TOutputPixel >

const unsigned int otb::ExtractROI< TInputPixel, TOutputPixel >::InputImageDimension = InputImageType::ImageDimension

static

ImageDimension enumeration

Definition at line 77 of file otbExtractROI.h.

OutputImageDimension

template<class TInputPixel , class TOutputPixel >

const unsigned int otb::ExtractROI< TInputPixel, TOutputPixel >::OutputImageDimension = OutputImageType::ImageDimension

static

ImageDimension enumeration

Definition at line 78 of file otbExtractROI.h.

---

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

• otbExtractROI.h
• otbExtractROI.hxx