gnome.outputters.json
=====================

.. py:module:: gnome.outputters.json

.. autoapi-nested-parse::

   JSON outputter
   Does not contain a schema for persistence yet



Classes
-------

.. autoapisummary::

   gnome.outputters.json.SpillJsonOutput
   gnome.outputters.json.CurrentJsonOutput
   gnome.outputters.json.IceJsonOutput


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

.. py:class:: SpillJsonOutput(_additional_data=None, include_uncertain_bounds=False, **kwargs)

   Bases: :py:obj:`gnome.outputters.outputter.Outputter`


   Class that outputs data on GNOME particles.
   Following is the format for a particle - the
   data in <> are the results for each element.
   ::

       {
           "certain": {
               "length":<LENGTH>
               "longitude": []
               "latitude": []
               "status_code": []
               "mass": []
               "spill_num":[]
           }
           "uncertain":{
               "length":<LENGTH>
               "longitude": []
               "latitude": []
               "status_code": []
               "mass": []
               "spill_num":[]
           }
           "uncertain_bounds":{
               "length":<LENGTH>
               "bounds": []
               "spill_num":[]
           }
           "step_num": <STEP_NUM>
           "timestamp": <TIMESTAMP>
       }

   :param list current_movers: A list or collection of current grid mover
                               objects.

   use super to pass optional kwargs to base class __init__ method


   .. py:attribute:: include_uncertain_bounds
      :value: False



   .. py:attribute:: default_unit_map


   .. py:method:: prepare_for_model_run(model_start_time, spills, uncertain=False, **kwargs)

      Setup before we run the model.



   .. py:method:: generate_cutoff_struct()


   .. py:method:: write_output(step_num, islast_step=False)

      dump data in geojson format



.. py:class:: CurrentJsonOutput(current_movers, **kwargs)

   Bases: :py:obj:`gnome.outputters.outputter.Outputter`


   Class that outputs GNOME current velocity results for each current mover
   in a geojson format.  The output is a collection of Features.
   Each Feature contains a Point object with associated properties.
   Following is the output format - the data in <> are the results
   for each element.
   ::

       {
        "time_stamp": <TIME IN ISO FORMAT>,
        "step_num": <OUTPUT ASSOCIATED WITH THIS STEP NUMBER>,
        "feature_collections": {<mover_id>: {"type": "FeatureCollection",
                                             "features": [{"type": "Feature",
                                                           "id": <PARTICLE_ID>,
                                                           "properties": {"velocity": [u, v]
                                                                          },
                                                           "geometry": {"type": "Point",
                                                                        "coordinates": [<LONG>, <LAT>]
                                                                        },
                                                       },
                                                       ...
                                                      ],
                                         },
                            ...
                            }
       }


   :param list current_movers: A list or collection of current grid mover
                               objects.

   use super to pass optional kwargs to base class __init__ method


   .. py:attribute:: current_movers


   .. py:method:: write_output(step_num, islast_step=False)

      dump data in geojson format



   .. py:method:: get_rounded_velocities(velocities)


   .. py:method:: get_unique_velocities(velocities)

      In order to make numpy perform this function fast, we will use a
      contiguous structured array using a view of a void type that
      joins the whole row into a single item.



   .. py:method:: get_matching_velocities(velocities, v)


   .. py:method:: current_movers_to_dict()

      a dict containing 'obj_type' and 'id' for each object in
      list/collection



.. py:class:: IceJsonOutput(ice_movers, **kwargs)

   Bases: :py:obj:`gnome.outputters.outputter.Outputter`


   Class that outputs GNOME ice property results for each ice mover
   in a raw JSON format.  The output contains a dict keyed by mover id.
   Each value item in the dict contains a list of feature data.
   Each feature item contains the ice fraction and thickness, and polyonal
   coordinate data.
   Following is the output format.

   ::

       {
        "time_stamp": <TIME IN ISO FORMAT>,
        "step_num": <OUTPUT ASSOCIATED WITH THIS STEP NUMBER>,
        "feature_collections": {<mover_id>: [[<ICE_CONCENTRATION>,
                                              <ICE_THICKNESS>,
                                              [[<LONG>, <LAT>], ...],
                                              ],
                                             ...
                                             ],
                                ...
                                }
       }

   :param ice_movers: ice_movers associated with this outputter.
   :type ice_movers: An ice_mover object or sequence of ice_mover
                     objects.

   Use super to pass optional kwargs to base class __init__ method


   .. py:method:: clean_output_files()

      this outputter doesn't write any files

      but this method needs to be here



   .. py:method:: write_output(step_num, islast_step=False)

      dump data in geojson format



   .. py:method:: rewind()

      remove previously written files