OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::VectorImage< TPixel, VImageDimension > Class Template Reference

#include <otbVectorImage.h>

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

Public Types

typedef itk::DefaultVectorPixelAccessorFunctor< SelfAccessorFunctorType
 
using ConstPointer = itk::SmartPointer< const Self >
 
using ConstWeakPointer = itk::WeakPointer< const Self >
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::InternalPixelType InternalPixelType
 
typedef Superclass::IOPixelType IOPixelType
 
typedef itk::VectorImageNeighborhoodAccessorFunctor< SelfNeighborhoodAccessorFunctorType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef Superclass::PixelType PixelType
 
using Pointer = itk::SmartPointer< Self >
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
using Self = VectorImage
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SpacingType SpacingType
 
using Superclass = itk::VectorImage< TPixel, VImageDimension >
 
typedef Superclass::ValueType ValueType
 
using VectorType = ImageMetadataInterfaceBase::VectorType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual VectorType GetGeoTransform (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::ImageCommons
double GetGCPCol (unsigned int GCPnum) const
 
unsigned int GetGCPCount (void) const
 
std::string GetGCPId (unsigned int GCPnum) const
 
std::string GetGCPInfo (unsigned int GCPnum) const
 
std::string GetGCPProjection (void) const
 
double GetGCPRow (unsigned int GCPnum) const
 
const GCPGetGCPs (unsigned int GCPnum) const
 
double GetGCPX (unsigned int GCPnum) const
 
double GetGCPY (unsigned int GCPnum) const
 
double GetGCPZ (unsigned int GCPnum) const
 
ImageMetadataGetImageMetadata ()
 
const ImageMetadataGetImageMetadata () const
 
std::string GetProjectionRef (void) const
 
bool HasSensorGeometry () const
 
void SetBandImageMetadata (ImageMetadata::ImageMetadataBandsType imd)
 
void SetImageMetadata (ImageMetadata imd)
 
void SetProjectionRef (const std::string &wkt)
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
VectorType GetUpperLeftCorner (void) const
 
VectorType GetUpperRightCorner (void) const
 
VectorType GetLowerLeftCorner (void) const
 
VectorType GetLowerRightCorner (void) const
 
SpacingType GetSignedSpacing () const
 
virtual void SetSignedSpacing (SpacingType spacing)
 
virtual void SetSignedSpacing (double spacing[VImageDimension])
 
virtual void SetNumberOfComponentsPerPixel (unsigned int n) override
 
void CopyInformation (const itk::DataObject *) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor () const
 
 VectorImage ()
 
 ~VectorImage () override
 
 VectorImage (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Public Attributes inherited from otb::ImageCommons
ImageMetadata m_Imd
 

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, Fusion/BayesianFusionImageFilter.cxx, Fusion/PanSharpeningExample.cxx, and Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 45 of file otbVectorImage.h.

Member Typedef Documentation

◆ AccessorFunctorType

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 86 of file otbVectorImage.h.

◆ ConstPointer

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

Definition at line 54 of file otbVectorImage.h.

◆ ConstWeakPointer

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

Definition at line 55 of file otbVectorImage.h.

◆ DirectionType

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 110 of file otbVectorImage.h.

◆ IndexType

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 101 of file otbVectorImage.h.

◆ InternalPixelType

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 keeping a particular internal representation of data while showing a different external representation.

Definition at line 76 of file otbVectorImage.h.

◆ IOPixelType

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

Definition at line 78 of file otbVectorImage.h.

◆ NeighborhoodAccessorFunctorType

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 89 of file otbVectorImage.h.

◆ OffsetType

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 104 of file otbVectorImage.h.

◆ PixelContainer

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 98 of file otbVectorImage.h.

◆ PixelType

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 63 of file otbVectorImage.h.

◆ Pointer

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

Definition at line 53 of file otbVectorImage.h.

◆ PointType

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 121 of file otbVectorImage.h.

◆ RegionType

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 113 of file otbVectorImage.h.

◆ Self

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

Standard class typedefs.

Definition at line 51 of file otbVectorImage.h.

◆ SizeType

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 107 of file otbVectorImage.h.

◆ SpacingType

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 117 of file otbVectorImage.h.

◆ Superclass

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

Definition at line 52 of file otbVectorImage.h.

◆ ValueType

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

Typedef alias for PixelType

Definition at line 70 of file otbVectorImage.h.

◆ VectorType

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

Definition at line 57 of file otbVectorImage.h.

Constructor & Destructor Documentation

◆ VectorImage() [1/2]

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

Get image corners.

Definition at line 32 of file otbVectorImage.hxx.

◆ ~VectorImage()

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

Get image corners.

Definition at line 177 of file otbVectorImage.h.

◆ VectorImage() [2/2]

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

Get image corners.

Member Function Documentation

◆ CopyInformation()

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

Copy metadata from a DataObject.

Definition at line 80 of file otbVectorImage.hxx.

◆ CreateAnother()

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

◆ GetGeoTransform()

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 115 of file otbVectorImage.hxx.

◆ GetLowerLeftCorner()

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

Get image corners.

Definition at line 159 of file otbVectorImage.hxx.

◆ GetLowerRightCorner()

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

Get image corners.

Definition at line 171 of file otbVectorImage.hxx.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetNeighborhoodAccessor() [1/2]

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

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

Definition at line 164 of file otbVectorImage.h.

◆ GetNeighborhoodAccessor() [2/2]

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

Return the NeighborhoodAccessor functor

Definition at line 170 of file otbVectorImage.h.

◆ GetSignedSpacing()

template<class TPixel , unsigned int VImageDimension>
VectorImage< TPixel, VImageDimension >::SpacingType otb::VectorImage< TPixel, VImageDimension >::GetSignedSpacing

Get signed spacing

Definition at line 38 of file otbVectorImage.hxx.

◆ GetUpperLeftCorner()

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

Get image corners.

Definition at line 136 of file otbVectorImage.hxx.

◆ GetUpperRightCorner()

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

Get image corners.

Definition at line 147 of file otbVectorImage.hxx.

◆ New()

template<class TPixel , unsigned int VImageDimension = 2>
static Pointer otb::VectorImage< TPixel, VImageDimension >::New ( )
static

◆ operator=()

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

Get image corners.

◆ PrintSelf()

template<class TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
override

Get image corners.

Definition at line 183 of file otbVectorImage.hxx.

◆ SetNumberOfComponentsPerPixel()

template<typename TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int  n)
overridevirtual

◆ SetSignedSpacing() [1/2]

template<class TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::SetSignedSpacing ( double  spacing[VImageDimension])
virtual

Get image corners.

Definition at line 73 of file otbVectorImage.hxx.

◆ SetSignedSpacing() [2/2]

template<class TPixel , unsigned int VImageDimension>
void otb::VectorImage< TPixel, VImageDimension >::SetSignedSpacing ( SpacingType  spacing)
virtual

Set signed spacing

Definition at line 50 of file otbVectorImage.hxx.

Member Data Documentation

◆ ImageDimension

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 95 of file otbVectorImage.h.


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