perform_all_processing

HSTB.kluster.fqpr_convenience.perform_all_processing(filname, navfiles=None, input_datum=None, outfold=None, coord_system='WGS84', vert_ref='waterline', orientation_initial_interpolation=False, add_cast_files=None, client=None, skip_dask=False, show_progress=True, parallel_write=True, vdatum_directory=None, cast_selection_method='nearest_in_time', **kwargs)

Use fqpr_generation to process multibeam data on the local cluster and generate a sound velocity corrected, georeferenced xyz with uncertainty in csv files in the provided output folder.

This is convert_multibeam, process_multibeam, and the import processes all combined into one function.

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

Parameters

  • filname (Union[str, list]) – either a list of .all file paths, a single .all file path or a path to a directory with .all files

  • navfiles (Optional[list]) – list of postprocessed navigation file paths. If provided, expects either a log file or weekstart_year/weekstart_week/override_datum arguments, see import_navigation

  • 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. This will be used in georeferencing with ellipsoidally based vertical reference systems. If None, will use the encoded string in the multibeam data.

  • outfold (Optional[str]) – full file path to a directory you want to contain all the zarr folders. Will create this folder if it does not exist.

  • coord_system (str) – a valid datum identifier that pyproj CRS will accept

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

  • orientation_initial_interpolation (bool) – see process_multibeam

  • add_cast_files (Union[str, list, None]) – see process_multibeam

  • client (Optional[Client]) – dask.distributed.Client instance, if you don’t include this, it will automatically start a LocalCluster with the default options, unless you set skip_dask to True

  • skip_dask (bool) – if True, will not use the dask client

  • show_progress (bool) – If true, uses dask.distributed.progress.

  • parallel_write (bool) – if True, will write in parallel to disk, Disable for permissions issues troubleshooting.

  • 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’]

Returns

Fqpr object containing processed data

Return type

Fqpr