Skip to content

Read

Source

Functions relating to reading image files of different formats.

ReadFunc

Bases: Protocol

Protocol that defines the accepted function signature for "read functions".

Read functions take a file path and read image data into a numpy array.

The first argument MUST be named file_path and be type pathlib.Path, any number of additional arguments of any type are allowed. The return type MUST be numpy.typing.NDArray[Any]. For example:

def read_func_example(file_path: Path, extra_arg: int) -> NDArray[Any]: ...

__call__(file_path, *args, **kwargs)

Type hinted callables must match this function signature (not including self).

Parameters:

  • file_path (Path) –

    Path to file.

  • *args (Any, default: () ) –

    Other positional arguments.

  • **kwargs (Any, default: {} ) –

    Other keyword arguments.

get_read_func(data_type)

Get the read function for the data type.

Parameters:

Returns:

read_tiff(file_path, *args, **kwargs)

Read a tiff file and return a numpy array.

Parameters:

  • file_path (Path) –

    Path to a file.

  • *args (list, default: () ) –

    Additional arguments.

  • **kwargs (dict, default: {} ) –

    Additional keyword arguments.

Returns:

  • ndarray –

    Resulting array.

Raises: