libCZI::ScalingInfoEx Struct Reference

#include <libCZI_Metadata.h>

Inheritance diagram for libCZI::ScalingInfoEx:

Public Member Functions
LIBCZI_API std::wstring	GetDefaultUnitFormat (char d) const
Public Member Functions inherited from libCZI::ScalingInfo
	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
std::wstring	defaultUnitFormatX
	The default unit-format for X.
std::wstring	defaultUnitFormatY
	The default unit-format for Y.
std::wstring	defaultUnitFormatZ
	The default unit-format for Z.
Public Attributes inherited from libCZI::ScalingInfo
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

Extends the scaling information by a "default unit format". Note that the value itself remains to be given in meter, here we just suggest a unit to display the scale.

Member Function Documentation

GetDefaultUnitFormat()

LIBCZI_API std::wstring libCZI::ScalingInfoEx::GetDefaultUnitFormat ( char  d ) const

inline

Gets the specified default unit-format.

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.

---

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

• libCZI/libCZI_Metadata.h