Zarr.ArrayMetadataA module which contains functionality to work with a parsed JSON Zarr array metadata document.
val create :
?sep:[< `Dot | `Slash Slash ] ->
+ ?codecs:Codecs.Chain.t ->
?dimension_names:string option list ->
?attributes:Yojson.Safe.t ->
- codecs:Codecs.Chain.t ->
shape:int array ->
('a, 'b) Stdlib.Bigarray.kind ->
'a ->
int array ->
- (t, [> Zarr__.Metadata.error ]) Stdlib.resultcreate ~codecs ~shape kind fv cshp Creates a new array metadata document with codec chain codecs, shape shape, fill value fv, data type kind and chunk shape cshp. This operation returns an error if chunk shape is invalid.
val encode : t -> stringencode t returns a byte string representing a JSON Zarr array metadata.
val decode : string -> (t, [> `Store_read of string ]) Stdlib.resultdecode s decodes a bytes string s into a ArrayMetadata.t type, and returns an error if the decoding process fails.
val shape : t -> int arrayshape t returns the shape of the zarr array represented by metadata type t.
val chunk_shape : t -> int arraychunk_shape t returns the shape a chunk in this zarr array.
val is_valid_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> boolis_valid_kind t kind checks if kind is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.
val fillvalue_of_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> 'afillvalue_of_kind t kind returns the fill value of uninitialized chunks in this zarr array given kind. Raises Failure if the kind is not compatible with this array's fill value.
val attributes : t -> Yojson.Safe.tattributes t Returns a Yojson type containing user attributes assigned to the zarr array represented by t.
val dimension_names : t -> string option listdimension_name t returns a list of dimension names. If none are defined then an empty list is returned.
val codecs : t -> Codecs.Chain.tcodecs t Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.
val index_coord_pair : t -> int array -> int array * int arrayindex_coord_pair t coord maps a coordinate of this Zarr array to a pair of chunk index and coordinate within that chunk.
val chunk_indices : t -> int array -> int array listchunk_indices t shp returns a list of all chunk indices that would be contained in a zarr array of shape shp given the regular grid defined in array metadata t.
val chunk_key : t -> int array -> stringchunk_key t idx returns a key encoding of a the chunk index idx.
update_attributes t json returns a new metadata type with an updated attribute field containing contents in json
update_shape t new_shp returns a new metadata type containing shape new_shp.
create ~shape kind fv cshp Creates a new array metadata document with shape shape, fill value fv, data type kind and chunk shape cshp. This operation returns an error if chunk shape is invalid.
val encode : t -> stringencode t returns a byte string representing a JSON Zarr array metadata.
val decode : string -> (t, string) Stdlib.resultdecode s decodes a bytes string s into a ArrayMetadata.t type, and returns an error if the decoding process fails.
val shape : t -> int arrayshape t returns the shape of the zarr array represented by metadata type t.
val chunk_shape : t -> int arraychunk_shape t returns the shape a chunk in this zarr array.
val is_valid_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> boolis_valid_kind t kind checks if kind is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.
val fillvalue_of_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> 'afillvalue_of_kind t kind returns the fill value of uninitialized chunks in this zarr array given kind. Raises Failure if the kind is not compatible with this array's fill value.
val attributes : t -> Yojson.Safe.tattributes t Returns a Yojson type containing user attributes assigned to the zarr array represented by t.
val dimension_names : t -> string option listdimension_name t returns a list of dimension names. If none are defined then an empty list is returned.
val codecs : t -> Codecs.Chain.tcodecs t Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.
val index_coord_pair : t -> int array -> int array * int arrayindex_coord_pair t coord maps a coordinate of this Zarr array to a pair of chunk index and coordinate within that chunk.
val chunk_indices : t -> int array -> int array listchunk_indices t shp returns a list of all chunk indices that would be contained in a zarr array of shape shp given the regular grid defined in array metadata t.
val chunk_key : t -> int array -> stringchunk_key t idx returns a key encoding of a the chunk index idx.
update_attributes t json returns a new metadata type with an updated attribute field containing contents in json
update_shape t new_shp returns a new metadata type containing shape new_shp.