geestac.bands
=============

.. py:module:: geestac.bands

.. autoapi-nested-parse::

   Module for bands.



Classes
-------

.. autoapisummary::

   geestac.bands.Band
   geestac.bands.Bit
   geestac.bands.BitBand
   geestac.bands.BitGroup
   geestac.bands.Bitmask
   geestac.bands.CategoricalBand
   geestac.bands.Category
   geestac.bands.OpticalBand


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

.. py:class:: Band(name, scale, description, range = None)

   General Band class.

   :param name: name of the band.
   :param scale: spatial resolution.
   :param description: description of the band.
   :param range: range of the values.


   .. py:method:: __repr__()

      Object representation.



   .. py:attribute:: _range
      :value: None



   .. py:attribute:: description


   .. py:property:: estimated_range
      :type: bool | None


      If range exists in STAC, return whether the range is estimated or not.


   .. py:property:: maximum_value
      :type: int | float | None


      If exists in the STAC, return the maximum value.


   .. py:property:: minimum_value
      :type: int | float | None


      If exists in the STAC, return the minimum value.


   .. py:attribute:: name


   .. py:attribute:: scale


.. py:class:: Bit(value, description)

   Initialize a Bit.

   :param value: value of the bit.
   :param description: description of the bit.


   .. py:attribute:: description


   .. py:attribute:: value


.. py:class:: BitBand(name, scale, description, bitmask)

   Bases: :py:obj:`Band`


   Bit Band (bits mask).

   :param name: name of the band.
   :param scale: spatial resolution.
   :param description: description of the band.
   :param bitmask: the bit mask.


   .. py:attribute:: bitmask


.. py:class:: BitGroup(first, count, description, bits)

   Initialize a bit group.

   :param first: first bit.
   :param count: number of bits.
   :param description: description of the bit information.
   :param bits: a ListNamespace of Bit objects.


   .. py:method:: to_dict()

      Convert a bit group to a dict.



   .. py:attribute:: bits


   .. py:attribute:: count


   .. py:attribute:: description


   .. py:attribute:: first


.. py:class:: Bitmask(parts, total)

   Initialize a bitmask.

   :param parts: a ListNamespace of BitGroup.
   :param total: total number of bits.


   .. py:method:: to_dict()

      Convert a Bitmask into a dict.



   .. py:attribute:: parts


   .. py:attribute:: total


.. py:class:: CategoricalBand(name, scale, description, class_info)

   Bases: :py:obj:`Band`


   Categorical Band.

   :param name: name of the band.
   :param scale: spatial resolution.
   :param description: description of the band.
   :param class_info: a ListNamespace with the class value as keys and the
                      class names as values.


   .. py:attribute:: class_info


.. py:class:: Category(value, description, color = None)

   Initialize a category.

   :param value: value of the category.
   :param description: description of the category.
   :param color: color associated to the category (optional).


   .. py:attribute:: color
      :value: None



   .. py:attribute:: description


   .. py:attribute:: value


.. py:class:: OpticalBand(name, scale, description, center_wavelength = None, offset = None, multiplier = None, range = None)

   Bases: :py:obj:`Band`


   Optical Band.

   :param name: name of the band.
   :param scale: spatial resolution.
   :param description: description of the band.
   :param center_wavelength: center wavelength.
   :param offset: value to "move" the raw value.
   :param multiplier: value to "multiply" the raw value (GEE calls this value 'scale')
   :param range: range of the values.


   .. py:attribute:: center_wavelength
      :value: None



   .. py:attribute:: multiplier
      :value: None



   .. py:attribute:: offset
      :value: None