build_surface_action

HSTB.kluster.fqpr_actions.build_surface_action(destination, surface_instance, add_fqpr=None, add_lines=None, remove_fqpr=None, remove_lines=None)

Generate a new update surface action, adding multibeam files (or removing multibeam files) and regridding

Parameters

  • destination (str) – folder path to the bathygrid surface folder

  • surface_instance (BathyGrid) – a loaded Bathygrid instance

  • add_fqpr (Optional[list]) – Optional, a list of Fqpr instances to add to the surface

  • add_lines (Optional[list]) – Optional, if provided will only add lines that are in this list(s). a list of lists of lines (when a list of fqpr instances is provided)

  • remove_fqpr (Optional[list]) – Optional, a list of Fqpr instances to remove from the surface

  • remove_lines (Optional[list]) – Optional, if provided will only add lines that are in this list(s) a list of lists of lines (when a list of fqpr instances is provided)

Returns

newly generated update surface action

Return type

FqprAction