Plot MultiAxes tutorial: Difference between revisions

From FreeCAD Documentation
(Removed Tutorials_navi)
 
(23 intermediate revisions by 2 users not shown)
Line 8: Line 8:
|Time=
|Time=
|Author=
|Author=
|FCVersion=
|FCVersion=0.19
|Files=
|Files=
}}
}}


<!--T:1-->
<!--T:1-->
Please complete the [[Plot_Basic_tutorial|basic tutorial]] before starting with this tutorial. In this tutorial we will learn how to create and edit a multiaxes plot. You can learn more about the [[Plot_Module|Plot module here]].
Please complete the [[Plot_Basic_tutorial|basic tutorial]] before starting with this tutorial. In this tutorial we will learn how to create and edit a multiaxes plot. You can learn more about the [[Plot_Workbench|Plot Workbench here]].


</translate>
</translate>
Line 22: Line 22:


<!--T:3-->
<!--T:3-->
In the previous image you can see the result that we will aproximately obtain. Following this tutorial you will learn:
In the image you can see the result that we will approximately obtain. Following this tutorial you will learn:
* How to create a multiaxes Plot from the [[Python_console|Python console]].
* How to create a multiaxes Plot from the [[Python_console|Python console]].
* How to edit axes properties.
* How to edit axes properties.
* How to control grid/legend when several axes are present.
* How to control the grid and the legend when several axes sets are present.
* How to edit labels, titles and legend positions.
* How to edit the position of labels, titles and legends.


==Plotting data==
==Plotting data== <!--T:31-->


<!--T:4-->
<!--T:4-->
As we did in the [[Plot_Basic_tutorial|previous tutorial]] we will use the [[Python_console|Python console]] or [[Macros|macros]] to plot the data, but in this case we will plot the data using two different axes.
As we did in the [[Plot_Basic_tutorial|previous tutorial]] we will use the [[Python_console|Python console]] or [[Macros|macros]] to plot the data, but in this case we will plot the data using two axes sets.


===Creating plot data===
===Creating plot data=== <!--T:32-->


<!--T:5-->
<!--T:5-->
Line 51: Line 51:


<!--T:6-->
<!--T:6-->
As ''x'' moves from 0 to 2, the ''y'' function has a maximum value of 4, so if we try to plot this function with the trigonometrical ones, at least one function will be truncated or bad scaled, therefore we we need a multiaxes plot. A multiaxes plot in FreeCAD is intended to get a plot with multiple axes, not to get multiple plots in the same document.
As ''x'' moves from 0 to 2, the ''y'' function has a maximum value of 4, so if we try to plot this function with the trigonometrical ones, at least one function will be truncated or badly scaled, therefore we we need a multiaxes plot. A multiaxes plot in FreeCAD is intended to get a plot with multiple axes, not to get multiple plots in the same document.


===Drawing functions, adding new axes===
===Drawing functions, adding new axes=== <!--T:33-->


<!--T:7-->
<!--T:7-->
We will plot the polynomial function using the main axes. If all your axes have the same size it is not relevant which function is plotted first, but if this is not the case the function that uses the main, the biggest, axes must be plotted first (to ensure they are plotted on the white background). In order to do this we only need to launch a command.
We will plot the trigonometrical functions using the main axes. If all your axes have the same size it is not relevant which function is plotted first. But if this is not the case the function that uses the biggest axes, in our case the polynomial function, should be plotted last. The legend will be attached to the last axes system and it is more convenient if this is the biggest. To plot the trigonometrical functions we only need to launch some commands.


</translate>
</translate>
Line 64: Line 64:
except ImportError:
except ImportError:
from freecad.plot import Plot
from freecad.plot import Plot

Plot.plot(x,y,r"$x^2$")
Plot.plot(t,s,r"$\sin\left( 2 \pi t \right)$")
Plot.plot(t,c,r"$\cos\left( 2 \pi t \right)$")
}}
}}
<translate>
<translate>


<!--T:8-->
<!--T:8-->
In this example we pass the series label for the legend directly. Note that the label string has the ''r'' prefix in order to prevent Python from trying to interpret special characters (the ''\'' symbol is used frequently in [http://www.latex-project.org LaTeX] syntax).
In this example we pass the series labels for the legend directly. Note that the label strings have the ''r'' prefix in order to prevent Python from trying to interpret special characters (the ''\'' symbol is used frequently in [http://www.latex-project.org LaTeX] syntax).


<!--T:9-->
<!--T:9-->
Before we can plot the trigonometrical functions, we need to create new axes. In the [[Plot_Module|Plot module]] new axes are automatically selected as the active ones, and new plots will be associated with these axes.
Before we can plot the polynomial function, we need to create new axes. In the [[Plot_Workbench|Plot Workbench]] new axes are automatically selected as the active ones, and new plots will be associated with these axes.


</translate>
</translate>
{{Code|code=
{{Code|code=
Plot.addNewAxes()
Plot.addNewAxes()
Plot.plot(t,s,r"$\sin\left( 2 \pi t \right)$")
Plot.plot(x,y,r"$x^2$")
Plot.plot(t,c,r"$\cos\left( 2 \pi t \right)$")
}}
}}
<translate>
<translate>


<!--T:10-->
<!--T:10-->
As you can see your plot has gone crazy, with axes ticks overlapping, curves of the same color, etc. Now we need to use the [[Plot_Module|Plot module]] to fix this graph.
As you can see your plot has gone crazy, with axes ticks overlapping, curves of the same color, etc. Now we need to use the [[Plot_Workbench|Plot Workbench]] to fix this graph.


==Configuring plot== <!--T:11-->
==Configuring plot== <!--T:11-->


===Configuring axes===
===Configuring axes=== <!--T:34-->


<!--T:12-->
<!--T:12-->
[[Plot_Module|Plot module]] provides a tool to modify the properties of axes.
The [[Plot_Workbench|Plot Workbench]] provides a tool to modify the properties of axes.


</translate>
</translate>
Line 99: Line 100:


<!--T:14-->
<!--T:14-->
With the [[Plot_Axes|axes tool]] you can add or remove axes, and set the active axes, which are then used if you to plot more data. For the moment we will work with the selected axes, the last axes, which are associated with the trigonometrical functions.
With the [[Plot_Axes|axes tool]] you can add or remove axes, and set the active axes, which are then used if you plot more data.


<!--T:15-->
<!--T:15-->
We will move the horizontal and vertical dimension sliders to reduce the size of the axes (try to emulate example). Then we can set the axes alignment, changing it to top and right, and apply a small offset of two units.
To change the size of the first axes set, associated with the trigonometrical functions, it has to be activated first by changing the active axes from 1 to 0. We can then move the horizontal and vertical dimension sliders to reduce its size (try to emulate the example). We also need to change the alignment of the axes: select top and right respectively.


===Configuring series===
===Configuring series=== <!--T:35-->


<!--T:16-->
<!--T:16-->
Set the series properties as we did in the [[Plot_Basic_tutorial|previous tutorial]].
Set the series properties as we did in the [[Plot_Basic_tutorial|previous tutorial]].


===Showing grid and legend===
===Showing grid and legend=== <!--T:36-->


<!--T:17-->
<!--T:17-->
The [[Plot Grid|grid]] and [[Plot Legend|legend]] can be shown, and hidden, with the tools already described in the [[Plot_Basic_tutorial|previous tutorial]], but in this case the behavior is a little different because there are two axes sets.
The [[Plot_Grid|grid]] and [[Plot_Legend|legend]] can be shown, and hidden, with the tools already described in the [[Plot_Basic_tutorial|previous tutorial]], but in this case the behavior is a little different because there are two axes sets.


<!--T:18-->
<!--T:18-->
Grid lines are added to the active axes set. To add lines to the main axes set in our example, it has to be activated first by changing the active axes from 1 to 0 in the [[Plot_Axes|axes tool]].
Grid lines are added to the active axes set. To add lines to the second axes set in our example, it has to be activated first by changing the active axes from 0 to 1 in the [[Plot_Axes|axes tool]].


<!--T:19-->
<!--T:19-->
The legend will be the same for both axes sets, so you can choose either set, but it is strongly recommended to use the main, the biggest, axes set (0 in our example) because the legend will be positioned relative to these axes. If you show the legend now you will see that it is really badly placed, but we will fix that later.
As already mentioned the legend will be positioned relative last axes set. If you show the legend now you will see that it is really badly placed, but we will fix that later.


===Setting axes labels===
===Setting axes labels=== <!--T:37-->


<!--T:20-->
<!--T:20-->
When it comes to setting the axes [[Plot_Labels|labels]] we again have to deal with our two axes sets. But since axes labels are usually set per axis, the procedure is the same as described in the [[Plot_Basic_tutorial|previous tutorial]]. The [[Plot_Module|Plot module]] allows you to set a title per axes set. In this case we only want to set a title for the main axes.
When it comes to setting the axes [[Plot_Labels|labels]] we again have to deal with our two axes sets. But since labels are usually set for all axes, the procedure is the same as described in the [[Plot_Basic_tutorial|previous tutorial]]. The [[Plot_Workbench|Plot Workbench]] allows you to set a title per axes set. In this case we only want to set a title for the last, the biggest, axes set.


<!--T:21-->
<!--T:21-->
'''Axes 0:'''
'''Axes 0:'''
* X Label = $t$
* Y Label = $\mathrm{f} \left( t \right)$
'''Axes 1:'''
* Title = Multiaxes example
* Title = Multiaxes example
* X Label = $x$
* X Label = $x$
* Y Label = $\mathrm{f} \left( x \right)$
* Y Label = $\mathrm{f} \left( x \right)$
'''Axes 1:'''
* X Label = $t$
* Y Label = $\mathrm{f} \left( t \right)$


<!--T:22-->
<!--T:22-->
Change the font size of all labels to 20, and the font size of the title to 24. Again there is an element, the title, that is badly placed.
Change the font size of all labels to 20, and the font size of the title to 24. Again there is an element, the title, that is badly placed.


===Setting elements position===
===Setting elements position=== <!--T:38-->


<!--T:23-->
<!--T:23-->
[[Plot_Module|FreeCAD Plot module]] provides a tool in order to set the position of several plot elements, as titles, labels or legend.
The [[Plot_Workbench|Plot Workbench]] provides a tool to change the position of several plot elements, such as as titles, labels and legends.


</translate>
</translate>
Line 149: Line 150:


<!--T:25-->
<!--T:25-->
When you run the tool you see a list with all the editable elements. Title elements, as well as legend, can be moved in both directions, since axes labels can be moved only on the axes direction. Select title of axes 0 and move it to (0.24,1.01), then select legend and move it to a better position. You can increase legend labels fontsize too.
When you run the tool you will see a list of all editable elements. Titles and legends can be moved in both directions, but axis labels can only be moved along the axis they belong to. Select the title of axes 1 and move it to (0.24,1.01), then select the legend and move it to a better position. You can increase the font size of the legend labels as well.


==Saving plot== <!--T:26-->
==Saving plot== <!--T:26-->


<!--T:30-->
<!--T:30-->
Now you can save your work. See [[Plot_Basic_tutorial|previous tutorial]] if you don't remember how to do it.
Now you can save your work. See the [[Plot_Basic_tutorial|previous tutorial]] if you don't remember how to do it.




</translate>
</translate>
{{Tutorials_navi{{#translation:}}}}
{{Plot_Tools_navi{{#translation:}}}}
{{Plot_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 12:59, 14 April 2023

Tutorial
Topic
Plot workbench
Level
Intermediate
Time to complete
Authors
FreeCAD version
0.19
Example files
See also
None

Please complete the basic tutorial before starting with this tutorial. In this tutorial we will learn how to create and edit a multiaxes plot. You can learn more about the Plot Workbench here.

Multiaxes plot example

In the image you can see the result that we will approximately obtain. Following this tutorial you will learn:

  • How to create a multiaxes Plot from the Python console.
  • How to edit axes properties.
  • How to control the grid and the legend when several axes sets are present.
  • How to edit the position of labels, titles and legends.

Plotting data

As we did in the previous tutorial we will use the Python console or macros to plot the data, but in this case we will plot the data using two axes sets.

Creating plot data

In this example we will plot 3 functions, the two used in the previous tutorial, and a new polynomial one. The range of the polynomial function is different from the other functions therefore new axes are required. The next commands will create the data arrays for us:

import math
p = range(0,1001)
x = [2.0*xx/1000.0 for xx in p]
y = [xx**2.0 for xx in x]
t = [tt/1000.0 for tt in p]
s = [math.sin(math.pi*2.0*tt) for tt in t]
c = [math.cos(math.pi*2.0*tt) for tt in t]

As x moves from 0 to 2, the y function has a maximum value of 4, so if we try to plot this function with the trigonometrical ones, at least one function will be truncated or badly scaled, therefore we we need a multiaxes plot. A multiaxes plot in FreeCAD is intended to get a plot with multiple axes, not to get multiple plots in the same document.

Drawing functions, adding new axes

We will plot the trigonometrical functions using the main axes. If all your axes have the same size it is not relevant which function is plotted first. But if this is not the case the function that uses the biggest axes, in our case the polynomial function, should be plotted last. The legend will be attached to the last axes system and it is more convenient if this is the biggest. To plot the trigonometrical functions we only need to launch some commands.

try:
    from FreeCAD.Plot import Plot
except ImportError:
    from freecad.plot import Plot

Plot.plot(t,s,r"$\sin\left( 2 \pi t \right)$")
Plot.plot(t,c,r"$\cos\left( 2 \pi t \right)$")

In this example we pass the series labels for the legend directly. Note that the label strings have the r prefix in order to prevent Python from trying to interpret special characters (the \ symbol is used frequently in LaTeX syntax).

Before we can plot the polynomial function, we need to create new axes. In the Plot Workbench new axes are automatically selected as the active ones, and new plots will be associated with these axes.

Plot.addNewAxes()
Plot.plot(x,y,r"$x^2$")

As you can see your plot has gone crazy, with axes ticks overlapping, curves of the same color, etc. Now we need to use the Plot Workbench to fix this graph.

Configuring plot

Configuring axes

The Plot Workbench provides a tool to modify the properties of axes.

Axes configuration tool icon

With the axes tool you can add or remove axes, and set the active axes, which are then used if you plot more data.

To change the size of the first axes set, associated with the trigonometrical functions, it has to be activated first by changing the active axes from 1 to 0. We can then move the horizontal and vertical dimension sliders to reduce its size (try to emulate the example). We also need to change the alignment of the axes: select top and right respectively.

Configuring series

Set the series properties as we did in the previous tutorial.

Showing grid and legend

The grid and legend can be shown, and hidden, with the tools already described in the previous tutorial, but in this case the behavior is a little different because there are two axes sets.

Grid lines are added to the active axes set. To add lines to the second axes set in our example, it has to be activated first by changing the active axes from 0 to 1 in the axes tool.

As already mentioned the legend will be positioned relative last axes set. If you show the legend now you will see that it is really badly placed, but we will fix that later.

Setting axes labels

When it comes to setting the axes labels we again have to deal with our two axes sets. But since labels are usually set for all axes, the procedure is the same as described in the previous tutorial. The Plot Workbench allows you to set a title per axes set. In this case we only want to set a title for the last, the biggest, axes set.

Axes 0:

  • X Label = $t$
  • Y Label = $\mathrm{f} \left( t \right)$

Axes 1:

  • Title = Multiaxes example
  • X Label = $x$
  • Y Label = $\mathrm{f} \left( x \right)$

Change the font size of all labels to 20, and the font size of the title to 24. Again there is an element, the title, that is badly placed.

Setting elements position

The Plot Workbench provides a tool to change the position of several plot elements, such as as titles, labels and legends.

Position editor icon

When you run the tool you will see a list of all editable elements. Titles and legends can be moved in both directions, but axis labels can only be moved along the axis they belong to. Select the title of axes 1 and move it to (0.24,1.01), then select the legend and move it to a better position. You can increase the font size of the legend labels as well.

Saving plot

Now you can save your work. See the previous tutorial if you don't remember how to do it.