:py:mod:`wolfhece.xyz_file`
===========================

.. py:module:: wolfhece.xyz_file

.. autoapi-nested-parse::

   Author: HECE - University of Liege, Pierre Archambeau
   Date: 2024

   Copyright (c) 2024 University of Liege. All rights reserved.

   This script and its content are protected by copyright law. Unauthorized
   copying or distribution of this file, via any medium, is strictly prohibited.



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

.. py:class:: XYZFile(fname: str, toread: bool = True, folder: str = None, bounds: list = None, delimiter: str = ',')


   Classe pour la gestion des fichiers xyz

   .. py:property:: nblines


   .. py:attribute:: x
      :type: numpy.array

      

   .. py:attribute:: y
      :type: numpy.array

      

   .. py:attribute:: z
      :type: numpy.array

      

   .. py:attribute:: filename
      :type: str

      

   .. py:method:: reset()

      Reset des données


   .. py:method:: test_bounds(bounds)


   .. py:method:: read_from_file(folder: str = None, bounds: list = None, delimiter=',')

      Lecture d'un fichier xyz et remplissage de l'objet


   .. py:method:: fill_from_wolf_array(myarray, nullvalue=0.0)

      Création d'un fichier xyz depuis les données d'un WOLF array


   .. py:method:: write_to_file()

      Ecriture des informations dans un fichier


   .. py:method:: get_extent()

      Retourne les limites du rectangle qui encadre le nuage de points


   .. py:method:: merge(xyz_list: list[XYZFile])

      Merge des fichiers xyz en 1 seul


   .. py:method:: plot()

      Représentation graphique des points


   .. py:method:: find_points(bounds)



.. py:function:: is_float(s)


.. py:function:: xyz_scandir(mydir: str, bounds: list, delimiter: str = ',') -> numpy.ndarray

   Function that reads all the xyz files in a directory and its subdirectories

   :param mydir: directory to scan
   :dtype mydir: str
   :param bounds: bounds of the area to consider [[x1,x2],[y1,y2]]
   :dtype bounds: list
   :return: list of points