libCZI::PyramidStatistics::PyramidLayerInfo Struct Reference

#include <libCZI.h>

Public Member Functions
bool	IsLayer0 () const
bool	IsNotIdentifiedAsPyramidLayer () const

Public Attributes
std::uint8_t	minificationFactor
	Factor by which adjacent pyramid-layers are shrunk. Commonly used in CZI are 2 or 3.
std::uint8_t	pyramidLayerNo
	The pyramid layer number.

Detailed Description

Information about the pyramid-layer. It consists of two parts: the minification factor and the layer number. The minification factor specifies by which factor two adjacent pyramid-layers are shrunk. Commonly used in CZI are 2 or 3. The layer number starts with 0 with the highest resolution layer. The lowest level (layer 0) is denoted by pyramidLayerNo == 0 AND minificationFactor==0. Another special case is pyramidLayerNo == 0xff AND minificationFactor==0xff which means that the pyramid-layer could not be determined (=the minification factor could not unambiguously correlated to a pyramid-layer).

Member Function Documentation

IsLayer0()

bool libCZI::PyramidStatistics::PyramidLayerInfo::IsLayer0 ( ) const

inline

Query if this object represents layer 0 (=no minification).

Returns

True if representing layer 0, false if not.

IsNotIdentifiedAsPyramidLayer()

bool libCZI::PyramidStatistics::PyramidLayerInfo::IsNotIdentifiedAsPyramidLayer ( ) const

inline

Query if this object represents the set of subblocks which cannot be represented as pyramid-layers.

Returns

True if the set of "not representable as pyramid-layer" is represented by this object, false if not.

---

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

• libCZI/libCZI.h