[tutorials] Create a new 'Visualisation Tutorials' group

and move topically related tutorials categories inside: - graphs - graphics - TWebCanvas - GUI and web GUI - event display tutorials - geometry - image - OpenGL and Cocoa The changes also involve updating all the necessary paths (across all of ROOT repository, including the CODEOWNERS file) and running git clang on the tutorials of this new group. A few more cleanups
root-project · Dec 9, 2024 · 63e1f9e · 63e1f9e
1 parent 1b5ec29
commit 63e1f9e
Show file tree

Hide file tree

Showing 495 changed files with 42,542 additions and 41,123 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -51,8 +51,8 @@ interpreter/cling/tools/packaging @vgvassilev
 /graf2d/cocoa/ @couet
 /graf3d/eve/ @osschar
 /graf3d/eve7/ @osschar @linev
-/tutorials/eve/ @osschar
-/tutorials/eve7/ @osschar @linev
+/tutorials/visualisation/eve7/eve/ @osschar
+/tutorials/visualisation/eve7/ @osschar @linev
 
 #different http/webgui components
 /net/http/ @linev
@@ -72,7 +72,7 @@ interpreter/cling/tools/packaging @vgvassilev
 /geom/webviewer/ @linev
 /ui5/ @linev
 /tutorials/rcanvas/ @linev
-/tutorials/webgui/ @linev
+/tutorials/visualisation/webgui/ @linev
 
 /cmake/ @bellenot
 *.cmake @bellenot

diff --git a/core/base/src/TColor.cxx b/core/base/src/TColor.cxx
@@ -206,7 +206,7 @@ These three color schemes are available as color sets with 6, 8, and 10 colors,
 (`P` for Petroff or Preferred).
 
 Begin_Macro
-../../../tutorials/graphics/accessiblecolorschemes.C
+../../../tutorials/visualisation/graphics/accessiblecolorschemes.C
 End_Macro
 
 The example thstackcolorscheme.C illustrates how to use these color schemes in THStack drawings.
@@ -312,7 +312,7 @@ display plots using different palettes on the same pad.
 The tutorial multipalette.C illustrates this feature.
 
 Begin_Macro(source)
-../../../tutorials/graphs/multipalette.C
+../../../tutorials/visualisation/graphs/multipalette.C
 End_Macro
 
 \since **6.26:**
@@ -358,8 +358,9 @@ As explained in [Crameri, F., Shephard, G.E. & Heron, P.J. The misuse of colour
 Nat Commun 11, 5444 (2020)](https://doi.org/10.1038/s41467-020-19160-7) some color maps
 can visually distord data, specially for people with colour-vision deficiencies.
 
-For instance one can immediately see the [disadvantages of the Rainbow color map](https://root.cern.ch/rainbow-color-map),
-which is misleading for colour-blinded people in a 2D plot (not so much in a 3D surfaces).
+For instance one can immediately see the [disadvantages of the Rainbow color
+map](https://root.cern.ch/rainbow-color-map), which is misleading for colour-blinded people in a 2D plot (not so much in
+a 3D surfaces).
 
 The `kCMYK` palette, is also not great because it's dark, then lighter, then
 half-dark again. Some others, like `kAquamarine`, have almost no contrast therefore it would
@@ -1051,7 +1052,7 @@ Or if you prefer to activate GL for a single canvas `c`, then use `c->SetSupport
 The following macro gives an example of transparency usage:
 
 Begin_Macro(source)
-../../../tutorials/graphics/transparency.C
+../../../tutorials/visualisation/graphics/transparency.C
 End_Macro
 
 */

diff --git a/documentation/doxygen/Doxyfile b/documentation/doxygen/Doxyfile
@@ -1076,7 +1076,7 @@ EXCLUDE_PATTERNS       = */G__* \
                          */src/lexertk.hpp \
                          *.xml \
                          *.dtd \
-                         */tutorials/webgui/qt5web/* \
+                         */tutorials/visualisation/webgui/qt5web/* \
                          */math/mathcore/src/CDT*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

diff --git a/documentation/users-guide/Geometry.md b/documentation/users-guide/Geometry.md
@@ -108,7 +108,7 @@ Before going further, let us get a look and feel of interacting with the
 modeller. For this, we will use one of the examples illustrating the
 geometry package. To get an idea on the geometry structure created in
 this example, just look at the link:
-<http://root.cern.ch/root/html/tutorials/geom/rootgeom.C.html>. You will
+<http://root.cern.ch/root/html/tutorials/visualisation/geom/rootgeom.C.html>. You will
 notice that this is a bit more complex that just creating the "world"
 since several other volumes are created and put together in a hierarchy.
 The purpose here is just to learn how to interact with a geometry that
@@ -508,7 +508,7 @@ initial material/mixture at time, while all resulting elements having a
 fractional weight less than precision are excluded.
 
 A demo macro for radioactive material features is
-`$ROOTSYS/tutorials/geom/RadioNuclides.C` It demonstrates also the decay
+`$ROOTSYS/tutorials/visualisation/geom/RadioNuclides.C` It demonstrates also the decay
 of a mixture made of radionuclides.
 
 ![Concentracion of elements derived

diff --git a/documentation/users-guide/Graphics.md b/documentation/users-guide/Graphics.md
@@ -1053,7 +1053,7 @@ The curly arc center is `(x1`, `y1)` and the radius is `rad`. The
 wavelength and the amplitude are given in percent of the line length.
 The parameters `phimin` and `phimax` are the starting and ending angle
 of the arc (given in degrees). Refer to
-`$ROOTSYS/tutorials/graphics/feynman.C` for the script that built the
+`$ROOTSYS/tutorials/visualisation/graphics/feynman.C` for the script that built the
 figure above.
 
 ### Text and Latex Mathematical Expressions
@@ -1188,7 +1188,7 @@ a -\> is obtained with `#vec{a}`
 
 #### Example 1
 
-The script `$ROOTSYS/tutorials/graphics/latex.C:`
+The script `$ROOTSYS/tutorials/visualisation/graphics/latex.C:`
 
 ``` {.cpp}
 {
@@ -1214,7 +1214,7 @@ latex.C](pictures/020000C1.jpg)
 
 #### Example 2
 
-The script `$ROOTSYS/tutorials/graphics/latex2.C:`
+The script `$ROOTSYS/tutorials/visualisation/graphics/latex2.C:`
 
 ``` {.cpp}
 {
@@ -1240,7 +1240,7 @@ latex2.C](pictures/020000C2.jpg)
 
 #### Example 3
 
-The script `$ROOTSYS/tutorials/graphics/latex3.C`:
+The script `$ROOTSYS/tutorials/visualisation/graphics/latex3.C`:
 
 ``` {.cpp}
 {
@@ -1344,7 +1344,7 @@ Int_t npaves, Option_t* option)
 TMathText's purpose is to write mathematical equations, exactly as TeX
 would do it. The syntax is the same as the TeX's one.
 
-The script `$ROOTSYS/tutorials/graphics/tmathtex.C`:
+The script `$ROOTSYS/tutorials/visualisation/graphics/tmathtex.C`:
 
 gives the following output:
 
@@ -3230,7 +3230,7 @@ code for it can be found under `$ROOTSYS/gl`.
 
 You can manipulate the viewer via the GUI or via the base
 **`TGLViewer`** object behind the interface. These are detailed below -
-see also `$ROOTSYS/tutorials/gl/glViewerExercise.C`.
+see also `$ROOTSYS/tutorials/visualisation/gl/glViewerExercise.C`.
 
 #### Projections Modes (Cameras)
 
@@ -3290,7 +3290,7 @@ calling the method `TGLViewer::SetCurrentCamera` with one of the
 v->SetCurrentCamera(TGLViewer::kCameraPerspXOZ);
 ```
 
-See also `$ROOTSYS/tutorials/gl/glViewerExercise.C`.
+See also `$ROOTSYS/tutorials/visualisation/gl/glViewerExercise.C`.
 
 #### Adjusting Cameras
 

diff --git a/documentation/users-guide/Graphs.md b/documentation/users-guide/Graphs.md
@@ -229,7 +229,7 @@ gStyle->SetEndErrorSize(np);
 The four parameters of **`TGraphErrors`** are: `X, Y` (as in
 **`TGraph`**), `X`-errors, and `Y`-errors - the size of the errors
 in the `x` and `y` direction. Next example is
-`$ROOTSYS/tutorials/graphs/gerrors.C.`
+`$ROOTSYS/tutorials/visualisation/graphs/gerrors.C.`
 
 ``` {.cpp}
 {
@@ -670,7 +670,7 @@ produces the next figure.
 
 A **`TGraph2DErrors`** is a **`TGraph2D`** with errors. It is useful to
 perform fits with errors on a 2D graph. An example is the macro
-`$ROOTSYS/tutorials/graphs/graph2derrorsfit.C`.
+`$ROOTSYS/tutorials/visualisation/graphs/graph2derrorsfit.C`.
 
 ## Fitting a Graph
 

diff --git a/documentation/users-guide/Histograms.md b/documentation/users-guide/Histograms.md
@@ -2124,7 +2124,7 @@ The format string must contain one of these modifiers:
    mypie->SetLabelFormat("%txt (%frac)");
 ```
 
-See the macro `$ROOTSYS/tutorials/graphics/piechart.C` .
+See the macro `$ROOTSYS/tutorials/visualisation/graphics/piechart.C` .
 
 ![The picture generated by tutorial macro piechart.C](pictures/03000042.png)
 

diff --git a/documentation/users-guide/WritingGUI.md b/documentation/users-guide/WritingGUI.md
@@ -560,7 +560,7 @@ This section presents all currently supported widgets in ROOT and their
 most useful methods. All of them can be considered as building blocks
 for an application, and most of them can be found in dialogs. Provided
 snippets of the code will give you practical guidelines where and how to
-use certain widgets. The macro `$ROOTSYS/tutorials/gui/guitest.C`
+use certain widgets. The macro `$ROOTSYS/tutorials/visualisation/gui/guitest.C`
 contains the complete source code.
 
 ![Widgets created by ROOT GUI classes](pictures/02000204.jpg)

diff --git a/geom/geom/doc/materials.md b/geom/geom/doc/materials.md
@@ -256,7 +256,7 @@ initial material/mixture at time, while all resulting elements having a
 fractional weight less than precision are excluded.
 
 A demo macro for radioactive material features is
-`$ROOTSYS/tutorials/geom/RadioNuclides.C` It demonstrates also the decay
+`$ROOTSYS/tutorials/visualisation/geom/RadioNuclides.C` It demonstrates also the decay
 of a mixture made of radionuclides.
 
 \image html geometry004.png width=600px

diff --git a/geom/geom/src/TGeoManager.cxx b/geom/geom/src/TGeoManager.cxx
@@ -89,7 +89,7 @@ constructed providing a string boolean expression between the components names.
 ## Example for building a simple geometry
 
 Begin_Macro(source)
-../../../tutorials/geom/rootgeom.C
+../../../tutorials/visualisation/geom/rootgeom.C
 End_Macro
 
 ## TGeoManager - the manager class for the geometry package.
@@ -138,7 +138,7 @@ this process.
 ## An interactive session
 
   Provided that a geometry was successfully built and closed (for instance the
-previous example $ROOTSYS/tutorials/geom/rootgeom.C ), the manager class will register
+previous example $ROOTSYS/tutorials/visualisation/geom/rootgeom.C ), the manager class will register
 itself to ROOT and the logical/physical structures will become immediately browsable.
 The ROOT browser will display starting from the geometry folder : the list of
 transformations and media, the top volume and the top logical node. These last

diff --git a/geom/webviewer/src/RGeomData.cxx b/geom/webviewer/src/RGeomData.cxx
@@ -1225,7 +1225,7 @@ void RGeomDescription::ResetRndrInfos()
 ///  }
 ///
 ///  In JSROOT one loads data from JSON file and call `build` function to
-///  produce three.js model. Also see example in tutorials/webgui/geom/ folder
+///  produce three.js model. Also see example in tutorials/visualisation/webgui/geom/ folder
 
 std::string RGeomDescription::ProduceJson(bool all_nodes)
 {

diff --git a/graf2d/asimage/src/TASImage.cxx b/graf2d/asimage/src/TASImage.cxx
@@ -54,7 +54,7 @@ palette can be modified with a GUI, just select StartPaletteEditor() from the
 context menu.
 
 Several examples showing how to use this class are available in the
-ROOT tutorials: `$ROOTSYS/tutorials/image/`
+ROOT tutorials: `$ROOTSYS/tutorials/visualisation/image/`
 */
 
 #include <ft2build.h>

diff --git a/graf2d/gpad/src/TAnnotation.cxx b/graf2d/gpad/src/TAnnotation.cxx
@@ -50,7 +50,7 @@ End_Macro
 Another example:
 
 Begin_Macro(source)
-../../../tutorials/graphs/annotation3d.C
+../../../tutorials/visualisation/graphs/annotation3d.C
 End_Macro
 */
 

diff --git a/graf2d/gpad/src/TButton.cxx b/graf2d/gpad/src/TButton.cxx
@@ -19,7 +19,6 @@
 
 ClassImp(TButton);
 
-
 /** \class TButton
 \ingroup gpad
 
@@ -68,8 +67,8 @@ void but() {
    but3->Draw();
 
 // Create last button with no name. Instead a graph is draw inside the button
-// Clicking on this button will invoke the macro $ROOTSYS/tutorials/graphs/graph.C
-   button = new TButton("",".x tutorials/graphs/graph.C",0.15,0.15,0.85,0.38);
+// Clicking on this button will invoke the macro $ROOTSYS/tutorials/visualisation/graphs/graph.C
+   button = new TButton("",".x tutorials/visualisation/graphs/graph.C",0.15,0.15,0.85,0.38);
    button->SetFillColor(42);
    button->Draw();
    button->SetEditable(kTRUE);

diff --git a/graf2d/graf/src/TArrow.cxx b/graf2d/graf/src/TArrow.cxx
@@ -37,7 +37,7 @@ Once an arrow is drawn on the screen:
 - One can click on any other arrow part to move the entire arrow.
 
 Begin_Macro(source)
-../../../tutorials/graphics/arrows.C
+../../../tutorials/visualisation/graphics/arrows.C
 End_Macro
 */
 

diff --git a/graf2d/graf/src/TCurlyArc.cxx b/graf2d/graf/src/TCurlyArc.cxx
@@ -21,7 +21,7 @@ are highly inspired from the methods used in TPolyLine and TArc.
 The picture below has been generated by the tutorial feynman.
 
 Begin_Macro(source)
-../../../tutorials/graphics/feynman.C
+../../../tutorials/visualisation/graphics/feynman.C
 End_Macro
 */
 

diff --git a/graf2d/graf/src/TCurlyLine.cxx b/graf2d/graf/src/TCurlyLine.cxx
@@ -21,7 +21,7 @@ are highly inspired from the methods used in TPolyLine and TArc.
 The picture below has been generated by the tutorial feynman.
 
 Begin_Macro(source)
-../../../tutorials/graphics/feynman.C
+../../../tutorials/visualisation/graphics/feynman.C
 End_Macro
 */
 

diff --git a/graf2d/graf/src/TDiamond.cxx b/graf2d/graf/src/TDiamond.cxx
@@ -36,7 +36,7 @@ A diamond has line attributes (see TAttLine) and fill area attributes (see TAttF
 Like for the class TPaveText, a TDiamond may have one or more line(s) of text inside.
 
 Begin_Macro(source)
-../../../tutorials/graphics/diamond.C
+../../../tutorials/visualisation/graphics/diamond.C
 End_Macro
 */
 

diff --git a/graf2d/graf/src/TEllipse.cxx b/graf2d/graf/src/TEllipse.cxx
@@ -47,7 +47,7 @@ call the function `SetNoEdges()`. To remove completely the ellipse
 outline it is enough to specify 0 as line style.
 
 Begin_Macro(source)
-../../../tutorials/graphics/ellipse.C
+../../../tutorials/visualisation/graphics/ellipse.C
 End_Macro
 */
 

diff --git a/graf2d/graf/src/TGaxis.cxx b/graf2d/graf/src/TGaxis.cxx
@@ -98,7 +98,7 @@ A `TGaxis` is defined the following way:
 The example below generates various kind of axis.
 
 Begin_Macro(source)
-../../../tutorials/graphics/gaxis.C
+../../../tutorials/visualisation/graphics/gaxis.C
 End_Macro
 
 \anchor GA01
@@ -675,15 +675,15 @@ and `localtime` give with what gives `TGaxis`. It can be used
 as referenced test to check if the time option of `TGaxis` is working properly.
 
 Begin_Macro(source)
-../../../tutorials/graphs/timeonaxis3.C
+../../../tutorials/visualisation/graphs/timeonaxis3.C
 End_Macro
 
 
 The following macro illustrates the use, with histograms axis, of the time mode on the axis
 with different time intervals and time formats.
 
 Begin_Macro(source)
-../../../tutorials/graphs/timeonaxis.C
+../../../tutorials/visualisation/graphs/timeonaxis.C
 End_Macro
 
 */

diff --git a/graf2d/graf/src/TMathText.cxx b/graf2d/graf/src/TMathText.cxx
@@ -36,13 +36,13 @@ do it. The syntax is the same as the TeX's one.
 The following example demonstrate how to use TMathText:
 
 Begin_Macro(source)
-../../../tutorials/graphics/tmathtext.C
+../../../tutorials/visualisation/graphics/tmathtext.C
 End_Macro
 
 The list of all available symbols is given in the following example:
 
 Begin_Macro
-../../../tutorials/graphics/tmathtext2.C
+../../../tutorials/visualisation/graphics/tmathtext2.C
 End_Macro
 
 #### Limitation:

diff --git a/graf2d/graf/src/TPaveText.cxx b/graf2d/graf/src/TPaveText.cxx
@@ -29,7 +29,6 @@
 
 ClassImp(TPaveText);
 
-
 /** \class TPaveText
 \ingroup BasicGraphics
 
@@ -50,7 +49,7 @@ of a line.
 
 Example:
 Begin_Macro(source)
-../../../tutorials/graphics/pavetext.C
+../../../tutorials/visualisation/graphics/pavetext.C
 End_Macro
 
 GetListOfLines can also be used to retrieve all the lines in the TPaveText as

diff --git a/graf2d/graf/src/TPie.cxx b/graf2d/graf/src/TPie.cxx
@@ -37,7 +37,7 @@ Draw a Pie Chart,
 Example:
 
 Begin_Macro(source)
-../../../tutorials/graphics/piechart.C
+../../../tutorials/visualisation/graphics/piechart.C
 End_Macro
 */
 

diff --git a/graf2d/gviz/src/TGraphStruct.cxx b/graf2d/gviz/src/TGraphStruct.cxx
@@ -49,7 +49,7 @@ three classes:
     a TGraphStruct.
 
 Begin_Macro(source)
-../../../tutorials/graphs/graphstruct.C
+../../../tutorials/visualisation/graphs/graphstruct.C
 End_Macro
 
 A graph structure can be dumped into a "dot" file using DumpAsDotFile.

diff --git a/graf3d/eve/src/TEveBoxSet.cxx b/graf3d/eve/src/TEveBoxSet.cxx
@@ -36,7 +36,7 @@ Each primitive can be assigned:
   2. External TObject* (stored as TRef).
 
 See also base-class TEveDigitSet for more information.
-Tutorial: tutorials/eve/boxset_test.C
+Tutorial: tutorials/visualisation/eve7/eve/boxset_test.C
 */
 
 ClassImp(TEveBoxSet);

diff --git a/graf3d/eve7/src/REveBoxSet.cxx b/graf3d/eve7/src/REveBoxSet.cxx
@@ -45,7 +45,7 @@ Each primitive can be assigned:
   2. External TObject* (stored as TRef).
 
 See also base-class REveDigitSet for more information.
-Tutorial: tutorials/eve/boxset_test.C
+Tutorial: tutorials/visualisation/eve7/eve/boxset_test.C
 */
 
 ////////////////////////////////////////////////////////////////////////////////