fqpr_convenience module

HSTB.kluster.fqpr_convenience Module

Functions

convert_multibeam(filname[, input_datum, ...])

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

generate_new_mosaic([fqpr_inst, tile_size, ...])

Using the bathygrid create_grid convenience function, process backscatter and generate a new single resolution backscatter mosaic for the provided Kluster fqpr instance(s).

generate_new_surface([fqpr_inst, grid_type, ...])

Using the bathygrid create_grid convenience function, generate a new variable/single resolution surface for the provided Kluster fqpr instance(s).

get_attributes_from_fqpr(fqpr_instance[, ...])

Takes in a FQPR instance.

get_attributes_from_zarr_stores(list_dir_paths)

Takes in a list of paths to directories containing fqpr generated zarr stores.

import_processed_navigation(fqpr_inst, navfiles)

Convenience function for importing post processed navigation from sbet/smrmsg files, for use in georeferencing xyz data.

import_sound_velocity(fqpr_inst, sv_files[, ...])

Convenience function for passing in an instance of fqpr_generation.Fqpr and importing the provided sound velocity profile files as attributes.

overwrite_raw_navigation(fqpr_inst, navfiles)

Convenience function for importing raw navigation from pos mv .000 files, for use in georeferencing xyz data.

perform_all_processing(filname[, navfiles, ...])

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.

points_to_surface(data_files, ...[, ...])

Take in points in either csv or las/laz formats, and build a new bathygrid grid from the data points.

process_multibeam(fqpr_inst[, ...])

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.

reload_data(converted_folder[, ...])

Pick up from a previous session.

reload_surface(surface_path)

Simple convenience method for reloading a surface from a path

reprocess_sounding_selection(fqpr_inst[, ...])

Designed to feed a patch test tool.

return_avg_tables([fqpr_inst, avg_bin_size, ...])

Helper function for building the angle varying gain tables used during backscatter processing.

return_processed_data_folders(converted_folder)

After processing, you'll have a directory of folders containing the kluster records.

return_svcorr_xyz(filname[, outfold, ...])

Using fqpr_generation, convert and sv correct multibeam file (or directory of files) and return the sound velocity corrected xyz soundings.

update_surface(surface_instance[, add_fqpr, ...])

Bathygrid instances can be updated with new points from new converted multibeam data, or have points removed from old multibeam data.

validation_against_xyz88(filname[, ...])

Function to take a multibeam file and compare the svcorrected xyz with the converted and sound velocity corrected data generated by Kluster/fqpr_generation.