mrc

mrc#

Classes:

`DT`	MRC data type enumerations
`Header`	MRC file header

Data:

VOXEL_TYPES

Map from EPU voxelType values to integer data types

Functions:

`read`(file)	Read a .mrc file at the given file into a numpy array.
`write`(file, data, psize)	Write the given ndarray data to a file.

class DT#

MRC data type enumerations

Methods:

__new__(value)

class Header#

MRC file header

Attributes:

`datatype`	Integer-representation of MRC data type
`nsymbt`	Number of symbols in the symbol table following the header.
`nx`	Number of pixels in x dimension
`ny`	Number of pixels in y dimension
`nz`	Number of pixels in z dimension
`origin`	Location of image origin
`xlen`	Total size of X axis (e.g., in Angstroms)
`ylen`	Total size of Y axis (e.g., in Angstroms)
`zlen`	Total size of Z axis (e.g., in Angstroms)

Methods:

__new__(_cls, nx, ny, nz, datatype, xlen, ...)

Create new instance of Header(nx, ny, nz, datatype, xlen, ylen, zlen, origin, nsymbt)

static __new__(_cls, nx: int, ny: int, nz: int, datatype: DT, xlen: float, ylen: float, zlen: float, origin: Tuple[float, float, float], nsymbt: int)#: Create new instance of Header(nx, ny, nz, datatype, xlen, ylen, zlen, origin, nsymbt)

nsymbt: int#: Number of symbols in the symbol table following the header. Each symbol is 1024 bytes.

VOXEL_TYPES = {'16 BIT FLOAT': DT.FLOAT16, '32 BIT FLOAT': DT.FLOAT32, 'SIGNED 16 BIT INTEGER': DT.INT16, 'UNSIGNED 16 BIT INTEGER': DT.UINT16, 'UNSIGNED 8 BIT INTEGER': DT.UINT8}#: Map from EPU voxelType values to integer data types

read(file: str | PurePath | IO[bytes]) → Tuple[Header, NDArray]#

Read a .mrc file at the given file into a numpy array. Returns the MRC header and the resulting array.

write(file: str | PurePath | IO[bytes], data: NDArray, psize: float)#

Write the given ndarray data to a file. Specify a pixel size for the mrc file as the last argument.

Parameters: