viqa.utils.load_raw

viqa.utils.load_raw(file_dir: str | PathLike, file_name: str | PathLike) → ndarray[source]

Load data from a .raw file.

Parameters:

  • file_dir (str or os.PathLike) – Directory of the file

  • file_name (str or os.PathLike) – Name of the file with extension

  • todo: (..) – Add support to overwrite size and bit depth.:

Returns:

img_arr – Numpy array containing the data

Return type:

np.ndarray

Notes

The file name must contain the dimension and the bit depth in the following format: DimSizeXxDimSizeYxDimSizeZ and _BitDepth.raw. The bit depth must be one of the following: - 8ubit - 16ubit - 32ubit for unsigned integer and - 16fbit - 32fbit - 64fbit for floating point numbers.

The following are used for backwards compatibility and denote the respective unsigned integer bit depths: - 8bit - 16bit - 32bit

Raises:

ValueError – If the bit depth is not supported. If no bit depth was found. If no dimension was found.

Examples

>>> from viqa.utils import load_raw
>>> img = load_raw("path/to/image.raw")