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

#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< SelfPointer
 
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
itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension)> 
ExtractROIBaseRegionCopierType
 
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< SelfPointer
 
typedef ExtractROIBase Self
 
typedef
itk::ImageToImageFilter
< VectorImage< TInputPixelType, 2 >
, VectorImage
< TOutputPixelType, 2 > > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef VectorImage
< TInputPixelType, 2 > 
InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource
< VectorImage
< TOutputPixelType, 2 > > 
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
 
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 InputImageRegionType GetExtractionRegion ()
 
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< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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 VectorImage< TInputPixelType, 2 > *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 otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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 = InputImageType::ImageDimension
 
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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

void ChannelsReInitialization ()
 
 MultiChannelExtractROI ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void SetChannelsWorkWithLimits ()
 
virtual ~MultiChannelExtractROI ()
 
virtual void GenerateOutputInformation ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
- Protected Member Functions inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ExtractROIBase ()
 
virtual void GenerateInputRequestedRegion ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void SetInternalExtractionRegion (InputImageRegionType extractRegion)
 
void ThreadedGenerateData (const OutputImageRegionType &, itk::ThreadIdType)
 
virtual ~ExtractROIBase ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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 ()
 

Private Member Functions

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

Private Attributes

ChannelsType m_Channels
 
int m_ChannelsKind
 
ChannelsType m_ChannelsWorks
 
unsigned int m_FirstChannel
 
unsigned int m_LastChannel
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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)
 
- Protected Attributes inherited from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >
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
 

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 to select 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, FeatureExtraction/ExtractRoadByStepsExample.cxx, and Fusion/BayesianFusionImageFilter.cxx.

Definition at line 43 of file otbMultiChannelExtractROI.h.

Member Typedef Documentation

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

Typedef Liste des canaux

Definition at line 83 of file otbMultiChannelExtractROI.h.

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

Definition at line 51 of file otbMultiChannelExtractROI.h.

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

Definition at line 76 of file otbMultiChannelExtractROI.h.

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

Definition at line 72 of file otbMultiChannelExtractROI.h.

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

Definition at line 68 of file otbMultiChannelExtractROI.h.

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

Definition at line 78 of file otbMultiChannelExtractROI.h.

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

Image type information.

Definition at line 57 of file otbMultiChannelExtractROI.h.

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

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

Typedef to describe the type of pixel.

Definition at line 71 of file otbMultiChannelExtractROI.h.

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

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

Definition at line 77 of file otbMultiChannelExtractROI.h.

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

Definition at line 61 of file otbMultiChannelExtractROI.h.

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

Pixel type information

Definition at line 64 of file otbMultiChannelExtractROI.h.

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

Definition at line 50 of file otbMultiChannelExtractROI.h.

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

Standard class typedefs.

Definition at line 48 of file otbMultiChannelExtractROI.h.

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

Definition at line 49 of file otbMultiChannelExtractROI.h.

Constructor & Destructor Documentation

template<class TInputPixelType , class TOutputPixelType >
otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI ( )
protected

Definition at line 36 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
virtual otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::~MultiChannelExtractROI ( )
inlineprotectedvirtual

Definition at line 116 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::MultiChannelExtractROI ( const Self )
private

Member Function Documentation

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ChannelsReInitialization ( )
protected

Reinitialize channels vector for multiple Update.

Definition at line 130 of file otbMultiChannelExtractROI.txx.

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

Clear channels selection

Definition at line 106 of file otbMultiChannelExtractROI.txx.

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

Reimplemented from itk::Object.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GenerateOutputInformation ( void  )
protectedvirtual

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

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

Reimplemented from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >.

Examples:
FeatureExtraction/ExtractRoadByStepsExample.cxx, and Fusion/BayesianFusionImageFilter.cxx.

Definition at line 209 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetChannels ( ) const
inline
Returns
The list of processed channels

Definition at line 89 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetFirstChannel ( ) const
virtual
template<class TInputPixelType , class TOutputPixelType >
virtual unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetLastChannel ( ) const
virtual
template<class TInputPixelType , class TOutputPixelType >
virtual const char* otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::ExtractROIBase< VectorImage< TInputPixelType, 2 >, VectorImage< TOutputPixelType, 2 > >.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::GetNbChannels ( ) const
inline
Returns
The number of processed channels

Definition at line 95 of file otbMultiChannelExtractROI.h.

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

Method for creation through the object factory.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::operator= ( const Self )
private
template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::SetChannel ( unsigned int  channel)

Select a channel to process

Parameters
channelThe channel to process

Definition at line 51 of file otbMultiChannelExtractROI.txx.

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

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 174 of file otbMultiChannelExtractROI.txx.

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

Definition at line 69 of file otbMultiChannelExtractROI.txx.

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

Definition at line 86 of file otbMultiChannelExtractROI.txx.

template<class TInputPixelType , class TOutputPixelType >
void otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protectedvirtual

ExtractImageFilter can be implemented as a multithreaded filter.

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 261 of file otbMultiChannelExtractROI.txx.

Member Data Documentation

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

ImageDimension enumeration

Definition at line 109 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_Channels
private

List of channels to process [1...]

Definition at line 150 of file otbMultiChannelExtractROI.h.

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

template<class TInputPixelType , class TOutputPixelType >
ChannelsType otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_ChannelsWorks
private

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

Definition at line 153 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_FirstChannel
private

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

Definition at line 146 of file otbMultiChannelExtractROI.h.

template<class TInputPixelType , class TOutputPixelType >
unsigned int otb::MultiChannelExtractROI< TInputPixelType, TOutputPixelType >::m_LastChannel
private

Definition at line 147 of file otbMultiChannelExtractROI.h.

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

ImageDimension enumeration

Definition at line 111 of file otbMultiChannelExtractROI.h.


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