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 | List of all members
otb::ExtractROI< TInputPixel, TOutputPixel > Class Template Reference

Extract a subset of a mono-channel image. More...

#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< SelfPointer
 
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
itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension)> 
ExtractROIBaseRegionCopierType
 
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< SelfPointer
 
typedef ExtractROIBase Self
 
typedef
itk::ImageToImageFilter< Image
< TInputPixel, 2 >, Image
< TOutputPixel, 2 > > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
- Public Member Functions inherited from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 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< Image< TInputPixel, 2 >, Image< TOutputPixel, 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< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 

Protected Member Functions

 ExtractROI ()
 
virtual ~ExtractROI ()
 
virtual void GenerateOutputInformation ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 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

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

Additional Inherited Members

- 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 37 of file otbExtractROI.h.

Member Typedef Documentation

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

Definition at line 45 of file otbExtractROI.h.

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

Definition at line 67 of file otbExtractROI.h.

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

Definition at line 63 of file otbExtractROI.h.

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

Definition at line 59 of file otbExtractROI.h.

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

Definition at line 69 of file otbExtractROI.h.

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

Image type information.

Definition at line 51 of file otbExtractROI.h.

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 66 of file otbExtractROI.h.

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

Typedef to describe the type of pixel.

Definition at line 62 of file otbExtractROI.h.

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 58 of file otbExtractROI.h.

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

Definition at line 68 of file otbExtractROI.h.

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

Definition at line 55 of file otbExtractROI.h.

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

Definition at line 44 of file otbExtractROI.h.

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

Standard class typedefs.

Definition at line 42 of file otbExtractROI.h.

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

Definition at line 43 of file otbExtractROI.h.

Constructor & Destructor Documentation

template<class TInputPixel , class TOutputPixel >
otb::ExtractROI< TInputPixel, TOutputPixel >::ExtractROI ( )
protected

Definition at line 34 of file otbExtractROI.txx.

template<class TInputPixel , class TOutputPixel >
virtual otb::ExtractROI< TInputPixel, TOutputPixel >::~ExtractROI ( )
inlineprotectedvirtual

Definition at line 82 of file otbExtractROI.h.

template<class TInputPixel , class TOutputPixel >
otb::ExtractROI< TInputPixel, TOutputPixel >::ExtractROI ( const Self )
private

Member Function Documentation

template<class TInputPixel , class TOutputPixel >
virtual::itk::LightObject::Pointer otb::ExtractROI< TInputPixel, TOutputPixel >::CreateAnother ( void  ) const
template<class TInputPixel , class TOutputPixel >
void otb::ExtractROI< TInputPixel, TOutputPixel >::GenerateOutputInformation ( void  )
protectedvirtual

ExtractROI

See Also
ExtractROIBase::GenerateOutputInformaton()

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

Reimplemented from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >.

Definition at line 61 of file otbExtractROI.txx.

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

Run-time type information (and related methods).

Reimplemented from otb::ExtractROIBase< Image< TInputPixel, 2 >, Image< TOutputPixel, 2 > >.

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

Method for creation through the object factory.

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

Definition at line 44 of file otbExtractROI.txx.

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

Definition at line 70 of file otbExtractROI.txx.

Member Data Documentation

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

ImageDimension enumeration

Definition at line 73 of file otbExtractROI.h.

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

Definition at line 75 of file otbExtractROI.h.


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