OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
otb::ExtractROIBase< TInputImage, TOutputImage > Class Template Reference

#include <otbExtractROIBase.h>

+ Inheritance diagram for otb::ExtractROIBase< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ExtractROIBase< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension)> 
ExtractROIBaseRegionCopierType
 
typedef TInputImage::IndexType InputImageIndexType
 
typedef TInputImage::PixelType InputImagePixelType
 
typedef TInputImage::RegionType InputImageRegionType
 
typedef TInputImage::SizeType InputImageSizeType
 
typedef TInputImage InputImageType
 
typedef TOutputImage::IndexType OutputImageIndexType
 
typedef TOutputImage::PixelType OutputImagePixelType
 
typedef TOutputImage::RegionType OutputImageRegionType
 
typedef TOutputImage::SizeType OutputImageSizeType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ExtractROIBase Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual InputImageRegionType GetExtractionRegion ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned long GetStartX () const
 
virtual unsigned long GetStartY () const
 
void SetExtractionRegion (InputImageRegionType roi)
 
virtual void SetStartX (unsigned long _arg)
 
virtual void SetStartY (unsigned long _arg)
 
virtual void SetSizeX (unsigned long _arg)
 
virtual unsigned long GetSizeX () const
 
virtual void SetSizeY (unsigned long _arg)
 
virtual unsigned long GetSizeY () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual double GetCoordinateTolerance () const
 
virtual double GetDirectionTolerance () const
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual void SetDirectionTolerance (double _arg)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
const OutputImageTypeGetOutput (void) const
 
OutputImageTypeGetOutput (void)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ExtractROIBase ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &, itk::ThreadIdType)
 
virtual ~ExtractROIBase ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
void SetInternalExtractionRegion (InputImageRegionType extractRegion)
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
virtual void VerifyInputInformation ()
 
 ~ImageToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () ITK_OVERRIDE
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

InputImageRegionType m_ExtractionRegion
 
OutputImageRegionType m_OutputImageRegion
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

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

Private Attributes

unsigned long m_SizeX
 
unsigned long m_SizeY
 
unsigned long m_StartX
 
unsigned long m_StartY
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::ExtractROIBase< TInputImage, TOutputImage >

Base class to extract area of images.

Extracted region can be defined by the methods SetStartX/Y (region origin) and SetSizeX/Y (region size). If the starting point is not defined, the extracted region start from the upper left corner of the input image. If the size is not defined, the extracted region extend to the lower right corner of the input image. If no parameter is defined all image is extracted.

Alternatively, a region can be specified using the SetROI() method.

Definition at line 45 of file otbExtractROIBase.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef itk::SmartPointer<const Self> otb::ExtractROIBase< TInputImage, TOutputImage >::ConstPointer

Definition at line 53 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> otb::ExtractROIBase< TInputImage, TOutputImage >::ExtractROIBaseRegionCopierType

Definition at line 89 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::IndexType otb::ExtractROIBase< TInputImage, TOutputImage >::InputImageIndexType

Definition at line 75 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::PixelType otb::ExtractROIBase< TInputImage, TOutputImage >::InputImagePixelType

Definition at line 71 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::RegionType otb::ExtractROIBase< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 67 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage::SizeType otb::ExtractROIBase< TInputImage, TOutputImage >::InputImageSizeType

Definition at line 77 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TInputImage otb::ExtractROIBase< TInputImage, TOutputImage >::InputImageType

Image type information.

Definition at line 59 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::IndexType otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImageIndexType

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

Definition at line 74 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::PixelType otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 70 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::RegionType otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

Definition at line 66 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage::SizeType otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImageSizeType

Definition at line 76 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef TOutputImage otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImageType

Definition at line 63 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef itk::SmartPointer<Self> otb::ExtractROIBase< TInputImage, TOutputImage >::Pointer

Definition at line 52 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef ExtractROIBase otb::ExtractROIBase< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 50 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::ExtractROIBase< TInputImage, TOutputImage >::Superclass

Definition at line 51 of file otbExtractROIBase.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
otb::ExtractROIBase< TInputImage, TOutputImage >::ExtractROIBase ( )
protected

Definition at line 35 of file otbExtractROIBase.txx.

template<class TInputImage, class TOutputImage>
virtual otb::ExtractROIBase< TInputImage, TOutputImage >::~ExtractROIBase ( )
inlineprotectedvirtual

Definition at line 111 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
otb::ExtractROIBase< TInputImage, TOutputImage >::ExtractROIBase ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::CallCopyOutputRegionToInputRegion ( InputImageRegionType destRegion,
const OutputImageRegionType srcRegion 
)
protectedvirtual

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractROIBase can support output images of a lower dimension that the input.

See Also
ImageToImageFilter::CallCopyRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 60 of file otbExtractROIBase.txx.

template<class TInputImage, class TOutputImage>
virtual::itk::LightObject::Pointer otb::ExtractROIBase< TInputImage, TOutputImage >::CreateAnother ( void  ) const
virtual
template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( void  )
protectedvirtual

ExtractROIBase can produce an image which is a different resolution than its input image. As such, ExtractROIBase 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 itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 128 of file otbExtractROIBase.txx.

References otbMsgDevMacro.

template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
protectedvirtual

ExtractROIBase can produce an image which is a different resolution than its input image. As such, ExtractROIBase 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 itk::ProcessObject.

Reimplemented in otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >, otb::MultiToMonoChannelExtractROI< TInputPixelType, TOutputPixelType >, otb::ImageOfVectorsToMonoChannelExtractROI< TInputImage, TOutputImage >, and otb::ExtractROI< TInputPixel, TOutputPixel >.

Definition at line 172 of file otbExtractROIBase.txx.

template<class TInputImage, class TOutputImage>
virtual InputImageRegionType otb::ExtractROIBase< TInputImage, TOutputImage >::GetExtractionRegion ( )
virtual
template<class TInputImage, class TOutputImage>
virtual const char* otb::ExtractROIBase< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TOutputImage>
virtual unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::GetSizeX ( ) const
virtual

Set/Get Size methods

template<class TInputImage, class TOutputImage>
virtual unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::GetSizeY ( ) const
virtual

Set/Get Size methods

template<class TInputImage, class TOutputImage>
virtual unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::GetStartX ( ) const
virtual
template<class TInputImage, class TOutputImage>
virtual unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::GetStartY ( ) const
virtual
template<class TInputImage, class TOutputImage>
static Pointer otb::ExtractROIBase< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage, class TOutputImage>
void otb::ExtractROIBase< TInputImage, TOutputImage >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::SetExtractionRegion ( InputImageRegionType  roi)
template<class TInputImage , class TOutputImage >
void otb::ExtractROIBase< TInputImage, TOutputImage >::SetInternalExtractionRegion ( InputImageRegionType  extractRegion)
protected

Set/Get the output image region. If any of the ExtractionRegion.Size = 0 for any particular dimension dim, we have to collapse dimension dim. This means the output image will have 'c' dimensions less than the input image, where c = # of ExtractionRegion.Size = 0.

check to see if the number of non-zero entries in the extraction region matches the number of dimensions in the output image.

Definition at line 77 of file otbExtractROIBase.txx.

template<class TInputImage, class TOutputImage>
virtual void otb::ExtractROIBase< TInputImage, TOutputImage >::SetSizeX ( unsigned long  _arg)
virtual

Set/Get Size methods

template<class TInputImage, class TOutputImage>
virtual void otb::ExtractROIBase< TInputImage, TOutputImage >::SetSizeY ( unsigned long  _arg)
virtual

Set/Get Size methods

template<class TInputImage, class TOutputImage>
virtual void otb::ExtractROIBase< TInputImage, TOutputImage >::SetStartX ( unsigned long  _arg)
virtual

Set/Get Start methods

template<class TInputImage, class TOutputImage>
virtual void otb::ExtractROIBase< TInputImage, TOutputImage >::SetStartY ( unsigned long  _arg)
virtual
template<class TInputImage, class TOutputImage>
void otb::ExtractROIBase< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType ,
itk::ThreadIdType   
)
inlineprotectedvirtual

ExtractROIBase can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

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

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageOfVectorsToMonoChannelExtractROI< TInputImage, TOutputImage >.

Definition at line 151 of file otbExtractROIBase.h.

Member Data Documentation

template<class TInputImage, class TOutputImage>
const unsigned int otb::ExtractROIBase< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension enumeration

Definition at line 81 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
InputImageRegionType otb::ExtractROIBase< TInputImage, TOutputImage >::m_ExtractionRegion
protected

Definition at line 165 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
OutputImageRegionType otb::ExtractROIBase< TInputImage, TOutputImage >::m_OutputImageRegion
protected

Definition at line 166 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::m_SizeX
private

Number of X/Y pixels of the region to extract.

Definition at line 177 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::m_SizeY
private

Definition at line 178 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::m_StartX
private

X/Y coordinates of the first point of the region to extract.

Definition at line 173 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
unsigned long otb::ExtractROIBase< TInputImage, TOutputImage >::m_StartY
private

Definition at line 174 of file otbExtractROIBase.h.

template<class TInputImage, class TOutputImage>
const unsigned int otb::ExtractROIBase< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension enumeration

Definition at line 83 of file otbExtractROIBase.h.


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