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 | Private Attributes | List of all members
otb::VectorImage< TPixel, VImageDimension > Class Template Reference

Creation of an "otb" vector image which contains metadata. More...

#include <otbVectorImage.h>

+ Inheritance diagram for otb::VectorImage< TPixel, VImageDimension >:
+ Collaboration diagram for otb::VectorImage< TPixel, VImageDimension >:

Public Types

typedef
itk::DefaultVectorPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::WeakPointer
< const Self
ConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef
ImageMetadataInterfaceBase::ImageKeywordlistType 
ImageKeywordlistType
 
typedef
ImageMetadataInterfaceBase::Pointer 
ImageMetadataInterfacePointerType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::IOPixelType IOPixelType
 
typedef
itk::VectorImageNeighborhoodAccessorFunctor
< Self
NeighborhoodAccessorFunctorType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef Superclass::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
typedef VectorImage Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SpacingType SpacingType
 
typedef itk::VectorImage
< TPixel, VImageDimension > 
Superclass
 
typedef Superclass::ValueType ValueType
 
typedef
ImageMetadataInterfaceBase::VectorType 
VectorType
 
- Public Types inherited from itk::VectorImage< TPixel, VImageDimension >
typedef
DefaultVectorPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef
DefaultVectorPixelAccessor
< InternalPixelType
AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef TPixel InternalPixelType
 
typedef InternalPixelType IOPixelType
 
typedef
VectorImageNeighborhoodAccessorFunctor
< Self
NeighborhoodAccessorFunctorType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::OffsetValueType OffsetValueType
 
typedef ImportImageContainer
< SizeValueType,
InternalPixelType
PixelContainer
 
typedef
PixelContainer::ConstPointer 
PixelContainerConstPointer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef VariableLengthVector
< TPixel > 
PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
typedef VectorImage Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SpacingType SpacingType
 
typedef ImageBase
< VImageDimension > 
Superclass
 
typedef PixelType ValueType
 
typedef unsigned int VectorLengthType
 

Public Member Functions

virtual void CopyInformation (const itk::DataObject *)
 Copy metadata from a DataObject. More...
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual double GetGCPCol (unsigned int GCPnum) const
 
virtual unsigned int GetGCPCount (void) const
 
virtual std::string GetGCPId (unsigned int GCPnum) const
 
virtual std::string GetGCPInfo (unsigned int GCPnum) const
 
virtual std::string GetGCPProjection (void) const
 
virtual double GetGCPRow (unsigned int GCPnum) const
 
virtual OTB_GCPGetGCPs (unsigned int GCPnum)
 
virtual const OTB_GCPGetGCPs (unsigned int GCPnum) const
 
virtual double GetGCPX (unsigned int GCPnum) const
 
virtual double GetGCPY (unsigned int GCPnum) const
 
virtual double GetGCPZ (unsigned int GCPnum) const
 
virtual VectorType GetGeoTransform (void) const
 
virtual ImageKeywordlistType GetImageKeywordlist (void)
 
virtual const ImageKeywordlistType GetImageKeywordlist (void) const
 
virtual VectorType GetLowerLeftCorner (void) const
 
virtual VectorType GetLowerRightCorner (void) const
 
virtual const char * GetNameOfClass () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const
NeighborhoodAccessorFunctorType 
GetNeighborhoodAccessor () const
 
virtual std::string GetProjectionRef (void) const
 
virtual VectorType GetUpperLeftCorner (void) const
 
virtual VectorType GetUpperRightCorner (void) const
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Public Member Functions inherited from itk::VectorImage< TPixel, VImageDimension >
virtual void Allocate (bool UseDefaultConstructor=false) ITK_OVERRIDE
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FillBuffer (const PixelType &value)
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const
NeighborhoodAccessorFunctorType 
GetNeighborhoodAccessor () const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
const PixelType GetPixel (const IndexType &index) const
 
PixelType GetPixel (const IndexType &index)
 
AccessorType GetPixelAccessor (void)
 
const AccessorType GetPixelAccessor (void) const
 
PixelContainerGetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual const VectorLengthTypeGetVectorLength () const
 
virtual void Graft (const DataObject *data)
 
virtual void Initialize ()
 
PixelType operator[] (const IndexType &index)
 
const PixelType operator[] (const IndexType &index) const
 
virtual void SetNumberOfComponentsPerPixel (unsigned int n)
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelContainer (PixelContainer *container)
 
virtual void SetVectorLength (VectorLengthType _arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::VectorImage< TPixel, VImageDimension >
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
- Static Public Attributes inherited from itk::VectorImage< TPixel, VImageDimension >
static const unsigned int ImageDimension
 

Protected Member Functions

 VectorImage ()
 
virtual ~VectorImage ()
 
- Protected Member Functions inherited from itk::VectorImage< TPixel, VImageDimension >
 VectorImage ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
- Protected Member Functions inherited from itk::ImageBase< VImageDimension >
virtual void ComputeIndexToPhysicalPointMatrices ()
 

Private Member Functions

 VectorImage (const Self &)
 
ImageMetadataInterfacePointerType GetMetaDataInterface () const
 
void operator= (const Self &)
 

Private Attributes

ImageMetadataInterfacePointerType m_ImageMetadataInterface
 

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2>
class otb::VectorImage< TPixel, VImageDimension >

Creation of an "otb" vector image which contains metadata.

Examples:
FeatureExtraction/CloudDetectionExample.cxx, FeatureExtraction/ExtractRoadByStepsExample.cxx, FeatureExtraction/ExtractRoadExample.cxx, Fusion/BayesianFusionImageFilter.cxx, Fusion/PanSharpeningExample.cxx, Projections/OrthoRectificationExample.cxx, and Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 31 of file otbVectorImage.h.

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::DefaultVectorPixelAccessorFunctor<Self> otb::VectorImage< TPixel, VImageDimension >::AccessorFunctorType

Accessor type that convert data between internal and external representations. Functor to provide a common API between DefaultPixelAccessor and DefaultVectorPixelAccessor

Definition at line 73 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::SmartPointer<const Self> otb::VectorImage< TPixel, VImageDimension >::ConstPointer

Definition at line 39 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::WeakPointer<const Self> otb::VectorImage< TPixel, VImageDimension >::ConstWeakPointer

Definition at line 40 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::DirectionType otb::VectorImage< TPixel, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.

Definition at line 98 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImageMetadataInterfaceBase::ImageKeywordlistType otb::VectorImage< TPixel, VImageDimension >::ImageKeywordlistType

Definition at line 43 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImageMetadataInterfaceBase::Pointer otb::VectorImage< TPixel, VImageDimension >::ImageMetadataInterfacePointerType

Definition at line 44 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::IndexType otb::VectorImage< TPixel, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 89 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::InternalPixelType otb::VectorImage< TPixel, VImageDimension >::InternalPixelType

Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation.

Definition at line 63 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::IOPixelType otb::VectorImage< TPixel, VImageDimension >::IOPixelType

Definition at line 65 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::VectorImageNeighborhoodAccessorFunctor< Self> otb::VectorImage< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType

Tyepdef for the functor used to access a neighborhood of pixel pointers.

Definition at line 77 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::OffsetType otb::VectorImage< TPixel, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values.

Definition at line 92 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::PixelContainer otb::VectorImage< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Definition at line 86 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::PixelType otb::VectorImage< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations.

Definition at line 50 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::SmartPointer<Self> otb::VectorImage< TPixel, VImageDimension >::Pointer

Definition at line 38 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::PointType otb::VectorImage< TPixel, VImageDimension >::PointType

Origin typedef support. The origin is the geometric coordinates of the index (0, 0).

Definition at line 109 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::RegionType otb::VectorImage< TPixel, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image.

Definition at line 101 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef VectorImage otb::VectorImage< TPixel, VImageDimension >::Self

Standard class typedefs.

Definition at line 36 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::SizeType otb::VectorImage< TPixel, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 95 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::SpacingType otb::VectorImage< TPixel, VImageDimension >::SpacingType

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 105 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef itk::VectorImage<TPixel, VImageDimension> otb::VectorImage< TPixel, VImageDimension >::Superclass

Definition at line 37 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::ValueType otb::VectorImage< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 57 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImageMetadataInterfaceBase::VectorType otb::VectorImage< TPixel, VImageDimension >::VectorType

Definition at line 42 of file otbVectorImage.h.

Constructor & Destructor Documentation

template<class TPixel , unsigned int VImageDimension>
otb::VectorImage< TPixel, VImageDimension >::VectorImage ( )
protected

Definition at line 31 of file otbVectorImage.txx.

template<class TPixel, unsigned int VImageDimension = 2>
virtual otb::VectorImage< TPixel, VImageDimension >::~VectorImage ( )
inlineprotectedvirtual

Reimplemented from itk::VectorImage< TPixel, VImageDimension >.

Definition at line 174 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
otb::VectorImage< TPixel, VImageDimension >::VectorImage ( const Self )
private

Member Function Documentation

template<class TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::CopyInformation ( const itk::DataObject data)
virtual

Copy metadata from a DataObject.

Definition at line 169 of file otbVectorImage.txx.

template<class TPixel, unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer otb::VectorImage< TPixel, VImageDimension >::CreateAnother ( void  ) const
template<class TPixel , unsigned int VImageDimension>
double otb::VectorImage< TPixel, VImageDimension >::GetGCPCol ( unsigned int  GCPnum) const
virtual

Definition at line 84 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
unsigned int otb::VectorImage< TPixel, VImageDimension >::GetGCPCount ( void  ) const
virtual

Definition at line 48 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
std::string otb::VectorImage< TPixel, VImageDimension >::GetGCPId ( unsigned int  GCPnum) const
virtual

Definition at line 66 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
std::string otb::VectorImage< TPixel, VImageDimension >::GetGCPInfo ( unsigned int  GCPnum) const
virtual

Definition at line 72 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
std::string otb::VectorImage< TPixel, VImageDimension >::GetGCPProjection ( void  ) const
virtual

Get the GCP projection coordinates of the image.

Definition at line 42 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
double otb::VectorImage< TPixel, VImageDimension >::GetGCPRow ( unsigned int  GCPnum) const
virtual

Definition at line 78 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
OTB_GCP & otb::VectorImage< TPixel, VImageDimension >::GetGCPs ( unsigned int  GCPnum)
virtual

Definition at line 54 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
const OTB_GCP & otb::VectorImage< TPixel, VImageDimension >::GetGCPs ( unsigned int  GCPnum) const
virtual

Definition at line 60 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
double otb::VectorImage< TPixel, VImageDimension >::GetGCPX ( unsigned int  GCPnum) const
virtual

Definition at line 90 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
double otb::VectorImage< TPixel, VImageDimension >::GetGCPY ( unsigned int  GCPnum) const
virtual

Definition at line 96 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
double otb::VectorImage< TPixel, VImageDimension >::GetGCPZ ( unsigned int  GCPnum) const
virtual

Definition at line 102 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::VectorType otb::VectorImage< TPixel, VImageDimension >::GetGeoTransform ( void  ) const
virtual

Get the six coefficients of affine geoTtransform.

Definition at line 109 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::ImageKeywordlistType otb::VectorImage< TPixel, VImageDimension >::GetImageKeywordlist ( void  )
virtual

Get image keyword list

Definition at line 144 of file otbVectorImage.txx.

References otb::MetaDataKey::OSSIMKeywordlistKey.

template<class TPixel , unsigned int VImageDimension>
const VectorImage< TPixel, VImageDimension >::ImageKeywordlistType otb::VectorImage< TPixel, VImageDimension >::GetImageKeywordlist ( void  ) const
virtual

Definition at line 156 of file otbVectorImage.txx.

References otb::MetaDataKey::OSSIMKeywordlistKey.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::VectorType otb::VectorImage< TPixel, VImageDimension >::GetLowerLeftCorner ( void  ) const
virtual

Definition at line 130 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::VectorType otb::VectorImage< TPixel, VImageDimension >::GetLowerRightCorner ( void  ) const
virtual

Definition at line 137 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::ImageMetadataInterfacePointerType otb::VectorImage< TPixel, VImageDimension >::GetMetaDataInterface ( ) const
private

Return the ImageMetadataInterfacePointer associated to the data and creates it on first call

Definition at line 178 of file otbVectorImage.txx.

References otb::ImageMetadataInterfaceFactory::CreateIMI().

template<class TPixel, unsigned int VImageDimension = 2>
virtual const char* otb::VectorImage< TPixel, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::VectorImage< TPixel, VImageDimension >.

template<class TPixel, unsigned int VImageDimension = 2>
NeighborhoodAccessorFunctorType otb::VectorImage< TPixel, VImageDimension >::GetNeighborhoodAccessor ( )
inline

Return the Pixel Accessor object Return the Pixel Accesor object Return the NeighborhoodAccessor functor

Definition at line 161 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
const NeighborhoodAccessorFunctorType otb::VectorImage< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const
inline

Return the NeighborhoodAccessor functor

Definition at line 167 of file otbVectorImage.h.

template<class TPixel , unsigned int VImageDimension>
std::string otb::VectorImage< TPixel, VImageDimension >::GetProjectionRef ( void  ) const
virtual

Get the projection coordinate system of the image.

Definition at line 36 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::VectorType otb::VectorImage< TPixel, VImageDimension >::GetUpperLeftCorner ( void  ) const
virtual

Get image corners.

Definition at line 116 of file otbVectorImage.txx.

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::VectorType otb::VectorImage< TPixel, VImageDimension >::GetUpperRightCorner ( void  ) const
virtual

Definition at line 123 of file otbVectorImage.txx.

template<class TPixel, unsigned int VImageDimension = 2>
static Pointer otb::VectorImage< TPixel, VImageDimension >::New ( )
static
template<class TPixel, unsigned int VImageDimension = 2>
void otb::VectorImage< TPixel, VImageDimension >::operator= ( const Self )
private
template<class TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
virtual

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 187 of file otbVectorImage.txx.

Member Data Documentation

template<class TPixel, unsigned int VImageDimension = 2>
const unsigned int otb::VectorImage< TPixel, VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Definition at line 83 of file otbVectorImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
ImageMetadataInterfacePointerType otb::VectorImage< TPixel, VImageDimension >::m_ImageMetadataInterface
mutableprivate

Definition at line 186 of file otbVectorImage.h.


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