convert_multibeam

HSTB.kluster.fqpr_convenience.convert_multibeam(filname, input_datum=None, outfold=None, client=None, skip_dask=False, show_progress=True, parallel_write=True)

Use fqpr_generation to process multibeam data on the local cluster and generate a new Fqpr instance saved to the provided output folder.

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

• 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. If not provided will automatically create folder next to lines.

• 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. Disabled for GUI, as it generates too much text

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

Returns

Fqpr containing converted source data

Return type

Fqpr