#include <otbImage.h>

Inheritance diagram for otb::Image< TPixel, VImageDimension >:

Collaboration diagram for otb::Image< TPixel, VImageDimension >:

Public Types
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::NeighborhoodAccessorFunctor< Self >	NeighborhoodAccessorFunctorType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::OffsetValueType	OffsetValueType

typedef Superclass::PixelContainer	PixelContainer

typedef PixelContainer::ConstPointer	PixelContainerConstPointer

typedef PixelContainer::Pointer	PixelContainerPointer

typedef Superclass::PixelType	PixelType

using	Pointer = itk::SmartPointer< Self >

typedef Superclass::PointType	PointType

typedef Superclass::RegionType	RegionType

using	Self = Image

typedef Superclass::SizeType	SizeType

typedef Superclass::SpacingType	SpacingType

using	Superclass = itk::Image< TPixel, VImageDimension >

typedef Superclass::ValueType	ValueType

using	VectorType = ImageMetadataInterfaceBase::VectorType

Public Member Functions
void	CopyInformation (const itk::DataObject *) override

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual VectorType	GetGeoTransform (void) const

virtual const char *	GetNameOfClass () const

NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()

const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const

SpacingType	GetSignedSpacing () const

void	PrintSelf (std::ostream &os, itk::Indent indent) const override


VectorType	GetUpperLeftCorner (void) const

VectorType	GetUpperRightCorner (void) const

VectorType	GetLowerLeftCorner (void) const

VectorType	GetLowerRightCorner (void) const


virtual void	SetSignedSpacing (SpacingType spacing)

virtual void	SetSignedSpacing (double spacing[VImageDimension])

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 GCP &	GetGCPs (unsigned int GCPnum) const

double	GetGCPX (unsigned int GCPnum) const

double	GetGCPY (unsigned int GCPnum) const

double	GetGCPZ (unsigned int GCPnum) const

const ImageMetadata &	GetImageMetadata () const

ImageMetadata &	GetImageMetadata ()

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

Protected Member Functions
	Image ()

	~Image () override

Private Member Functions
	Image (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::Image< TPixel, VImageDimension >

Creation of an "otb" image which contains metadata.

Examples:: BasicFilters/DEMToRainbowExample.cxx, BasicFilters/HillShadingExample.cxx, DisparityMap/FineRegistrationImageFilterExample.cxx, DisparityMap/NCCRegistrationFilterExample.cxx, FeatureExtraction/CloudDetectionExample.cxx, Fusion/BayesianFusionImageFilter.cxx, Fusion/PanSharpeningExample.cxx, IO/DEMToImageGenerator.cxx, Markov/MarkovClassification1Example.cxx, Markov/MarkovClassification2Example.cxx, Markov/MarkovRegularizationExample.cxx, Markov/MarkovRestorationExample.cxx, Patented/SIFTExample.cxx, Patented/SIFTFastExample.cxx, Projections/VectorDataExtractROIExample.cxx, and Projections/VectorDataProjectionExample.cxx.

Definition at line 89 of file otbImage.h.

Member Typedef Documentation

◆ ConstPointer

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 98 of file otbImage.h.

◆ ConstWeakPointer

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::ConstWeakPointer = itk::WeakPointer<const Self>

Definition at line 99 of file otbImage.h.

◆ DirectionType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::DirectionType otb::Image< TPixel, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.

Definition at line 151 of file otbImage.h.

◆ IndexType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::IndexType otb::Image< TPixel, VImageDimension >::IndexType

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

Definition at line 142 of file otbImage.h.

◆ InternalPixelType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::InternalPixelType otb::Image< 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 120 of file otbImage.h.

◆ IOPixelType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::IOPixelType otb::Image< TPixel, VImageDimension >::IOPixelType

Definition at line 122 of file otbImage.h.

◆ NeighborhoodAccessorFunctorType

template<class TPixel, unsigned int VImageDimension = 2>

typedef itk::NeighborhoodAccessorFunctor<Self> otb::Image< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType

Accessor type that convert data between internal and external representations. Tyepdef for the functor used to access a neighborhood of pixel pointers.

Definition at line 130 of file otbImage.h.

◆ OffsetType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetType otb::Image< TPixel, VImageDimension >::OffsetType

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

Definition at line 145 of file otbImage.h.

◆ OffsetValueType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetValueType otb::Image< TPixel, VImageDimension >::OffsetValueType

Offset typedef (relative position between indices)

Definition at line 169 of file otbImage.h.

◆ PixelContainer

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::PixelContainer otb::Image< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Definition at line 139 of file otbImage.h.

◆ PixelContainerConstPointer

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::ConstPointer otb::Image< TPixel, VImageDimension >::PixelContainerConstPointer

Definition at line 166 of file otbImage.h.

◆ PixelContainerPointer

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::Pointer otb::Image< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Definition at line 165 of file otbImage.h.

◆ PixelType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::PixelType otb::Image< TPixel, VImageDimension >::PixelType

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

Definition at line 107 of file otbImage.h.

◆ Pointer

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::Pointer = itk::SmartPointer<Self>

Definition at line 97 of file otbImage.h.

◆ PointType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::PointType otb::Image< TPixel, VImageDimension >::PointType

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

Definition at line 162 of file otbImage.h.

◆ RegionType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::RegionType otb::Image< TPixel, VImageDimension >::RegionType

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

Definition at line 154 of file otbImage.h.

◆ Self

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::Self = Image

Standard class typedefs.

Definition at line 95 of file otbImage.h.

◆ SizeType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SizeType otb::Image< TPixel, VImageDimension >::SizeType

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

Definition at line 148 of file otbImage.h.

◆ SpacingType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SpacingType otb::Image< 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 158 of file otbImage.h.

◆ Superclass

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::Superclass = itk::Image<TPixel, VImageDimension>

Definition at line 96 of file otbImage.h.

◆ ValueType

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::ValueType otb::Image< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 114 of file otbImage.h.

◆ VectorType

template<class TPixel, unsigned int VImageDimension = 2>

using otb::Image< TPixel, VImageDimension >::VectorType = ImageMetadataInterfaceBase::VectorType

Definition at line 101 of file otbImage.h.

Constructor & Destructor Documentation

◆ Image() [1/2]

template<class TPixel , unsigned int VImageDimension>

otb::Image< TPixel, VImageDimension >::Image ( )

protected

Definition at line 32 of file otbImage.hxx.

◆ ~Image()

template<class TPixel, unsigned int VImageDimension = 2>

otb::Image< TPixel, VImageDimension >::~Image ( )

inlineoverrideprotected

Definition at line 231 of file otbImage.h.

◆ Image() [2/2]

template<class TPixel, unsigned int VImageDimension = 2>

otb::Image< TPixel, VImageDimension >::Image ( const Self & )

privatedelete

Member Function Documentation

◆ CopyInformation()

template<class TPixel , unsigned int VImageDimension>

void otb::Image< TPixel, VImageDimension >::CopyInformation ( const itk::DataObject * data )

override

Copy metadata from a DataObject.

Definition at line 80 of file otbImage.hxx.

◆ CreateAnother()

template<class TPixel, unsigned int VImageDimension = 2>

virtual::itk::LightObject::Pointer otb::Image< TPixel, VImageDimension >::CreateAnother ( void ) const

◆ GetGeoTransform()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::VectorType otb::Image< TPixel, VImageDimension >::GetGeoTransform ( void ) const

virtual

Get the six coefficients of affine geoTtransform.

Definition at line 102 of file otbImage.hxx.

◆ GetLowerLeftCorner()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::VectorType otb::Image< TPixel, VImageDimension >::GetLowerLeftCorner ( void ) const

Get image corners.

Definition at line 146 of file otbImage.hxx.

◆ GetLowerRightCorner()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::VectorType otb::Image< TPixel, VImageDimension >::GetLowerRightCorner ( void ) const

Get image corners.

Definition at line 158 of file otbImage.hxx.

◆ GetNameOfClass()

template<class TPixel, unsigned int VImageDimension = 2>

virtual const char* otb::Image< TPixel, VImageDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

◆ GetNeighborhoodAccessor() [1/2]

template<class TPixel, unsigned int VImageDimension = 2>

NeighborhoodAccessorFunctorType otb::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( )

inline

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

Definition at line 184 of file otbImage.h.

◆ GetNeighborhoodAccessor() [2/2]

template<class TPixel, unsigned int VImageDimension = 2>

const NeighborhoodAccessorFunctorType otb::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const

inline

Return the NeighborhoodAccessor functor

Definition at line 190 of file otbImage.h.

◆ GetSignedSpacing()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::SpacingType otb::Image< TPixel, VImageDimension >::GetSignedSpacing ( ) const

Get signed spacing

Definition at line 38 of file otbImage.hxx.

Referenced by otb::PersistentSamplingFilterBase< TInputImage >::GenerateOutputInformation().

◆ GetUpperLeftCorner()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::VectorType otb::Image< TPixel, VImageDimension >::GetUpperLeftCorner ( void ) const

Get image corners.

Definition at line 123 of file otbImage.hxx.

◆ GetUpperRightCorner()

template<class TPixel , unsigned int VImageDimension>

Image< TPixel, VImageDimension >::VectorType otb::Image< TPixel, VImageDimension >::GetUpperRightCorner ( void ) const

Get image corners.

Definition at line 134 of file otbImage.hxx.

◆ New()

template<class TPixel, unsigned int VImageDimension = 2>

static Pointer otb::Image< TPixel, VImageDimension >::New ( )

static

Method for creation through the object factory.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::BeforeThreadedGenerateData(), and otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter().

◆ operator=()

template<class TPixel, unsigned int VImageDimension = 2>

void otb::Image< TPixel, VImageDimension >::operator= ( const Self & )

privatedelete

◆ PrintSelf()

template<class TPixel , unsigned int VImageDimension>

void otb::Image< TPixel, VImageDimension >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

override

Definition at line 170 of file otbImage.hxx.

◆ SetSignedSpacing() [1/2]

template<class TPixel , unsigned int VImageDimension>

void otb::Image< TPixel, VImageDimension >::SetSignedSpacing ( SpacingType spacing )

virtual

Set signed spacing

Definition at line 50 of file otbImage.hxx.

◆ SetSignedSpacing() [2/2]

template<class TPixel , unsigned int VImageDimension>

void otb::Image< TPixel, VImageDimension >::SetSignedSpacing ( double spacing[VImageDimension] )

virtual

Set signed spacing

Definition at line 73 of file otbImage.hxx.

Member Data Documentation

◆ ImageDimension

template<class TPixel, unsigned int VImageDimension = 2>

const unsigned int otb::Image< 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 136 of file otbImage.h.

Referenced by otb::Image< TOutputPixelType, 2 >::GetSignedSpacing().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ ConstWeakPointer

◆ DirectionType

◆ IndexType

◆ InternalPixelType

◆ IOPixelType

◆ NeighborhoodAccessorFunctorType

◆ OffsetType

◆ OffsetValueType

◆ PixelContainer

◆ PixelContainerConstPointer

◆ PixelContainerPointer

◆ PixelType

◆ Pointer

◆ PointType

◆ RegionType

◆ Self

◆ SizeType

◆ SpacingType

◆ Superclass

◆ ValueType

◆ VectorType

Constructor & Destructor Documentation

◆ Image() [1/2]

◆ ~Image()

◆ Image() [2/2]

Member Function Documentation

◆ CopyInformation()

◆ CreateAnother()

◆ GetGeoTransform()

◆ GetLowerLeftCorner()

◆ GetLowerRightCorner()

◆ GetNameOfClass()

◆ GetNeighborhoodAccessor() [1/2]

◆ GetNeighborhoodAccessor() [2/2]

◆ GetSignedSpacing()

◆ GetUpperLeftCorner()

◆ GetUpperRightCorner()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetSignedSpacing() [1/2]

◆ SetSignedSpacing() [2/2]

Member Data Documentation

◆ ImageDimension

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