import_sound_velocity¶
- HSTB.kluster.fqpr_convenience.import_sound_velocity(fqpr_inst, sv_files, cast_selection_method='nearest_in_time')¶
Convenience function for passing in an instance of fqpr_generation.Fqpr and importing the provided sound velocity profile files as attributes. Allows you to then run sv_correct and automatically select from the saved cast file attributes.
Currently only supports .svp files following the Caris svp file format. If you have an unsupported file type, please submit an issue to have it added. File format should include depth and soundvelocity arrays as well as cast location and time.
- Parameters
fqpr_inst (
Fqpr) – Fqpr instance containing converted data (converted data must exist for the import to work)sv_files (
Union[str,list]) – either a list of files to include or the path to a directory containing sv files (only supporting .svp currently)cast_selection_method (
str) – method used to determine the cast appropriate for each data chunk. Used here to determine whether or not this new cast(s) will require reprocessing, i.e. they are selected by one or more chunks of this dataset.
- Returns
Fqpr passed in with additional post processed navigation
- Return type