Struct ScalingInfo

• Defined in File libCZI_Metadata.h

Inheritance Relationships

Derived Type

• public libCZI::ScalingInfoEx (Struct ScalingInfoEx)

Struct Documentation

struct ScalingInfo

Scaling information - gives the size of a pixel.

Subclassed by libCZI::ScalingInfoEx

Public Functions

inline ScalingInfo()

Default constructor - sets all members to invalid.

inline bool IsScaleXValid() const

Query if this object’s scaleX value is valid.

Returns:

True if this object’s scaleX value is valid, false if not.

inline bool IsScaleYValid() const

Query if this object’s scaleY value is valid.

Returns:

True if this object’s scaleY value is valid, false if not.

inline bool IsScaleZValid() const

Query if this object’s scaleZ value is valid.

Returns:

True if this object’s scaleZ value is valid, false if not.

inline bool IsScaleValid(char d) const

Queries if the specified scale value is valid.

Throws:

std::invalid_argument – Thrown when an invalid argument error condition occurs.

Parameters:

d – Identifies the scale-value to query, can be ‘x’, ‘y’ or ‘z’ (or uppercase).

Returns:

True if the specified scale is valid, false if not.

inline double GetScale(char d) const

Gets the specified scale value.

Throws:

std::invalid_argument – Thrown when an invalid argument error condition occurs.

Parameters:

d – Identifies the scale-value to query, can be ‘x’, ‘y’ or ‘z’ (or uppercase).

Returns:

The specified scale.

Public Members

double scaleX

The length of a pixel in x-direction in the unit meters. If unknown/invalid, this value is numeric_limits<double>::quiet_NaN().

double scaleY

The length of a pixel in y-direction in the unit meters. If unknown/invalid, this value is numeric_limits<double>::quiet_NaN().

double scaleZ

The length of a pixel in y-direction in the unit meters. If unknown/invalid, this value is numeric_limits<double>::quiet_NaN().