:py:mod:`wolfhece.analyze_vect`
===============================

.. py:module:: wolfhece.analyze_vect


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

.. py:class:: Compare_vectors


   Compare multiple vectors

   .. py:property:: layout

      Layout of the figure

   .. py:property:: reference

      Reference vector

   .. py:method:: add_ref_values(values: wolfhece.wolf_array.WolfArray | wolfhece.Results2DGPU.wolfres2DGPU | wolfhece.wolfresults_2D.Wolfresults_2D)

      Add values to the reference vector


   .. py:method:: del_ref_values(which: int | str)

      Pop values from the reference vector


   .. py:method:: reset_ref_values()

      Reset reference values


   .. py:method:: get_ref_values()

      Retrieve reference values


   .. py:method:: add_compare(support: wolfhece.PyVertexvectors.vector, values: list[wolfhece.wolf_array.WolfArray | wolfhece.Results2DGPU.wolfres2DGPU | wolfhece.wolfresults_2D.Wolfresults_2D] = None)

      Add values to compare


   .. py:method:: reset_compare()

      Reset comparison values


   .. py:method:: del_compare(which: int | str)

      Pop values from the comparison vector


   .. py:method:: get_compare_values()

      Retrieve comparison values


   .. py:method:: plot_ref(axis: int = 0)

      Plot reference vector


   .. py:method:: plot_compare(axis: int = 0)

      Plot comparison vectors along reference vector.

      We must project comparison vectors on the reference vector and plot them.


   .. py:method:: set_x_bounds(smin: float, smax: float, axis: int = 0)

      Set x bounds for the figure


   .. py:method:: set_y_bounds(ymin: float, ymax: float, axis: int = 0)

      Set y bounds for the figure