process_multibeam

HSTB.kluster.fqpr_convenience.process_multibeam(fqpr_inst, run_orientation=True, orientation_initial_interpolation=False, run_beam_vec=True, run_svcorr=True, run_georef=True, run_tpu=True, add_cast_files=None, input_datum=None, use_epsg=False, use_coord=True, epsg=None, coord_system='WGS84', vert_ref='waterline', vdatum_directory=None, cast_selection_method='nearest_in_time', only_this_line=None, only_these_times=None)

Use fqpr_generation to process already converted data on the local cluster and generate sound velocity corrected, georeferenced soundings in the same data store as the converted data.

fqpr = fully qualified ping record, the term for the datastore in kluster

Parameters

  • fqpr_inst (Fqpr) – Fqpr instance, must contain converted data

  • run_orientation (bool) – perform the get_orientation_vectors step

  • orientation_initial_interpolation (bool) – If true and running orientation, this will interpolate the raw attitude to ping time and save it in the respective arrays. Otherwise, each processing step will do the interpolation on it’s own. Turn this off for the in memory workflow, ex: tests turn this off as we don’t want to save to disk

  • run_beam_vec (bool) – perform the get_beam_pointing_vectors step

  • run_svcorr (bool) – perform the sv_correct step

  • run_georef (bool) – perform the georef_xyz step

  • run_tpu (bool) – perform the tpu step

  • add_cast_files (Union[str, list, None]) – either a list of files to include or the path to a directory containing files. These are in addition to the casts in the ping dataset.

  • input_datum (Union[str, int, None]) – Optional, the basic input datum of the converted multibeam data, should either be nad83, wgs84 or a epsg integer code for a geographic coordinate reference system. If None, will use the encoded string in the multibeam data. If sbet_datum exists, input_datum will not be used, as sbet navigation and altitude are used by default.

  • use_epsg (bool) – if True, will use the epsg code to build the CRS to use

  • use_coord (bool) – if True, will use the coord_system parameter and autodetect UTM zone

  • epsg (Optional[int]) – epsg code, used if use_epsg is True

  • coord_system (str) – coord system identifier, anything that pyproj supports can be used here, will be used if use_coord is True

  • vert_ref (str) – the vertical reference point, one of [‘ellipse’, ‘waterline’, ‘NOAA MLLW’, ‘NOAA MHW’, ‘Aviso MLLW’]

  • vdatum_directory (Optional[str]) – if ‘NOAA MLLW’ ‘NOAA MHW’ is the vertical reference, a path to the vdatum directory is required here

  • cast_selection_method (str) – the method used to select the cast that goes with each chunk of the dataset, one of [‘nearest_in_time’, ‘nearest_in_time_four_hours’, ‘nearest_in_distance’, ‘nearest_in_distance_four_hours’]

  • only_this_line (Optional[str]) – only process this line, subset the full dataset by the min time and maximum time of the line name provided. ex: 0000_testline.all

  • only_these_times (Optional[tuple]) – only process this time region, expects this to be a tuple, (minimum time in UTC seconds, maximum time in UTC seconds)

Returns

Fqpr passed in with processed xyz soundings

Return type

Fqpr