libCZI::ICziMultiDimensionDocumentInfo Class Reference

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

#include <libCZI_Metadata.h>

Public Member Functions
virtual GeneralDocumentInfo	GetGeneralDocumentInfo () const =0
virtual libCZI::ScalingInfoEx	GetScalingInfoEx () const =0
virtual libCZI::ScalingInfo	GetScalingInfo () const =0
virtual void	EnumDimensions (const std::function< bool(DimensionIndex)> &enumDimensions)=0
virtual std::shared_ptr< IDimensionInfo >	GetDimensionInfo (DimensionIndex dim)=0
virtual std::shared_ptr< IDimensionZInfo >	GetDimensionZInfo ()=0
virtual std::shared_ptr< IDimensionTInfo >	GetDimensionTInfo ()=0
virtual std::shared_ptr< IDimensionsChannelsInfo >	GetDimensionChannelsInfo ()=0
virtual std::shared_ptr< IDisplaySettings >	GetDisplaySettings () const =0
std::vector< DimensionIndex >	GetDimensions ()

Detailed Description

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

Member Function Documentation

EnumDimensions()

virtual void libCZI::ICziMultiDimensionDocumentInfo::EnumDimensions ( const std::function< bool(DimensionIndex)> &  enumDimensions )

pure virtual

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 for "Size".

Remarks

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.

GetDimensionChannelsInfo()

virtual std::shared_ptr< IDimensionsChannelsInfo > libCZI::ICziMultiDimensionDocumentInfo::GetDimensionChannelsInfo ( )

pure virtual

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.

GetDimensionInfo()

virtual std::shared_ptr< IDimensionInfo > libCZI::ICziMultiDimensionDocumentInfo::GetDimensionInfo ( DimensionIndex  dim )

pure virtual

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

Remarks

The information here is not considered authoritative.

Parameters

dim	The dimension to retrieve the information for.

Returns

The dimension information if available; nullptr otherwise.

GetDimensions()

std::vector< DimensionIndex > libCZI::ICziMultiDimensionDocumentInfo::GetDimensions ( )

inline

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

Returns

The vector containing all dimensions.

GetDimensionTInfo()

virtual std::shared_ptr< IDimensionTInfo > libCZI::ICziMultiDimensionDocumentInfo::GetDimensionTInfo ( )

pure virtual

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.

GetDimensionZInfo()

virtual std::shared_ptr< IDimensionZInfo > libCZI::ICziMultiDimensionDocumentInfo::GetDimensionZInfo ( )

pure virtual

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.

GetDisplaySettings()

virtual std::shared_ptr< IDisplaySettings > libCZI::ICziMultiDimensionDocumentInfo::GetDisplaySettings ( ) const

pure virtual

Gets the display settings.

Remarks

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

Returns

The display settings object.

GetGeneralDocumentInfo()

virtual GeneralDocumentInfo libCZI::ICziMultiDimensionDocumentInfo::GetGeneralDocumentInfo ( ) const

pure virtual

Gets "general document information".

Returns

The "general document information".

GetScalingInfo()

virtual libCZI::ScalingInfo libCZI::ICziMultiDimensionDocumentInfo::GetScalingInfo ( ) const

pure virtual

Gets "scaling information".

Returns

The "scaling information".

GetScalingInfoEx()

virtual libCZI::ScalingInfoEx libCZI::ICziMultiDimensionDocumentInfo::GetScalingInfoEx ( ) const

pure virtual

Gets "extended scaling information".

Returns

The "extended scaling information".

---

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

• libCZI/libCZI_Metadata.h