avif Driver

The avif driver specifies a TensorStore backed by an avif image file. The read volume is indexed by “height” (y), “width” (x), “channel”.

The avif driver supports between 1 and 4 channel AVIF images. While AVIF images are encoded in YUV planes with varying bit representations, the avif driver converts them, regardless of their encoded depth, to an 8-bit Grey/GreyA/RGB/RGBA equivalent image.

json driver/avif : object
Extends:
Required members:
driver : "avif"
kvstore : KvStore | KvStoreUrl

Base key-value store for the TensorStore.

Optional members:
context : Context

Specifies context resources that augment/override the parent context.

dtype : "uint8"

Optional. If specified, must be "uint8".

rank : integer[0, 32]

Specifies the rank of the TensorStore.

If transform is also specified, the input rank must match. Otherwise, the rank constraint applies to the driver directly.

transform : IndexTransform

Specifies a transform.

schema : Schema

Specifies constraints on the schema.

When opening an existing array, specifies constraints on the existing schema; opening will fail if the constraints do not match. Any soft constraints specified in the chunk_layout are ignored. When creating a new array, a suitable schema will be selected automatically based on the specified schema constraints in combination with any driver-specific constraints.

path : string = ""

Additional path relative to kvstore.

This is joined as an additional "/"-separated path component after any path member directly within kvstore. This is supported for backwards compatibility only; the KvStore.path member should be used instead.

Example

"path/to/data"
cache_pool : ContextResource = "cache_pool"

Cache pool for data.

Specifies or references a previously defined Context.cache_pool. It is normally more convenient to specify a default cache_pool in the context.

data_copy_concurrency : ContextResource = "data_copy_concurrency"

Specifies or references a previously defined Context.data_copy_concurrency. It is normally more convenient to specify a default data_copy_concurrency in the context.

recheck_cached_data : CacheRevalidationBound = "open"

Time after which cached data is assumed to be fresh.

Cached data older than the specified time is revalidated prior to being returned from a read operation. Writes are always consistent regardless of the value of this option.

Specifying true means that the data will be revalidated prior to every read operation. With a value of "open", any cached data is revalidated when the TensorStore is opened but is not rechecked for each read operation.

Note

To enable in-memory data caching, you must both specify a cache_pool with a non-zero total_bytes_limit and also specify false, "open", or an explicit time bound for recheck_cached_data.

quantizer : number = "0"

Unused. AVIF quantization. Lower values are higher quality.

speed : number = "6"

Unused. AVIF speed setting.

Example

{"driver": "avif", "kvstore": "gs://my-bucket/path-to-image.avif"}
json TensorStoreUrl/avif : string

avif: TensorStore URL scheme

AVIF TensorStores may be specified using the avif: URL syntax.

Examples

URL representation

JSON representation

"gs://my-bucket/path-to-image.avif/|avif:"

 
{"driver": "avif",
 "kvstore": {"driver": "gcs",
             "bucket": "my-bucket",
             "path": "path-to-image.avif"}
}
Extends:

Auto detection

This driver supports auto-detection based on the signature at the start of the file.