sarkit.cphd.read_file_header

read_file_header(file)

Read a file header.

The file object’s position is assumed to be at the start of the file.

Parameters:

filefile object

The open file object, which will be progressively read.

Returns:

file_type_headerstr

File type header from the first line of the file

kvp_listdict of {strstr}

Key-Value pair list of header fields