:py:mod:`wolfhece.PyPalette`
============================

.. py:module:: wolfhece.PyPalette

.. 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:: wolfpalette(parent=None, title=_('Colormap'), w=100, h=500, nseg=1024)


   Bases: :py:obj:`wx.Frame`, :py:obj:`matplotlib.colors.LinearSegmentedColormap`

   .. autoapi-inheritance-diagram:: wolfhece.PyPalette.wolfpalette
      :parts: 1
      :private-bases:

   Palette de couleurs basée sur l'objet "LinearSegmentedColormap" de Matplotlib (Colormap objects based on lookup tables using linear segments)

   .. py:property:: colormin_uint8


   .. py:property:: colormax_uint8


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

      

   .. py:attribute:: nb
      :type: int

      

   .. py:attribute:: colors
      :type: numpy.array

      

   .. py:attribute:: colorsflt
      :type: numpy.array

      

   .. py:attribute:: colorsuint8
      :type: numpy.array

      

   .. py:method:: get_colors_f32()


   .. py:method:: get_colors_uint8()


   .. py:method:: set_bounds()


   .. py:method:: get_rgba(x: numpy.ndarray)

      Récupération de la couleur en fonction de la valeur x


   .. py:method:: get_rgba_oneval(x: float)

      Récupération de la couleur en fonction de la valeur x


   .. py:method:: export_palette_matplotlib(name)


   .. py:method:: distribute_values(minval: float = -99999, maxval: float = -99999, step=0, wx_permitted=True)

      Distribution des valeurs de la palette

      :param minval: valeur minimale
      :param maxval: valeur maximale
      :param step: pas de distribution

      Si le pas est fourni, il prend le dessus sur la valeur maximale.



   .. py:method:: get_ScalarMappable_mpl()

      Récupération de l'objet ScalarMappable via Matplotlib


   .. py:method:: export_image(fn='', h_or_v: Literal[h, v, ] = '', figax=None)

      Export image from colormap

      :param : fn : filepath or io.BytesIO()
      :param : h_or_v : configuration to save 'h' = horizontal, 'v' = vertical, '' = both


   .. py:method:: plot(fig: matplotlib.figure.Figure, ax: matplotlib.pyplot.Axes)

      Affichage de la palette de couleurs


   .. py:method:: fillgrid(gridto: wolfhece.CpGrid.CpGrid)

      Remplissage d'une grille avec les valeurs de la palette


   .. py:method:: updatefromgrid(gridfrom: wolfhece.CpGrid.CpGrid)

      Mise à jour de la palette sur base d'une grille


   .. py:method:: updatefrompalette(srcpal)

      Mise à jour de la palette sur base d'une autre

      On copie les valeurs, on ne pointe pas l'objet


   .. py:method:: lookupcolor(x)


   .. py:method:: lookupcolorflt(x)


   .. py:method:: lookupcolorrgb(x)


   .. py:method:: default16()

      Palette 16 coulrurs par défaut dans WOLF


   .. py:method:: set_values_colors(values: Union[list[float], numpy.ndarray], colors: Union[list[tuple[int]], numpy.ndarray])

      Mise à jour des valeurs et couleurs de la palette


   .. py:method:: defaultgray()

      Palette grise par défaut dans WOLF


   .. py:method:: fill_segmentdata()

      Mise à jour de la palatte de couleurs


   .. py:method:: readfile(*args)

      Lecture de la palette sur base d'un fichier WOLF .pal


   .. py:method:: is_valid()

      Vérification de la validité de la palette


   .. py:method:: savefile(*args)

      Lecture de la palette sur base d'un fichier WOLF .pal


   .. py:method:: isopop(array: numpy.ma.masked_array, nbnotnull: int = 99999)

      Remplissage des valeurs de palette sur base d'une équirépartition de valeurs


   .. py:method:: defaultgray_minmax(array: numpy.ma.masked_array, nbnotnull=99999)

      Remplissage des valeurs de palette sur base d'une équirépartition de valeurs


   .. py:method:: defaultblue_minmax(array: numpy.ma.masked_array, nbnotnull=99999)

      Remplissage des valeurs de palette sur base d'une équirépartition de valeurs


   .. py:method:: defaultblue()

      Remplissage des valeurs de palette sur base d'une équirépartition de valeurs