ewoksid02.utils.io.get_from_headers#

ewoksid02.utils.io.get_from_headers(key, headers=None, metadata_file_group=None, to_integer=False)[source]#

Retrieve a header value from the header object (for online processing) or from an HDF5 group (for offline processing).

Inputs:

  • key (str): The key to retrieve.

  • headers (Optional[Dict[str, Union[str, float]]], optional): The header object. Defaults to None.

  • metadata_file_group (Optional[h5py.Group], optional): The HDF5 group. Defaults to None.

  • to_integer (bool, optional): Whether to convert the value to an integer. Defaults to False.

Outputs:

  • Optional[Union[str, float, int]]: The retrieved value or None if not found.

Parameters:

  • key (str)

  • headers (Optional[Dict[str, Union[str, float]]])

  • metadata_file_group (Optional[Group])

  • to_integer (bool)

Return type:

Union[str, float, int, None]