cars.core.outputs
=================

.. py:module:: cars.core.outputs

.. autoapi-nested-parse::

   Outputs module:
   contains some CARS global shared general purpose output functions



Functions
---------

.. autoapisummary::

   cars.core.outputs.write_ply
   cars.core.outputs.write_vector
   cars.core.outputs.rasterio_write_georaster


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

.. py:function:: write_ply(path_ply_file: str, cloud: Union[xarray.Dataset, pandas.DataFrame])

   Write cloud to a ply file

   :param path: path to the ply file to write
   :param cloud: cloud to write,
       it can be a xr.Dataset as the ones given in output of the triangulation
       or a pandas.DataFrame as used in the rasterization


.. py:function:: write_vector(polys, path_to_file, epsg, driver='GPKG')

   Write list of polygons in a single vector file

   :param polys: list of polygons to write in the file
   :param path_to_file: file to create
   :param epsg: EPSG code of the polygons
   :param driver: vector file type (default format is geopackage)


.. py:function:: rasterio_write_georaster(raster_file: str, data: numpy.ndarray, profile: dict = None, window: rasterio.windows.Window = None, descriptor=None, bands_description=None, classes_info_tag=None, nbits=None)

   Write a raster file from array

   :param raster_file: Image file
   :param data: image data
   :param profile: rasterio profile
   :param window: window to write in
   :param descriptor: rasterio descriptor
   :param bands_description: description of bands
   :param classes_info_tag: tag to add to descriptor