libCZI::ScalingInfo Struct Reference

Scaling information - gives the size of a pixel. More...

#include <libCZI_Metadata.h>

Inheritance diagram for libCZI::ScalingInfo:

Public Member Functions
	ScalingInfo ()
	Default constructor - sets all members to invalid.
bool	IsScaleXValid () const
bool	IsScaleYValid () const
bool	IsScaleZValid () const
bool	IsScaleValid (char d) const
double	GetScale (char d) const

Public Attributes
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().

Detailed Description

Scaling information - gives the size of a pixel.

Member Function Documentation

GetScale()

double libCZI::ScalingInfo::GetScale ( char  d ) const

inline

Gets the specified scale value.

Exceptions

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.

IsScaleValid()

bool libCZI::ScalingInfo::IsScaleValid ( char  d ) const

inline

Queries if the specified scale value is valid.

Exceptions

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.

IsScaleXValid()

bool libCZI::ScalingInfo::IsScaleXValid ( ) const

inline

Query if this object's scaleX value is valid.

Returns

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

IsScaleYValid()

bool libCZI::ScalingInfo::IsScaleYValid ( ) const

inline

Query if this object's scaleY value is valid.

Returns

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

IsScaleZValid()

bool libCZI::ScalingInfo::IsScaleZValid ( ) const

inline

Query if this object's scaleZ value is valid.

Returns

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

---

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

• libCZI/libCZI_Metadata.h