libCZI::ICZIReader::OpenOptions Struct Reference

This structure gathers the settings for controlling the 'Open' operation of the CZIReader-class. More...

#include <libCZI.h>

Public Member Functions
void	SetDefault ()
	Sets the the default.

Public Attributes
bool	lax_subblock_coordinate_checks { true }
bool	ignore_sizem_for_pyramid_subblocks { false }

Detailed Description

This structure gathers the settings for controlling the 'Open' operation of the CZIReader-class.

Member Data Documentation

ignore_sizem_for_pyramid_subblocks

bool libCZI::ICZIReader::OpenOptions::ignore_sizem_for_pyramid_subblocks { false }

This option controls whether the size-M-attribute of a pyramid-subblocks is to be ignored (when parsing and validating the dimension-entry of a subblock). This flag is only relevant if strict validation is enabled (i.e. lax_subblock_coordinate_checks is 'false'). If lax_subblock_coordinate_checks is true, then this flag has no effect. This is useful as some versions of software creating CZI-files used to write bogus values for size-M, and those files would otherwise not be usable with strict validation enabled. If this bogus size-M is ignored, then the files can be used without problems.

lax_subblock_coordinate_checks

bool libCZI::ICZIReader::OpenOptions::lax_subblock_coordinate_checks { true }

This option controls whether the lax parameter validation when parsing the dimension-entry of a subblock is to be used. Previous versions of libCZI did not check whether certain values in the file have the expected value. If those values are different than expected, this meant that libCZI would not be able to deal with the document properly.
If lax checking of this is disabled, then Open will fail with a corresponding exception. The default is to enable lax checking (for compatibility with previous libCZI-versions), but users are encouraged to disable this for new code.

---

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

• libCZI/libCZI.h