Represents the dimensions of an image or data cube. More...

#include <Image.h>

Collaboration diagram for DimsInfo:

Public Member Functions
	DimsInfo ()
	Default constructor initialising all dimensions to 1.

	DimsInfo (const AxesInfo &axes, const casacore::IPosition &shape)
	Constructor that initialises dimensions based on given axes and shape.

Static Public Member Functions
static size_t	FromAxis (int axis, const casacore::IPosition &shape)
	Retrieves the size of a given axis from the shape.

Public Attributes
size_t	width
	Width of the data (corresponding to the X-axis).

size_t	height
	Height of the data (corresponding to the Y-axis).

size_t	depth
	Depth of the data (corresponding to the Z-axis).

size_t	num_channels
	Number of spectral channels.

size_t	num_stokes
	Number of Stokes parameters.

Detailed Description

Represents the dimensions of an image or data cube.

This struct stores information about the width, height, depth, number of spectral channels, and number of Stokes parameters based on the given axes and shape.

Constructor & Destructor Documentation

◆ DimsInfo() [1/2]

DimsInfo::DimsInfo ( )

inline

Default constructor initialising all dimensions to 1.

◆ DimsInfo() [2/2]

DimsInfo::DimsInfo	(	const AxesInfo &	axes,
		const casacore::IPosition &	shape
	)

inline

Constructor that initialises dimensions based on given axes and shape.

Parameters

axes	The AxesInfo struct containing axis indices.
shape	The image dimensions.

Member Function Documentation

◆ FromAxis()

static size_t DimsInfo::FromAxis	(	int	axis,
		const casacore::IPosition &	shape
	)

inlinestatic

Retrieves the size of a given axis from the shape.

Parameters

axis	The axis index.
shape	The shape of the data.

Returns: The size of the axis if valid, otherwise returns 1.

Here is the caller graph for this function:

Member Data Documentation

◆ depth

size_t DimsInfo::depth

Depth of the data (corresponding to the Z-axis).

◆ height

size_t DimsInfo::height

Height of the data (corresponding to the Y-axis).

◆ num_channels

size_t DimsInfo::num_channels

Number of spectral channels.

◆ num_stokes

size_t DimsInfo::num_stokes

Number of Stokes parameters.

◆ width

size_t DimsInfo::width

Width of the data (corresponding to the X-axis).

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

Image.h

Public Member Functions

Static Public Member Functions

Public Attributes