:py:mod:`digger.make.scoops`
============================

.. py:module:: digger.make.scoops

.. autodoc2-docstring:: digger.make.scoops
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`scoops <digger.make.scoops.scoops>`
     - .. autodoc2-docstring:: digger.make.scoops.scoops
          :summary:

API
~~~

.. py:function:: scoops(source_path: str, source_mask_path: str, topo_path: str, q1_prefix: str = 'q1', q4_prefix: str = 'q4', b_prefix: str = 'b', eta_prefix: str = 'eta', slip_angle: float | str | list | None = None, vertex_only: bool = False, step: float = 100.0, shift: float = 0.0, npoints: int = 100, sequential_scoop: bool = False, q1_buffer: float = 50.0, alpha1: float | None = None, alpha2: float | None = None, c: float | None = None, fit_method: str = 'logspiral', limit_alpha1: bool = True, limit_alpha2: bool = True, error_alpha: float = 5.0, error_xy: float = 2.0, m0: float = 0.62, water_level: float = 0.0, eta_dry: float = -99999.0, fill_flat: bool = False, check_crs: bool = True, check_heights: bool = True, check_nodata: bool = True, check_slip_and_mask: bool = True, clip_extent: bool = True, clip_m: bool = False, plot: bool = True, fig_path: str = 'scoops.png', write_tt3: bool = False, write_tif: bool = False, write_csv: bool = False, write_shp: bool = False, csv_path: str = 'spiral_lines_summary.csv', shp_path: str = 'spiral_lines_summary.shp', verbose: bool = True) -> typing.Dict
   :canonical: digger.make.scoops.scoops

   .. autodoc2-docstring:: digger.make.scoops.scoops