plots.identifiers
=================

.. py:module:: plots.identifiers


Attributes
----------

.. autoapisummary::

   plots.identifiers.LATITUDE
   plots.identifiers.LONGITUDE
   plots.identifiers.TIME
   plots.identifiers.VARIABLE_NAME_PREFERENCE
   plots.identifiers.X
   plots.identifiers.Y


Functions
---------

.. autoapisummary::

   plots.identifiers.find
   plots.identifiers.find_latitude
   plots.identifiers.find_longitude
   plots.identifiers.find_time
   plots.identifiers.find_x
   plots.identifiers.find_y
   plots.identifiers.is_regular_latlon
   plots.identifiers.xarray_variable_name


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

.. py:data:: LATITUDE
   :value: ['latitude', 'lat']


.. py:data:: LONGITUDE
   :value: ['longitude', 'long', 'lon']


.. py:data:: TIME
   :value: ['t', 'time', 'valid_time', 'date', 'dayofyear', 'month', 'year']


.. py:data:: VARIABLE_NAME_PREFERENCE
   :value: ['long_name', 'standard_name', 'name', 'short_name']


.. py:data:: X
   :value: ['x', 'X', 'xc', 'projection_x_coordinate', 'longitude', 'long', 'lon']


.. py:data:: Y
   :value: ['y', 'Y', 'yc', 'projection_y_coordinate', 'latitude', 'lat']


.. py:function:: find(array, identity)

.. py:function:: find_latitude(array)

.. py:function:: find_longitude(array)

.. py:function:: find_time(array)

.. py:function:: find_x(array)

.. py:function:: find_y(array)

.. py:function:: is_regular_latlon(data)

   Determine whether data is on a regular lat-lon grid.


.. py:function:: xarray_variable_name(dataset, element=None)

   Get the best long name representing the variable in an xarray Dataset.

   :param dataarray: The Dataset from which to extract a variable name.
   :type dataarray: xarray.Dataset
   :param element: If passed, the variable name for the given element will be extracted.
   :type element: str, optional