fqpr_vessel module

HSTB.kluster.fqpr_vessel Module

Functions

carry_over_optional(starting_data, new_data)

Populate the optional and tpu parameters in the new data with the latest existing entry

compare_dict_data(dict_one, dict_two)

Compare two dictionary objects to determine how identical they are.

convert_from_fqpr_xyzrph(xyzrph, ...)

xyzrph data (offsets/angles/tpu parameters) are stored as an attribute in each zarr store for the fqpr instance.

convert_from_vessel_xyzrph(vess_xyzrph)

Take the vessel xyzrph we converted with the convert_from_fqpr_xyzrph function and convert back to the format used within the Fqpr instance.

create_new_vessel_file(filepath)

Build a new vessel file at the provided path

get_overlapping_timestamps(timestamps, ...)

Find the timestamps in the provided list of timestamps that fall between starttime/endtime.

only_retain_earliest_entry(data)

Compare all timestamps in the data, if you find duplicate values associated with two timestamps, only retain the earliest timestamp of the two.

split_by_timestamp(xyzrph)

Takes a Kluster xyzrph (the dictionary object that stores uncertainty, offsets, angles, etc.

trim_xyzrprh_to_times(xyzrph, mintime, maxtime)

Our vessel information (mounting offsets, angles, uncertainty parameters) are stored in the Kluster xyzrph attribute dictionary.

Classes

VesselFile([filepath])

Class to manage the vessel configuration file (.kfc) for Kluster.