sam45.read module

sam45.read.ctl(log: PathLike[str] | str, /, *, validate: bool = True) → ndarray[tuple[Any, ...], dtype[Any]]

Read a SAM45 log to extract the SAM45/CTL information.

Parameters:

• log – Path to the SAM45 log.

• validate – Whether to validate the content of the read information.

Returns:

NumPy structured array containing the SAM45/CTL information.

Raises:

ValueError – Raised if the read information is invalid, i.e., the crec_type field of it is not b"L0".

sam45.read.dat(log: PathLike[str] | str, /, *, validate: bool = True) → ndarray[tuple[Any, ...], dtype[Any]]

Read a SAM45 log to extract the SAM45/DAT information.

Parameters:

• log – Path to the SAM45 log.

• validate – Whether to validate the content of the read information.

Returns:

NumPy structured array containing the SAM45/DAT information.

Raises:

ValueError – Raised if the read information is invalid, i.e., the crec_type field of it is not b"L2".

sam45.read.end(log: PathLike[str] | str, /, *, validate: bool = True) → ndarray[tuple[Any, ...], dtype[Any]]

Read a SAM45 log to extract the SAM45/END information.

Parameters:

• log – Path to the SAM45 log.

• validate – Whether to validate the content of the read information.

Returns:

NumPy structured array containing the SAM45/END information.

Raises:

ValueError – Raised if the read information is invalid, i.e., the crec_type field of it is not b"ED".

sam45.read.obs(log: PathLike[str] | str, /, *, validate: bool = True) → ndarray[tuple[Any, ...], dtype[Any]]

Read a SAM45 log to extract the SAM45/OBS information.

Parameters:

• log – Path to the SAM45 log.

• validate – Whether to validate the content of the read information.

Returns:

NumPy structured array containing the SAM45/OBS information.

Raises:

ValueError – Raised if the read information is invalid, i.e., the crec_type field of it is not b"L1".