tsdf.read_tsdf

Module for reading TSDF files.

Reference: https://arxiv.org/abs/2211.11294

Functions

load_metadata_file(→ Dict[str, ...)	Loads a TSDF metadata file, returns a dictionary
load_metadata_legacy_file(→ Dict[str, ...)	Loads a TSDB metadata file, i.e., legacy format of the TSDF. It returns a dictionary representing the metadata.
load_metadatas_from_dir(→ List[Dict[str, ...)	Loads all TSDF metadata files in a directory, returns a dictionary
load_metadata_from_path(→ Dict[str, ...)	Loads a TSDF metadata file, returns a dictionary
load_metadata_string(→ Dict[str, ...)	Loads a TSDF metadata string, returns a dictionary.

Module Contents

tsdf.read_tsdf.load_metadata_file(file) → Dict[str, tsdf.tsdfmetadata.TSDFMetadata]

Loads a TSDF metadata file, returns a dictionary

Parameters:

file – file object containing the TSDF metadata.

Returns:

dictionary of TSDFMetadata objects.

tsdf.read_tsdf.load_metadata_legacy_file(file) → Dict[str, tsdf.tsdfmetadata.TSDFMetadata]

Loads a TSDB metadata file, i.e., legacy format of the TSDF. It returns a dictionary representing the metadata.

Parameters:

file – file object containing the TSDF metadata.

Returns:

dictionary of TSDFMetadata objects.

tsdf.read_tsdf.load_metadatas_from_dir(dir_path: str, naming_pattern=METADATA_NAMING_PATTERN) → List[Dict[str, tsdf.tsdfmetadata.TSDFMetadata]]

Loads all TSDF metadata files in a directory, returns a dictionary

Parameters:

• dir_path – path to the directory containing the TSDF metadata files.

• naming_pattern – (optional) naming pattern of the TSDF metadata files .

Returns:

dictionary of TSDFMetadata objects.

tsdf.read_tsdf.load_metadata_from_path(path: pathlib.Path) → Dict[str, tsdf.tsdfmetadata.TSDFMetadata]

Loads a TSDF metadata file, returns a dictionary

Parameters:

path – path to the TSDF metadata file.

Returns:

dictionary of TSDFMetadata objects.

tsdf.read_tsdf.load_metadata_string(json_str) → Dict[str, tsdf.tsdfmetadata.TSDFMetadata]

Loads a TSDF metadata string, returns a dictionary.

Parameters:

json_str – string containing the TSDF metadata.

Returns:

dictionary of TSDFMetadata objects.