Function libCZI::OpenOptionsToString

Function libCZI::OpenOptionsToString#

Function Documentation#

std::string libCZI::OpenOptionsToString(const ICZIReader::OpenOptions &options)#

Converts reader open options to semicolon-separated key=value pairs in canonical order. Supported keys and defaults:

  • laxSubblockCoordinateChecks: true/false (default true); controls lax validation of sub-block coordinates.

  • ignoreSizeMForPyramidSubblocks: true/false (default false); ignores pyramid-subblock size-M during strict validation. Has no effect when lax coordinate checks are enabled.

  • dimensionSwapWorkaround: None, XtSubblocks, or XzSubblocks (default None); selects a dimension-swap compatibility workaround.

  • defaultFrameOfReference: Invalid, Default, RawSubBlockCoordinateSystem, or PixelCoordinateSystem (default Invalid). Invalid and Default resolve to the raw sub-block coordinate system.

  • subBlockDirectoryInfoPrecedence: SubBlockDirectoryPrecedence (default) or SubBlockHeaderPrecedence; selects the authoritative source for sub-block information.

  • subBlockDirectoryInfoDiscrepancy: error (default) or ignore; selects how discrepancies are handled.

Parameters:

options – The options to serialize.

Throws:

std::invalid_argument – If an enum value or policy bits cannot be represented.

Returns:

The canonical semicolon-separated representation.