is_ngff¶

is_ngff(path, min_version=<Version('0.4')>, max_version=<Version('0.4')>, **kwargs)[source]¶

Check if the input is an NGFF file.

This should return True for a zarr groups stored in a directory, zip file, or SQLite database.

Parameters:

  • path (Path) – Path to the file to check.

  • min_version (Tuple[int, ...]) – Minimum version of the NGFF file to be considered valid.

  • max_version (Tuple[int, ...]) – Maximum version of the NGFF file to be considered valid.

  • kwargs (Unpack[WSIReaderParams])

Returns:

True if the file is an NGFF file.

Return type:

bool