Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.04 KB

min.rst

File metadata and controls

42 lines (31 loc) · 2.04 KB

min

.. py:function:: min(fs)
.. py:function:: min(fs, other_fs)
.. py:function:: min(fs, value)
.. py:function:: min(fs, gpt)

   Computes the point-wise minimum of ``fs``.

   :param fs: input fieldset
   :type fs: :class:`Fieldset`
   :param other_fs: another input fieldset
   :type other_fs: :class:`Fieldset`
   :param number value: input numerical value
   :param gpt: input geopoints data
   :type gpt: :class:`Geopoints`
   :rtype: :class:`Fieldset` or :class:`Geopoints`

   The actual behaviour of :func:`min` depends on the arguments:

   * if ``fs`` is the only argument :func:`min` returns a :class:`Fieldset` with a single field containing the minimum value of ``fs`` at each grid point or spectral coefficient. A missing value anywhere in ``fs`` will result in a missing value in the corresponding place in the output.
   * if ``other_fs`` is specified :func:`min` returns a :class:`Fieldset` containing the minimum of ``fs`` and ``other_fs`` at each grid point or spectral coefficient. A missing value anywhere in ``fs`` or ``other_fs`` will result in a missing value in the corresponding place in the output.
   * if ``value`` is specified :func:`min` returns a :class:`Fieldset` containing the minimum of ``fs`` and ``value`` at each grid point or spectral coefficient. A missing value anywhere in ``fs`` will result in a missing value in the corresponding place in the output.
   * if ``gpt`` is specified :func:`min` returns a :class:`Geopoints` containing the minimum of ``fs`` and ``gpt`` at each location in ``gpt``. A missing value anywhere in ``fs`` or ``gpt`` will result in a :class:`Geopoints` missing value in the corresponding place in the output.


..  py:function:: min(nc, nc_other)
..  py:function:: min(nc, value)

    Returns the :class:`NetCDF` of the minumum value of ``nc`` and ``nc_other`` or ``value``.

    :param nc: input nectdf
    :type nc: :class:`NetCDF`
    :param nc_other: another input nectdf
    :type nc_other: :class:`NetCDF`
    :param value: value
    :type value: number
    :rtype:  :class:`NetCDF`


.. mv-minigallery:: min