AxesInfo Struct Reference

Stores information about image axes, including spatial and spectral components. More...

#include <Image.h>

Collaboration diagram for AxesInfo:

Public Member Functions
	AxesInfo ()
	Default constructor initialising all axes to -1 (undefined).
	AxesInfo (const std::vector< int > render, const std::vector< int > spatial, int spectral)
	Constructor initialising rendering and spatial axes.
	AxesInfo (const std::vector< int > render, std::vector< int > spatial, int spectral, int z, int stokes)
	Constructor initialising rendering, spatial, spectral, Z, and stokes axes.
std::vector< int >	Render ()
	Retrieves the rendering axes (X and Y).
std::vector< int >	Spatial ()
	Retrieves the spatial axes (spatial_x and spatial_y).

Public Attributes
int	x
	Index of the X-axis for rendering.
int	y
	Index of the Y-axis for rendering.
int	spatial_x
	Index of the spatial X-axis.
int	spatial_y
	Index of the spatial Y-axis.
int	spectral
	Index of the spectral axis (if applicable).
int	z
	Index of the Z-axis (if applicable).
int	stokes
	Index of the stokes axis (if applicable).

Detailed Description

Stores information about image axes, including spatial and spectral components.

This struct holds indices for different axes used in image rendering, spatial mapping, spectral representation, and stokes parameters.

Constructor & Destructor Documentation

AxesInfo() [1/3]

AxesInfo::AxesInfo ( )

inline

Default constructor initialising all axes to -1 (undefined).

AxesInfo() [2/3]

AxesInfo::AxesInfo ( const std::vector< int >  render, const std::vector< int >  spatial, int  spectral  )

inline

Constructor initialising rendering and spatial axes.

Parameters

render	A vector containing the X and Y rendering axes.
spatial	A vector containing the spatial X and Y axes.
spectral	The spectral axis index.

AxesInfo() [3/3]

AxesInfo::AxesInfo ( const std::vector< int >  render, std::vector< int >  spatial, int  spectral, int  z, int  stokes  )

inline

Constructor initialising rendering, spatial, spectral, Z, and stokes axes.

Parameters

render	A vector containing the X and Y rendering axes.
spatial	A vector containing the spatial X and Y axes.
spectral	The spectral axis index.
z	The Z-axis index.
stokes	The stokes axis index.

Member Function Documentation

Render()

std::vector< int > AxesInfo::Render ( )

inline

Retrieves the rendering axes (X and Y).

Returns

A vector containing the X and Y rendering axes.

Spatial()

std::vector< int > AxesInfo::Spatial ( )

inline

Retrieves the spatial axes (spatial_x and spatial_y).

Returns

A vector containing the spatial X and Y axes.

Member Data Documentation

spatial_x

int AxesInfo::spatial_x

Index of the spatial X-axis.

spatial_y

int AxesInfo::spatial_y

Index of the spatial Y-axis.

spectral

int AxesInfo::spectral

Index of the spectral axis (if applicable).

stokes

int AxesInfo::stokes

Index of the stokes axis (if applicable).

x

int AxesInfo::x

Index of the X-axis for rendering.

y

int AxesInfo::y

Index of the Y-axis for rendering.

z

int AxesInfo::z

Index of the Z-axis (if applicable).

---

The documentation for this struct was generated from the following file:

• Image.h