Statistics about all sub-blocks found in a CZI-document. More...

#include <libCZI.h>

Public Member Functions
bool	IsMIndexValid () const

void	Invalidate ()
	Invalidates this object.

Public Attributes
int	subBlockCount

int	minMindex

int	maxMindex

IntRect	boundingBox

IntRect	boundingBoxLayer0Only

CDimBounds	dimBounds

std::map< int, BoundingBoxes >	sceneBoundingBoxes

Detailed Description

Statistics about all sub-blocks found in a CZI-document.

Member Function Documentation

◆ IsMIndexValid()

bool libCZI::SubBlockStatistics::IsMIndexValid ( ) const

inline

Query if the members minMindex and maxMindex are valid. They may be invalid in the case that the sub-blocks do not define an M-index.

Returns: True if minMindex and maxMindex are valid, false if not.

Member Data Documentation

◆ boundingBox

IntRect libCZI::SubBlockStatistics::boundingBox

The minimal axis-aligned-bounding-box determined from all logical coordinates of all sub-blocks in the document.

◆ boundingBoxLayer0Only

IntRect libCZI::SubBlockStatistics::boundingBoxLayer0Only

The minimal axis-aligned-bounding box determined only from the logical coordinates of the sub-blocks on pyramid-layer0 in the document. The top-left corner of this bounding-box gives the coordinate of the origin of the 'CZI-Pixel-Coordinate-System' in the coordinate system used by libCZI (which is refered to as 'raw-subblock-coordinate-system'). See Coordinate Systems for additional information.

◆ dimBounds

CDimBounds libCZI::SubBlockStatistics::dimBounds

The dimension bounds - the minimum and maximum dimension index determined from all sub-blocks in the CZI-document.

◆ maxMindex

int libCZI::SubBlockStatistics::maxMindex

The maximum M-index (determined from all sub-blocks in the document with a valid M-index). If no valid M-index was present, then this member will have the value std::numeric_limits<int>::min().

◆ minMindex

int libCZI::SubBlockStatistics::minMindex

The minimum M-index (determined from all sub-blocks in the document with a valid M-index). If no valid M-index was present, then this member will have the value std::numeric_limits<int>::max().

◆ sceneBoundingBoxes

std::map<int, BoundingBoxes> libCZI::SubBlockStatistics::sceneBoundingBoxes

A map with key scene-index and value bounding box of the scene. Two bounding-boxes are determined - one from checking all sub-blocks (with the specific scene-index) and another one by only considering sub-blocks on pyramid-layer 0. If no scene-indices are present, this map is empty.

◆ subBlockCount

int libCZI::SubBlockStatistics::subBlockCount

The total number of sub-blocks in the CZI-document. We are counting here all sub-block (no matter on which pyramid-layer).

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

libCZI/libCZI.h

Public Member Functions

Public Attributes