Class ICziMultiDimensionDocumentInfo

• Defined in File libCZI_Metadata.h

Class Documentation

class ICziMultiDimensionDocumentInfo

The top-level interface for the CZI-metadata object.

Public Functions

virtual GeneralDocumentInfo GetGeneralDocumentInfo() const = 0

Gets “general document information”.

Returns:

The “general document information”.

virtual libCZI::ScalingInfoEx GetScalingInfoEx() const = 0

Gets “extended scaling information”.

Returns:

The “extended scaling information”.

virtual libCZI::ScalingInfo GetScalingInfo() const = 0

Gets “scaling information”.

Returns:

The “scaling information”.

virtual void EnumDimensions(const std::function<bool(DimensionIndex)> &enumDimensions) = 0

Enumerate the dimensions (defined in the metadata under Metadata/Information/Image, checking for the nodes StartZ, SizeZ, StartC, SizeC, StartT, StartT, …). If “Size” or “Start” for a specific dimensions is present, then this dimension will be listed here. The default for “Start” is 0, and 1 for “Size”.

Remark

The information here is not considered authoritative.

Parameters:

enumDimensions – The functor which will be called for each dimension. If the functor returns false, the enumeration is canceled.

virtual std::shared_ptr<IDimensionInfo> GetDimensionInfo(DimensionIndex dim) = 0

Gets the dimension information for the specified dimension. If no information about the specified dimension is present, an empty pointer is returned.

Remark

The information here is not considered authoritative.

Parameters:

dim – The dimension to retrieve the information for.

Returns:

The dimension information if available; nullptr otherwise.

virtual std::shared_ptr<IDimensionZInfo> GetDimensionZInfo() = 0

Gets information about the “dimension z” (from the Dimension/Z metadata node). If this node is not available, an empty pointer is returned.

Returns:

The “dimension z” information.

virtual std::shared_ptr<IDimensionTInfo> GetDimensionTInfo() = 0

Gets information about the “dimension t” (from the Dimension/T metadata node). If this node is not available, an empty pointer is returned.

Returns:

The “dimension t” information.

virtual std::shared_ptr<IDimensionsChannelsInfo> GetDimensionChannelsInfo() = 0

Gets information about the “dimension c” (from the Dimension/Channels metadata node). If this node is not available, an empty pointer is returned.

Returns:

The dimension channels information.

virtual std::shared_ptr<IDisplaySettings> GetDisplaySettings() const = 0

Gets the display settings.

Remark

This method may return an empty shared_ptr in case that display-settings are not present in the metadata.

Returns:

The display settings object.

virtual ~ICziMultiDimensionDocumentInfo() = default

inline std::vector<DimensionIndex> GetDimensions()

Gets a vector with all dimensions (found in metadata).

Returns:

The vector containing all dimensions.