cars.core.datasets
==================

.. py:module:: cars.core.datasets

.. autoapi-nested-parse::

   CARS Datasets module



Functions
---------

.. autoapisummary::

   cars.core.datasets.create_im_dataset
   cars.core.datasets.get_color_bands


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

.. py:function:: create_im_dataset(img: numpy.ndarray, region: List[int], largest_size: List[int], img_path: str = None, band_coords: str = None, descriptions: list = None, data_types: list = None, msk: numpy.ndarray = None) -> xarray.Dataset

   Create image dataset as used in cars.

   :param img: image as a numpy array
   :param region: region as list [xmin ymin xmax ymax]
   :param largest_size: whole image size
   :param img_path: path to image
   :param band_type: set to band coord names (cst.BAND_IM or BAND_CLASSIF)
    to add band description in the dataset
   :param msk: image mask as a numpy array (default None)
   :return: The image dataset as used in cars


.. py:function:: get_color_bands(dataset)

   Get band names list from the cardataset color

   :param dataset: carsdataset with the color data
   :type dataset: CarsDataset
   :param key: dataset color data key
   :param key: string

   :return: list of color band names