General open and methods (sarpy.io.phase_history.converter)

This module provide utilities for reading essentially Compensated Phase History Data.

sarpy.io.phase_history.converter.register_opener(open_func: Callable) → None

Provide a new opener.

Parameters:

open_func (Callable) – This is required to be a function which takes a single argument (file name). This function should return a sarpy.io.phase_history.base.CPHDTypeReader instance if the referenced file is viable for the underlying type, and None otherwise.

Return type:

None

sarpy.io.phase_history.converter.parse_openers() → None

Automatically find the viable openers (i.e. is_a()) in the various modules.

sarpy.io.phase_history.converter.open_phase_history(file_name: str | BinaryIO) → CPHDTypeReader

Given a file, try to find and return the appropriate reader object.

Parameters:

file_name (str|BinaryIO)

Return type:

CPHDTypeReader

Raises:

SarpyIOError –