intel_process

HSTB.kluster.fqpr_intelligence.intel_process(filname, outfold=None, coord_system='WGS84', epsg=None, use_epsg=False, vert_ref='waterline', parallel_write=True, vdatum_directory=None, force_coordinate_system=True, cast_selection_method='nearest_in_time', designated_surface='', process_mode='normal', logger=None, client=None, skip_dask=False)

Use Kluster intelligence module to organize and process all input files. Files can be a list of files, a single file, or a directory full of files. Files can be multibeam files, .svp sound velocity profile files, SBET and SMRMSG files, etc. The Intel module will organize and process each in order of priority.

Parameters

  • filname (Union[str, list]) – a list of files, a single file, or a directory full of files (multibeam files, svp files, sbet files, etc.)

  • outfold (Optional[str]) – the output folder that will contain the processed data, if not provided it will be next to the raw data provided

  • coord_system (str) – If you want to autoselect the utm zone, provide the coordinate system as a string, one of ‘NAD83’ or ‘WGS84’

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

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

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

  • 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

  • force_coordinate_system (bool) – if True, will force all converted data to have the same coordinate system. Only takes effect if you do not use_epsg. use_epsg overwrites this. If coord_system/autoutm is used, this will ensure that all data added will have a utm zone equal to the first converted data instance.

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

  • designated_surface (str) – path to a Kluster Bathygrid surface. If this is provided, newly processed data will be added to the surface as it is processed.

  • process_mode (str) – One of the following process modes: normal=generate the next processing action using the current_processing_status attribute as normal, convert_only=only convert incoming data, return no processing actions, concatenate=process line by line if there is no processed data for that line

  • logger (Optional[Logger]) – logging.Logger instance, if included will use this logger in Kluster

  • 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

Returns

  • FqprIntel – intel module containing the project and references to converted data

  • list – list of Fqpr instances