update_kwargs_for_surface

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

Build a dictionary of updated settings for an existing update surface action, use this with FqprActionContainer to update the action.

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

updated args for the surface action

Return type

dict