carta::StokesSource Struct Reference

Represents a source of Stokes data with axis range specifications. More...

#include <Stokes.h>

Collaboration diagram for carta::StokesSource:

Public Member Functions
	StokesSource ()
	Default constructor initializes with undefined Stokes and full axis ranges.
	StokesSource (int stokes_, AxisRange z_range_)
	Constructor initializing with a Stokes parameter and Z-axis range.
	StokesSource (int stokes_, AxisRange z_range_, AxisRange x_range_, AxisRange y_range_)
	Constructor initializing with a Stokes parameter and specified axis ranges.
bool	IsOriginalImage () const
	Checks if this Stokes source represents an original image.
bool	operator== (const StokesSource &rhs) const
	Equality operator to compare two StokesSource objects.
bool	operator!= (const StokesSource &rhs) const
	Inequality operator to compare two StokesSource objects.

Public Attributes
int	stokes
	The Stokes parameter identifier.
AxisRange	z_range
	The range along the Z-axis.
AxisRange	x_range
	The range along the X-axis.
AxisRange	y_range
	The range along the Y-axis.

Detailed Description

Represents a source of Stokes data with axis range specifications.

This struct encapsulates information about a Stokes parameter and its associated axis ranges in an image dataset. It is used to tell the file loader to get the original image interface, or get the computed stokes image interface. It provides constructors for different levels of specification and utility functions for comparison and checking if the data represents an original image.

Constructor & Destructor Documentation

StokesSource() [1/3]

carta::StokesSource::StokesSource ( )

inline

Default constructor initializes with undefined Stokes and full axis ranges.

StokesSource() [2/3]

carta::StokesSource::StokesSource ( int  stokes_, AxisRange  z_range_  )

inline

Constructor initializing with a Stokes parameter and Z-axis range.

Parameters

[in]	stokes_	The Stokes parameter.
[in]	z_range_	The Z-axis range.

StokesSource() [3/3]

carta::StokesSource::StokesSource ( int  stokes_, AxisRange  z_range_, AxisRange  x_range_, AxisRange  y_range_  )

inline

Constructor initializing with a Stokes parameter and specified axis ranges.

Parameters

[in]	stokes_	The Stokes parameter.
[in]	z_range_	The Z-axis range.
[in]	x_range_	The X-axis range.
[in]	y_range_	The Y-axis range.

Member Function Documentation

IsOriginalImage()

bool carta::StokesSource::IsOriginalImage ( ) const

inline

Checks if this Stokes source represents an original image.

Returns

true if the Stokes parameter is not a computed polarization, otherwise false.

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool carta::StokesSource::operator!= ( const StokesSource &  rhs ) const

inline

Inequality operator to compare two StokesSource objects.

Parameters

[in]

rhs

The StokesSource object to compare against.

Returns

true if any attribute differs, otherwise false.

operator==()

bool carta::StokesSource::operator== ( const StokesSource &  rhs ) const

inline

Equality operator to compare two StokesSource objects.

Parameters

[in]

rhs

The StokesSource object to compare against.

Returns

true if all attributes match, otherwise false.

Member Data Documentation

stokes

int carta::StokesSource::stokes

The Stokes parameter identifier.

x_range

AxisRange carta::StokesSource::x_range

The range along the X-axis.

y_range

AxisRange carta::StokesSource::y_range

The range along the Y-axis.

z_range

AxisRange carta::StokesSource::z_range

The range along the Z-axis.

---

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

• Stokes.h