cars.orchestrator.registry.saver_registry
=========================================

.. py:module:: cars.orchestrator.registry.saver_registry

.. autoapi-nested-parse::

   This module contains the saver registry class



Classes
-------

.. autoapisummary::

   cars.orchestrator.registry.saver_registry.CarsDatasetsRegistrySaver
   cars.orchestrator.registry.saver_registry.SingleCarsDatasetSaver


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

.. py:class:: CarsDatasetsRegistrySaver(id_generator)

   Bases: :py:obj:`cars.orchestrator.registry.abstract_registry.AbstractCarsDatasetRegistry`


   CarsDatasetsRegistrySaver
   This registry manages the saving of arriving future results


   .. py:attribute:: registered_cars_datasets_savers
      :value: []



   .. py:method:: get_cars_ds(future_result)

      Get a list of registered CarsDataset

      :param obj: object to get cars dataset from

      :return corresponding CarsDataset
      :rtype: CarsDataset



   .. py:method:: get_cars_datasets_list()

      Get a list of registered CarsDataset

      :return list of CarsDataset
      :rtype: list(CarsDataset)



   .. py:method:: cars_dataset_in_registry(cars_ds)

      Check if a CarsDataset is already registered, return id if exists

      :param cars_ds: cars dataset
      :type cars_ds: CarsDataset

      :return : True if in registry, if of cars dataset
      :rtype : Tuple(bool, int)



   .. py:method:: get_cars_ds_saver_corresponding_cars_dataset(cars_ds)

      Get the SingleCarsDatasetSaver corresponding to given cars dataset

      :param cars_ds: cars dataset

      :return : single cars dataset saver
      :rtype : SingleCarsDatasetSaver



   .. py:method:: get_cars_ds_saver_corresponding_id(obj_id)

      Get the SingleCarsDatasetSaver corresponding to given id

      :param obj_id: cars dataset id
      :type obj_id: int

      :return : single cars dataset saver
      :rtype : SingleCarsDatasetSaver



   .. py:method:: save(future_result)

      Save future result

      :param future_result: xr.Dataset or pd.DataFrame




   .. py:method:: add_file_to_save(file_name, cars_ds, tag=None, dtype=None, nodata=None, optional_data=False, save_by_pair=False, rio_tags=None, rio_band_description=None, nbits=None)

      Add file corresponding to cars_dataset to registered_cars_datasets

      :param file_name: file name to save futures to
      :type file_name: str
      :param cars_ds: CarsDataset to register
      :type cars_ds: CarsDataset
      :param tag: tag to save
      :type tag: str
      :param dtype: dtype
      :type dtype: str
      :param nodata: no data value
      :type nodata: float
      :param optional_data: True if the data is optionnal
      :type optional_data: bool
      :param save_by_pair:
      :type save_by_pair: bool
      :param rio_tags:  rasterio tags list((band, tag))
      :param rio_band_description:  rasterio description list((band, tag))



   .. py:method:: cleanup()

      Cleanup function.

      Close correctly all opened files.




.. py:class:: SingleCarsDatasetSaver(obj_id, cars_ds)

   SingleCarsDatasetSaver

   Structure managing the descriptors of each CarsDataset.


   .. py:attribute:: obj_id


   .. py:attribute:: cars_ds


   .. py:attribute:: file_names
      :value: []



   .. py:attribute:: optional_data_list
      :value: []



   .. py:attribute:: tags
      :value: []



   .. py:attribute:: dtypes
      :value: []



   .. py:attribute:: nodatas
      :value: []



   .. py:attribute:: descriptors
      :value: []



   .. py:attribute:: save_pc_by_pair_list
      :value: []



   .. py:attribute:: nbits
      :value: []



   .. py:attribute:: already_seen
      :value: False



   .. py:attribute:: count
      :value: 0



   .. py:attribute:: folder_name
      :value: None



   .. py:attribute:: rio_tags
      :value: []



   .. py:attribute:: rio_band_description
      :value: []



   .. py:method:: add_file(file_name, tag=None, dtype=None, nodata=None, optional_data=False, save_by_pair=False, rio_tags=None, rio_band_description=None, nbits=None)

      Add file to current CarsDatasetSaver

      :param file_name: file name to save futures to
      :type file_name: str
      :param tag: tag to save
      :type tag: str
      :param dtype: dtype
      :type dtype: str
      :param nodata: no data value
      :type nodata: float
      :param optional_data: True if the data is optionnal
      :type optional_data: bool
      :param rio_tags:  rasterio tags list((band, tag))
      :param rio_band_description:  rasterio description list((band, tag))



   .. py:method:: save(future_result)

      Save future result

      :param future_result: xr.Dataset or pandas.DataFrame




   .. py:method:: cleanup()

      Cleanup function

      Close properly all opened files