eebit
=====

.. py:module:: eebit

.. autoapi-nested-parse::

   The init file of the package.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/eebit/bithandler/index
   /autoapi/eebit/bitmask/index
   /autoapi/eebit/helpers/index


Attributes
----------

.. autoapisummary::

   eebit.__author__
   eebit.__email__
   eebit.__version__


Classes
-------

.. autoapisummary::

   eebit.BitMask


Package Contents
----------------

.. py:class:: BitMask(bits, total = None)

   Initialize a bitmask.

   :param bits: a list of BitGroup.
   :param total: total number of bits. If None, it uses the maximum position of the last group + 1.


   .. py:method:: bit_values()

      Get the list of bit values in the bitmask.



   .. py:method:: decode_to_columns(table, column)

      Decode a column in a FeatureCollection into multiple columns.

      :param table: the FeatureCollection to decode.
      :param column: the column to decode.

      :returns: A new FeatureCollection with one column per bit value in the bitmask.



   .. py:method:: decode_value(value)

      Decode a value into its descriptions.

      :param value: the value to decode.

      :returns: A dict with the descriptions of the value, or None if not found.



   .. py:method:: from_dict(bits_info)
      :classmethod:


      Create a BitMask from a dict.



   .. py:method:: get_group_by_description(description)

      Get the BitGroup that match a given description.

      :param description: the description to search for.

      :returns: The BitGroup that match the given description.



   .. py:method:: get_masks(image)

      Get masks for all bit values in the bitmask.

      :returns: An image with one band per bit value in the bitmask.



   .. py:method:: to_dict()

      Convert a Bitmask into a dict.



   .. py:attribute:: bits
      :value: []



   .. py:attribute:: total


.. py:data:: __author__
   :value: 'Rodrigo Principe'


.. py:data:: __email__
   :value: 'fitoprincipe82@gmail.com'


.. py:data:: __version__
   :value: '0.0.0'