:py:mod:`gnome.utilities.shapefile_builder`
===========================================

.. py:module:: gnome.utilities.shapefile_builder

.. autoapi-nested-parse::

   Shapefile Builder



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

Classes
~~~~~~~

.. autoapisummary::

   gnome.utilities.shapefile_builder.ShapefileBuilder
   gnome.utilities.shapefile_builder.ParticleShapefileBuilder
   gnome.utilities.shapefile_builder.BoundaryShapefileBuilder
   gnome.utilities.shapefile_builder.ContourShapefileBuilder



Functions
~~~~~~~~~

.. autoapisummary::

   gnome.utilities.shapefile_builder.area_in_meters



.. py:class:: ShapefileBuilder(filename, zip_output=True, **kwargs)


   Bases: :py:obj:`object`

   
   :param filename: Full path and basename of the shape file.
   :param zip: If we should zip the final shapefile results.

   .. py:property:: filename


   .. py:method:: append(sc)


   .. py:method:: write()

      Actually write out the shapefile as .shp or .zip



.. py:class:: ParticleShapefileBuilder(filename, zip_output=True, **kwargs)


   Bases: :py:obj:`ShapefileBuilder`

   
   :param filename: Full path and basename of the shape file.
   :param zip: If we should zip the final shapefile results.

   .. py:method:: append(sc)

      Given a spill container, write out the current particle data to a data frame


   .. py:method:: write()

      Actually write out the shapefile as .shp or .zip



.. py:function:: area_in_meters(this_hull)


.. py:class:: BoundaryShapefileBuilder(filename, zip_output=True, **kwargs)


   Bases: :py:obj:`ShapefileBuilder`

   
   :param filename: Full path and basename of the shape file.
   :param zip: If we should zip the final shapefile results.

   .. py:method:: append(sc, separate_by_spill=True, hull_ratio=0.5, hull_allow_holes=False)

      Given a spill container, write out the current boundary data to a data frame


   .. py:method:: write()

      Actually write out the shapefile as .shp or .zip



.. py:class:: ContourShapefileBuilder(filename, zip_output=True, **kwargs)


   Bases: :py:obj:`ShapefileBuilder`

   
   :param filename: Full path and basename of the shape file.
   :param zip: If we should zip the final shapefile results.

   .. py:method:: append(sc, cutoff_struct=None, hull_ratio=0.5, hull_allow_holes=False)

      Given a spill container, write out the contours based on the cutoffs provided


   .. py:method:: write()

      Actually write out the shapefile as .shp or .zip