Struct ZarrStreamSettings¶

The settings for a Zarr stream. More...

#include <acquire.zarr.h>

Public Attributes¶

Type	Name
size_t	array_count
ZarrArraySettings *	arrays
unsigned int	max_threads
bool	overwrite
ZarrS3Settings *	s3_settings
const char *	store_path
ZarrVersion	version

Detailed Description¶

This struct contains the settings for a Zarr stream, including the store path, custom metadata, S3 settings, chunk compression settings, dimension properties, whether to stream to multiple levels of detail, the pixel data type, and the Zarr format version.

Note:

The store path can be a filesystem path or an S3 key prefix. For example, supplying an endpoint "s3://my-endpoint.com" and a bucket "my-bucket" with a store_path of "my-dataset.zarr" will result in the store being written to "s3://my-endpoint.com/my-bucket/my-dataset.zarr".

Public Attributes Documentation¶

variable array_count¶

size_t ZarrStreamSettings::array_count;

The number of arrays in the Zarr stream.

variable arrays¶

ZarrArraySettings* ZarrStreamSettings::arrays;

The settings for the Zarr arrays being streamed.

variable max_threads¶

unsigned int ZarrStreamSettings::max_threads;

The maximum number of threads to use in the stream. Set to 0 to use the supported number of concurrent threads.

variable overwrite¶

bool ZarrStreamSettings::overwrite;

Remove everything in store_path if true.

variable s3_settings¶

ZarrS3Settings* ZarrStreamSettings::s3_settings;

Optional S3 settings for the store.

variable store_path¶

const char* ZarrStreamSettings::store_path;

Path to the store. Filesystem path or S3 key prefix.

variable version¶

ZarrVersion ZarrStreamSettings::version;

The version of the Zarr format to use. 2 or 3.

The documentation for this class was generated from the following file /home/runner/work/acquire-docs/acquire-docs/acquire-zarr/include/acquire.zarr.h