shareloc.image
==============

.. py:module:: shareloc.image

.. autoapi-nested-parse::

   Image class to handle Image data.
   Shareloc Reference raster image input based on rasterio.



Classes
-------

.. autoapisummary::

   shareloc.image.Image


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

.. py:class:: Image(image_path, read_data=False, roi=None, roi_is_in_physical_space=False, vertical_direction='auto')

   class Image to handle image data
   Shareloc reference for raster image input based on rasterio.


   .. py:attribute:: vertical_direction
      :value: 'auto'



   .. py:method:: set_metadata(nb_row, nb_col, nb_band, transform, datatype=np.float32)

      Set metadata and create data (np.array filled with zeros of shape (nb_band, nb_row, nb_col))

      :param nb_row: number of row
      :type nb_row: int
      :param nb_col: number of col
      :type nb_col: int
      :param nb_band: number of band
      :type nb_band: int
      :param transform: geo-transform
      :type transform: 1D numpy array with convention :
              | pixel size col, row rotation, origin col, col rotation, pixel size row, origin row |
      :param datatype: data type
      :type datatype: numpy type