cryosparc.dtype

Utilities and type definitions for working with dataset fields and column types.

Classes:

DatasetHeader

Encoded dataset file description.

cryosparc.dtype.DType(*args, **kwargs)

Can just be a single string such as “f4”, “3u4” or “O”. A datatype description of a ndarray entry.

Can also be the a tuple with a string datatype name and its shape. For example, the following dtypes are equivalent.

• “3u4”

• “<u4”, (3,))

alias of str | Tuple[str, Tuple[int, …]]

class cryosparc.dtype.DatasetHeader

Encoded dataset file description.

Attributes:

compressed_fields	Field names that require decompression.
compression	Compression library used for in the dataset
dtype	Column description
length	Number of rows in the dataset

compressed_fields: List[str]

Field names that require decompression.

compression: Literal['lz4', None]

Compression library used for in the dataset

dtype: List[Tuple[str, str] | Tuple[str, str, Tuple[int, ...]]]

Column description

length: int

Number of rows in the dataset

cryosparc.dtype.Field(*args, **kwargs)

Description of a column in a numpy array with named fields

Examples: - (“uid”, “u8”) - (“coords”, “3f4”) - (“coords”, “<f4”, (3,))

alias of Tuple[str, str] | Tuple[str, str, Tuple[int, …]]

cryosparc.dtype.Shape(*args, **kwargs)

A numpy shape tuple from ndarray.shape

alias of Tuple[int, …]