You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_MatrixDisplay.rst 2.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. .. _Doc_BoxAlgorithm_MatrixDisplay:
  2. Matrix Display
  3. ==============
  4. .. container:: attribution
  5. :Author:
  6. Laurent Bonnet
  7. :Company:
  8. INRIA/IRISA
  9. .. image:: images/Doc_BoxAlgorithm_MatrixDisplay.png
  10. The streamed matrix can be visualized using a table of values and/or a color gradient.
  11. This box displays an input matrix in a table of gradient-colored squares.
  12. **WARNING : The color gradient is centered (50%) at the value 0.**
  13. The limits of colors match the minimum and maximum values, ever received or in real time if the corresponding setting is set.
  14. These values can evolve symmetrically, using the maximum absolute value.
  15. Inputs
  16. ------
  17. .. csv-table::
  18. :header: "Input Name", "Stream Type"
  19. "Matrix", "Streamed matrix"
  20. Matrix
  21. ~~~~~~
  22. The matrix to display.
  23. .. _Doc_BoxAlgorithm_MatrixDisplay_Settings:
  24. Settings
  25. --------
  26. .. csv-table::
  27. :header: "Setting Name", "Type", "Default Value"
  28. "Color gradient", "Color Gradient", "0:2,36,58; 50:100,100,100; 100:83,17,20"
  29. "Steps", "Integer", "100"
  30. "Symetric min/max", "Boolean", "false"
  31. "Real time min/max", "Boolean", "false"
  32. Color gradient
  33. ~~~~~~~~~~~~~~
  34. The color gradient used.
  35. Steps
  36. ~~~~~
  37. The number of color steps used in the gradient. The more you have steps, the smoother the gradient will be .
  38. Symetric min/max
  39. ~~~~~~~~~~~~~~~~
  40. This parameter determines if the minimum and maximum values, matching the 0% and 100% color in the gradient,
  41. should change symmetrically using the maximum absolute value and its opposite.
  42. Real time min/max
  43. ~~~~~~~~~~~~~~~~~
  44. This parameter determines if the minimum and maximum values, matching the 0% and 100% color in the gradient,
  45. should be recomputed for each matrix received.
  46. .. _Doc_BoxAlgorithm_MatrixDisplay_VizSettings:
  47. Visualization Settings
  48. ----------------------
  49. Online settings :
  50. - Setting1 : Show/hide values
  51. - Setting2 : Show/hide colors
  52. .. _Doc_BoxAlgorithm_MatrixDisplay_Examples:
  53. Examples
  54. --------
  55. Here is an example using a :ref:`Doc_BoxAlgorithm_ConfusionMatrix` box that computes confusion matrix from classifier results.
  56. .. figure:: images/matrix_display_online.png
  57. :alt: Confusion matrix displayed using the Matrix Display
  58. :align: center
  59. Confusion matrix displayed using the Matrix Display