Script | Spoken-Tutorial - User contributions [en]

GUI-in-Scilab/C2/Plotting-2D-parametric-curves-in-GUI/English

2021-09-20T03:57:10Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, delete, Scilab, Parametric equation, Circle, 2D, Text box, Axes, callback function, Tag, String'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''2D''' parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn to:

<ul>
<li><blockquote>Plot the Parametric equation of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Use a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Use the '''delete''' function.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Circle?'''
|'''What is a Parametric Equation of a Circle?'''

The Parametric Equation of a circle is x = r*cos(Θ) and y = r*sin(Θ)'''.'''

Where,

<ul>
<li><blockquote>'''x''' & '''y''' are the coordinates for a given point on the circle and</blockquote></li>
<li><blockquote>'''r''' is the radius of the circle.</blockquote></li></ul>

We will use these two '''equations''' to plot the circle.
|-
|
Show Slide:

'''What is a Slider?'''
|'''What is a Slider?'''

'''Slider''' is an object that allows the user to dynamically change the value of a '''parameter'''.

It allows the user to move an indicator horizontally to set new values.

The user can also alter the values by clicking on any point on the '''Slider'''.
|-
|
Show Slide:

'''What is a delete function?'''
|'''What is a delete function?'''

The '''delete''' function is used to delete the '''graphical response'''.

The '''object’s''' '''handle''' whose response is to be deleted, is passed as an '''argument'''.

Syntax: '''delete(<handle of an object>)'''
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting2dcurves.sce''' file.

|
Let us look at how to use a '''Slider''' to plot a circle with varying radii.

I have opened the '''plotting2dcurves.sce''' file using the '''GUIBuilder toolbox'''.

Now let us look at the '''objects''' that are taken on this graphic window.
|-
|
On '''Graphic Window Number 1''',

hover over the '''Text''' box.

|
We have a '''Text''' box with the '''Tag''' '''‘txt_radius'''’ and the '''String''' part is kept empty.

Hence, a default value '''UnName1''' is assigned to it as '''String.'''

The '''Text''' box will display the exact value of the radius that the '''Slider''' has selected.
|-
|
On '''Graphic Window Number 1''',

hover over '''Axes'''.

|
We also have an '''Axes''' with the '''Tag''' '''‘ax_radius’''' and the '''String''' as ‘'''Circle'''’.

This will display the '''response''' of the circle.
|-
| Only narration
| Now let us add a '''Slider''' to control the radius value.
|-
|
On '''GUIBuilder Palette,'''

click on the '''Slider'''.
|
On the '''GUIBuilder''' '''Palette''', click on the '''Slider'''.

The '''Scilab Multiple Values Request''' window appears.
|-
|
On '''Scilab Multiple Values Request''' Window,

type '''''sl_radius''''' in '''Tag''' field.

Type '''''Radius''''' in '''String''' field.

Click on '''OK.'''
|
Type '''''sl_radius''''' in the '''Tag''' field and '''''Radius''''' in the '''String''' field.

Close the window by clicking on the '''OK''' button.
|-
|
On '''Graphic Window Number 1''',

place the '''Slider''' above the '''Text''' box.
| Now place the '''Slider''' above the '''Text''' box.
|-
|
On '''Graphic Window Number 1''',

move the indicator on the '''Slider''' horizontally.
|
Then move the '''Slider''' indicator horizontally to vary the value.

However, we find that we are unable to move the indicator.

We must first enable the '''Slider''' to do so. Let us do that.
|-
|
On '''GUIBuilder Palette''' Window,

cursor on the right side panel.
|
Go to the '''GUIBuilder Palette''' and look at the right side panel.

It displays a list of '''Tag''' names for the objects on the '''Graphic''' window.
|-
|
On '''GUIBuilder Palette''' Window,

click on '''sl_radius'''.

Click on '''Object Properties'''.
|
Click on '''sl_radius.'''

Then click on the '''Object Properties''' button at the bottom right of the window.

The '''Scilab Multiple Values Request''' window will open.
|-
|
On the '''Scilab Multiple Values Request''' Window,

hover over '''Enable'''.

change '''Enable''' property to ‘'''on'''’.
|
Search for the object property '''Enable'''.

Change it from '''Off''' to '''On'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Max''' field.

Change the value from '''1 to 10'''.
|
We also have to change one more object property which is ''''Max''''.

This property will set the upper limit of the '''Slider.'''

Change it from '''1''' to '''10'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Min''' field.

Click on '''OK''' button.
|
Notice the object property ''''Min'''' which is lower limit of the '''Slider.'''

It is always set to '''0,''' by default.

Now, let us vary the value of the radius using the '''Slider''' from '''0 to 10'''.

Let us save the changes by clicking on the '''OK''' button at the bottom.
|-
|
On '''Graphic Window Number 1''',

hover cursor over the '''Graphic Window Number 1'''.
|
Now, I will generate the '''Scilab''' code for the same.

In the code file, we will write the code to connect the '''Slider''' and the '''Text''' box.

As a result, the '''Text''' box will display the exact value of the '''Slider'''.

We will also write a '''user-defined''' function to plot the circle.
|-
|
On the '''GUIBuilder Palette''' Window,

click on '''Generate,'''

Click on '''Generate GUI Code'''.
|
On the '''GUIBuilder Palette''' click on the '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-2d'''''.

Click on '''OK.'''

|
I will name this file as '''parametric-2d.'''

Click on the '''OK''' button to save it.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
A '''dialog''' box appears and displays the message “'''GUI created successfully!”'''

Click on '''OK.'''
|-
| Cursor on '''SciNotes''' Window.
| The corresponding '''Scilab''' code opens.
|-
|
On '''SciNotes''' Window,

highlight '''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight '''handles.ax_radius'''.
| '''handles.ax_radius''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight '''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

cursor on '''sl_radius_callback''' Function.
|
Now, let us write a function definition for '''sl_radius_callback''' function.

The function will basically link the '''Text''' box and the '''Slider'''.
|-
|
Cursor on '''SciNotes''' window,

within '''sl_radius_callback''' type,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Type the code as shown here with the same syntax.

The same code can be found in a file in the '''Code files''' section on this video page.

You can use it as explained earlier in this tutorial.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius.string = string(handles.sl_radius.value)'''
| This line will assign the value of the '''Slider''' to the '''Text''' box'''.'''
|-
|
On '''SciNotes''' Window,

highlight,

'''r = strtod(handles.txt_radius.string)'''
|
Next, we will assign the radius value from the '''Text''' box to a variable '''‘r’.'''

Later on, we can use the variable '''‘r'''’ while writing the equation of a circle.
|-
|
On '''SciNotes Window''',

cursor on new line outside the '''sl_radius_callback''' function, type,

'''''function plot_circle()'''''

'''''theta = 0:0.1:4*%pi'''''

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''

'''''plot(x,y)'''''

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Further, we will write a '''user defined''' function '''plot_circle()''' to plot the circle.

Type the code in the same way as before, with the same syntax.

This can also be found in the '''Code files''' section.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''theta = 0:0.1:4*%pi'''''
|
First, we have defined the range of '''theta'''.

It will vary from '''0 to 4𝝅''' with a step size of '''0.1.'''
|-
|
On the '''SciNotes Window,'''

highlight,

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''
| The next two lines define the parametric equation of the circle in terms of '''x''' and '''y'''.
|-
|
On the '''SciNotes Window,'''

highlight,

'''plot(x,y)'''
| The following line will plot the circle.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| The next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On '''SciNotes Window''',

Inside the '''sl_radius_callback Function''' type,

'''plot_circle()'''
|
Let us call the '''plot_circle()''' function inside the callback function.

At the end of the '''sl_radius_callback''' function definition, type '''plot_circle()'''

As a result, when we move the '''Slider''', the circle is plotted for each radius value.
|-
|
On the '''SciNotes Window''',

press '''Ctrl''' + '''S.'''
| Let us save the code by pressing '''Ctrl''' + '''S''' keys together on the keyboard.
|-
|
On '''SciNotes Window''',

click on '''Execute''' Button on '''menubar.'''

Click on '''File with echo.'''
|
We will now execute the code.

Click on the '''Execute''' button on the '''menu bar'''.

Then click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider'''.

hover over '''Text''' box.

move the '''Slider''' indicator on the right side'''.'''

move the '''Slider''' indicator on the left side'''.'''
|
Let us move the indicator given on the '''Slider.'''

We can see that as we move the indicator, a circle is being plotted.

Notice the '''Text''' box. The value of the radius is also getting changed along with it.

Moving the indicator towards the right increases the radius.

And moving the indicator towards the left decreases the radius.
|-
|
On '''Graphic Window Number 2''',

hover over '''Axes'''.

Close '''Graphic Window Number 2'''.
|
But, the earlier responses are still visible.

Let us delete them by adding a single line.

This line is to be written at the start of '''plot_circle() function''' definition'''.'''

Close the '''Graphic Window Number 2'''.
|-
|
On '''SciNotes Window''',

Type within '''''plot_circle()''''' function and then highlight,

'''''delete(handles.ax_radius.children)'''''
|
Type the line as shown here with the same syntax.

This line deletes all the '''children''' of the current '''Axes'''.

Here, '''children''' refers to the '''subplot''' of the '''Axes'''.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save the work by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On '''SciNotes Window''',

click on '''Execute,'''

Click on '''File with echo.'''
| Let us go back to the '''menu bar''' and click on '''Execute''' and then click on '''File with echo'''.
|-
|
On '''Graphic Window Number 2,'''

move the '''Slider''' indicator to the right and then on the left side'''.'''
|
Now move the '''Slider''' indicator to the right and then to the left.

The earlier responses are now deleted and no longer visible.

So, in this way we can build a '''GUI''' for plotting a '''2D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the Parametric equation of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Used a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Used the '''delete''' function.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Create a '''GUI''' to plot a '''Parabola''' using its parametric equations, y = a*(t)^2, x = 2*a*t.</blockquote></li></ul>
<ul>
<li><blockquote>Change ''''a'''' from '''-1 to 1''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider, ''''t'''' varies from '''-10''' to '''10'''.</blockquote></li>
<li><blockquote>Add grid lines to the plot and label the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
<ul>
<li><blockquote>We conduct workshops using '''Spoken Tutorials''' and give certificates.</blockquote></li>
<li><blockquote>Please contact us.</blockquote></li></ul>
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
<ul>
<li><blockquote>Please post your timed queries in this forum.</blockquote></li></ul>
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-09-20T03:50:14Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D''' parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>To plot the parametric equation of a sphere using '''GUI.'''</blockquote></li>
<li><blockquote>Use of '''surf '''command.</blockquote></li>
<li><blockquote>Use of '''mesh''' command and;</blockquote></li>
<li><blockquote>Use of '''meshgrid''' command</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and;</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|'''What is a Parametric Equation of a Sphere?'''

The parametric equation of a sphere is: 
x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ)'''.'''

Where''','''

<ul>
<li><blockquote>'''x''', '''y, z''' are the cartesian coordinates of a given point on the sphere.</blockquote></li>
<li><blockquote>'''r''' is the radius of the sphere and;</blockquote></li>
<li><blockquote>'''theta''' & '''phi''' are the spherical coordinates. They lie in the range '''0''' to '''2𝞹'''.</blockquote></li></ul>

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf''' and '''mesh''' commands in this tutorial.

These commands are used to create a '''3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|'''What is the surf command?'''

The '''surf''' command draws a '''3D''' parametric surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf''' command will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|'''What is the mesh command?'''

The '''mesh''' command also draws a '''3D''' parametric surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh''' command will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf''' commands type the following on the '''Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

|
Locate the '''plotting3dcurves.sce''' file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text''' box and an '''Axes'''.

|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text''' box and an '''Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’''' and '''String ‘Radius’.'''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

|
Next, we have a '''Text''' box to display the radius.

It has '''Tag ‘txt_radius’''' and the '''String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

|
Lastly, we have the '''Axes''' to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to the '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

|
I will name this file as '''parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
It shows a new dialog box that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback''' function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback''' function definition.

It has two lines of code in it.

The code essentially connects the '''Slider''' to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf(x, y, z);'''''

'''''//mesh(x, y, z);'''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a user-defined function '''plot_sphere()''' to plot the sphere.

Type the code as shown here with the same syntax.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete''' function to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v);'''''
|
Notice the next three lines.

The '''meshgrid''' command is used.

It is used to generate '''u''' and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and '''theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric equation in terms of '''x, y''' and '''z'''.
|-
| Only narration
| Next, we will plot a '''3D''' parametric curve of a sphere.
|-
|
highlight,

'''''surf(x, y, z);'''''
| Firstly, we’ll see the output of the '''surf''' command.
|-
|
highlight,

'''''//mesh(x, y, z);'''''
|
Then next we will see the '''mesh''' command.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback''' function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere()''' function inside the '''callback''' function.

At the end of '''sl_radius_callback''' function definition type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save our code by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the indicator on the '''Slider,''' a sphere is being plotted.

The '''surf''' command now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh''' command.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf(x, y, z);'''''

'''''mesh(x, y, z);'''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf''' command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh''' command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
| Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh''' command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh''' command now plots a '''3D''' sphere with a white surface.
|-
| Only narration
| So this way we can build a '''GUI''' for plotting a '''3D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the parametric equation of a sphere using '''GUI'''.</blockquote></li>
<li><blockquote>Used the '''surf''' command.</blockquote></li>
<li><blockquote>Used the '''mesh''' command and;</blockquote></li>
<li><blockquote>Used the '''meshgrid''' command.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Using '''surf''' and '''mesh''', build a '''GUI''' to plot a '''3D''' hemisphere. Parametric equations: x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ).</blockquote></li></ul>
<ul>
<li><blockquote>Place the hemisphere on a horizontal plane.</blockquote></li></ul>

<ul>
<li><blockquote>Change radius ‘'''r'''’ from '''1''' to '''10''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider that '''theta''' & '''phi''' vary from '''0''' to '''𝞹.'''</blockquote></li>
<li><blockquote>Add '''grid lines''' to the plot and '''label''' the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-09-20T03:47:21Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D''' parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>To plot the parametric equation of a sphere using '''GUI.'''</blockquote></li>
<li><blockquote>Use of '''surf '''command.</blockquote></li>
<li><blockquote>Use of '''mesh''' command and;</blockquote></li>
<li><blockquote>Use of '''meshgrid''' command</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and;</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|'''What is a Parametric Equation of a Sphere?'''

The parametric equation of a sphere is: 
x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ)'''.'''

Where''','''

<ul>
<li><blockquote>'''x''', '''y, z''' are the cartesian coordinates of a given point on the sphere.</blockquote></li>
<li><blockquote>'''r''' is the radius of the sphere and;</blockquote></li>
<li><blockquote>'''theta''' & '''phi''' are the spherical coordinates. They lie in the range '''0''' to '''2𝞹'''.</blockquote></li></ul>

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf''' and '''mesh''' commands in this tutorial.

These commands are used to create a '''3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|'''What is the surf command?'''

The '''surf''' command draws a '''3D''' parametric surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf''' command will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|'''What is the mesh command?'''

The '''mesh''' command also draws a '''3D''' parametric surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh''' command will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf''' commands type the following on the '''Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

|
Locate the '''plotting3dcurves.sce''' file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text''' box and an '''Axes'''.

|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text''' box and an '''Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’''' and '''String ‘Radius’.'''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

|
Next, we have a '''Text''' box to display the radius.

It has '''Tag ‘txt_radius’''' and the '''String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

|
Lastly, we have the '''Axes''' to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to the '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

|
I will name this file as '''parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
It shows a new dialog box that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback''' function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback''' function definition.

It has two lines of code in it.

The code essentially connects the '''Slider''' to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf(x, y, z);'''''

'''''//mesh(x, y, z);'''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a user-defined function '''plot_sphere()''' to plot the sphere.

Type the code as shown here with the same syntax.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete''' function to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v);'''''
|
Notice the next three lines.

The '''meshgrid''' command is used.

It is used to generate '''u''' and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and '''theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric equation in terms of '''x, y''' and '''z'''.
|-
|
| Next, we will plot a '''3D''' parametric curve of a sphere.
|-
|
highlight,

'''''surf(x, y, z);'''''
| Firstly, we’ll see the output of the '''surf''' command.
|-
|
highlight,

'''''//mesh(x, y, z);'''''
|
Then next we will see the '''mesh''' command.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback''' function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere()''' function inside the '''callback''' function.

At the end of '''sl_radius_callback''' function definition type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save our code by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the indicator on the '''Slider,''' a sphere is being plotted.

The '''surf''' command now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh''' command.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf(x, y, z);'''''

'''''mesh(x, y, z);'''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf''' command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh''' command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
| Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh''' command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh''' command now plots a '''3D''' sphere with a white surface.
|-
|
| So this way we can build a '''GUI''' for plotting a '''3D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the parametric equation of a sphere using '''GUI'''.</blockquote></li>
<li><blockquote>Used the '''surf''' command.</blockquote></li>
<li><blockquote>Used the '''mesh''' command and;</blockquote></li>
<li><blockquote>Used the '''meshgrid''' command.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Using '''surf''' and '''mesh''', build a '''GUI''' to plot a '''3D''' hemisphere. Parametric equations: x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ).</blockquote></li></ul>
<ul>
<li><blockquote>Place the hemisphere on a horizontal plane.</blockquote></li></ul>

<ul>
<li><blockquote>Change radius ‘'''r'''’ from '''1''' to '''10''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider that '''theta''' & '''phi''' vary from '''0''' to '''𝞹.'''</blockquote></li>
<li><blockquote>Add '''grid lines''' to the plot and '''label''' the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-09-20T03:33:54Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D parametric curves'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>To plot the '''parametric''' equation of a sphere using '''GUI.'''</blockquote></li>
<li><blockquote>Use of '''surf command'''.</blockquote></li>
<li><blockquote>Use of '''mesh command''' and;</blockquote></li>
<li><blockquote>Use of '''meshgrid command'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and;</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|'''What is a Parametric Equation of a Sphere?'''

The '''parametric equation''' of a sphere is: 
x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ)'''.'''

Where''','''

<ul>
<li><blockquote>'''x''', '''y, z''' are the '''cartesian coordinates''' of a given point on the sphere.</blockquote></li>
<li><blockquote>'''r''' is the radius of the sphere and;</blockquote></li>
<li><blockquote>'''theta''' & '''phi''' are the '''spherical coordinates'''. They lie in the range '''0''' to '''2𝞹'''.</blockquote></li></ul>

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf''' and '''mesh''' commands in this tutorial.

These '''commands''' are used to create a '''3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|'''What is the surf command?'''

The '''surf command''' draws a '''3D parametric''' surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf command''' will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|'''What is the mesh command?'''

The '''mesh command''' also draws a '''3D parametric''' surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh command''' will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf commands''' type the following on the '''Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

|
Locate the '''plotting3dcurves.sce''' file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text''' box and an '''Axes'''.

|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text''' box and an '''Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’''' and '''String ‘Radius’.'''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

|
Next, we have a '''Text''' box to display the radius.

It has '''Tag ‘txt_radius’''' and the '''String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

|
Lastly, we have the '''Axes''' to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to the '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

|
I will name this file as '''parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
It shows a new dialog box that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback''' function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback function''' definition.

It has two lines of code in it.

The code essentially connects the '''Slider''' to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf(x, y, z);'''''

'''''//mesh(x, y, z);'''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a '''user-defined function plot_sphere()''' to plot the sphere.

Type the code as shown here with the same '''syntax'''.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete function''' to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v);'''''
|
Notice the next three lines.

The '''meshgrid command''' is used.

It is used to generate '''u''' and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and '''theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric equation in terms of '''x, y''' and '''z'''.
|-
|
| Next, we will plot a '''3D parametric''' curve of a sphere.
|-
|
highlight,

'''''surf(x, y, z);'''''
| Firstly, we’ll see the output of the '''surf command'''.
|-
|
highlight,

'''''//mesh(x, y, z);'''''
|
Then next we will see the '''mesh command'''.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback''' function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere() function''' inside the '''callback function'''.

At the end of '''sl_radius_callback function''' definition type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save our code by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the '''indicator''' on the '''Slider,''' a sphere is being plotted.

The '''surf command''' now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh command'''.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf(x, y, z);'''''

'''''mesh(x, y, z);'''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf''' command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh''' command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
| Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh''' command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh''' command now plots a '''3D''' sphere with a white surface.
|-
|
| So this way we can build a '''GUI''' for plotting a '''3D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''parametric''' equation of a sphere using '''GUI'''.</blockquote></li>
<li><blockquote>Used the '''surf command'''.</blockquote></li>
<li><blockquote>Used the '''mesh command''' and;</blockquote></li>
<li><blockquote>Used the '''meshgrid command'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Using '''surf''' and '''mesh''', build a '''GUI''' to plot a '''3D''' hemisphere. Parametric equations: x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ).</blockquote></li></ul>
<ul>
<li><blockquote>Place the hemisphere on a horizontal plane.</blockquote></li></ul>

<ul>
<li><blockquote>Change radius ‘'''r'''’ from '''1''' to '''10''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider that '''theta''' & '''phi''' vary from '''0''' to '''𝞹.'''</blockquote></li>
<li><blockquote>Add '''grid lines''' to the plot and '''label''' the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-09-20T03:33:09Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D parametric curves'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>To plot the '''parametric''' equation of a sphere using '''GUI.'''</blockquote></li>
<li><blockquote>Use of '''surf command'''.</blockquote></li>
<li><blockquote>Use of '''mesh command''' and;</blockquote></li>
<li><blockquote>Use of '''meshgrid command'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and;</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|'''What is a Parametric Equation of a Sphere?'''

The '''parametric equation''' of a sphere is: 
x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ)'''.'''

Where''','''

<ul>
<li><blockquote>'''x''', '''y, z''' are the '''cartesian coordinates''' of a given point on the sphere.</blockquote></li>
<li><blockquote>'''r''' is the radius of the sphere and;</blockquote></li>
<li><blockquote>'''theta''' & '''phi''' are the '''spherical coordinates'''. They lie in the range '''0''' to '''2𝞹'''.</blockquote></li></ul>

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf''' and '''mesh''' commands in this tutorial.

These '''commands''' are used to create a '''3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|'''What is the surf command?'''

The '''surf command''' draws a '''3D parametric''' surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf command''' will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|'''What is the mesh command?'''

The '''mesh command''' also draws a '''3D parametric''' surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh command''' will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf commands''' type the following on the '''Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

Video-editor: Please put a textbox on screen. “plotting3dcurves.sce”
|
Locate the '''plotting3dcurves.sce''' file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text''' box and an '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: sl_radius, String: Radius”
|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text''' box and an '''Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’''' and '''String ‘Radius’.'''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius, String: Radius”
|
Next, we have a '''Text''' box to display the radius.

It has '''Tag ‘txt_radius’''' and the '''String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_plot, String: Sphere”
|
Lastly, we have the '''Axes''' to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to the '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as '''parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
It shows a new dialog box that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback''' function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback function''' definition.

It has two lines of code in it.

The code essentially connects the '''Slider''' to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf(x, y, z);'''''

'''''//mesh(x, y, z);'''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a '''user-defined function plot_sphere()''' to plot the sphere.

Type the code as shown here with the same '''syntax'''.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete function''' to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v);'''''
|
Notice the next three lines.

The '''meshgrid command''' is used.

It is used to generate '''u''' and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and '''theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric equation in terms of '''x, y''' and '''z'''.
|-
|
| Next, we will plot a '''3D parametric''' curve of a sphere.
|-
|
highlight,

'''''surf(x, y, z);'''''
| Firstly, we’ll see the output of the '''surf command'''.
|-
|
highlight,

'''''//mesh(x, y, z);'''''
|
Then next we will see the '''mesh command'''.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback''' function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere() function''' inside the '''callback function'''.

At the end of '''sl_radius_callback function''' definition type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save our code by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the '''indicator''' on the '''Slider,''' a sphere is being plotted.

The '''surf command''' now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh command'''.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf(x, y, z);'''''

'''''mesh(x, y, z);'''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf''' command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh''' command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
| Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh''' command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh''' command now plots a '''3D''' sphere with a white surface.
|-
|
| So this way we can build a '''GUI''' for plotting a '''3D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''parametric''' equation of a sphere using '''GUI'''.</blockquote></li>
<li><blockquote>Used the '''surf command'''.</blockquote></li>
<li><blockquote>Used the '''mesh command''' and;</blockquote></li>
<li><blockquote>Used the '''meshgrid command'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Using '''surf''' and '''mesh''', build a '''GUI''' to plot a '''3D''' hemisphere. Parametric equations: x = r*cos(θ)*sin(φ) , y = r*sin(θ)*sin(φ) & z = r*cos(φ).</blockquote></li></ul>
<ul>
<li><blockquote>Place the hemisphere on a horizontal plane.</blockquote></li></ul>

<ul>
<li><blockquote>Change radius ‘'''r'''’ from '''1''' to '''10''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider that '''theta''' & '''phi''' vary from '''0''' to '''𝞹.'''</blockquote></li>
<li><blockquote>Add '''grid lines''' to the plot and '''label''' the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-2D-parametric-curves-in-GUI/English

2021-09-20T03:05:35Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, delete, Scilab, Parametric equation, Circle, 2D, Text box, Axes, callback function, Tag, String'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting 2D parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn to:

<ul>
<li><blockquote>Plot the '''Parametric equation''' of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Use a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Use the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Circle?'''
|'''What is a Parametric Equation of a Circle?'''

The '''Parametric Equation''' of a circle is x = r*cos(Θ) and y = r*sin(Θ)'''.'''

Where,

<ul>
<li><blockquote>'''x''' & '''y''' are the coordinates for a given point on the circle and</blockquote></li>
<li><blockquote>'''r''' is the radius of the circle.</blockquote></li></ul>

We will use these two '''equations''' to plot the circle.
|-
|
Show Slide:

'''What is a Slider?'''
|'''What is a Slider?'''

'''Slider''' is an object that allows the user to dynamically change the value of a '''parameter'''.

It allows the user to move an indicator horizontally to set new values.

The user can also alter the values by clicking on any point on the '''Slider'''.
|-
|
Show Slide:

'''What is a delete function?'''
|'''What is a delete function?'''

The '''delete''' function is used to delete the '''graphical response'''.

The '''object’s''' '''handle''' whose response is to be deleted, is passed as an '''argument'''.

Syntax: '''delete(<handle of an object>)'''
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting2dcurves.sce''' file.

|
Let us look at how to use a '''Slider''' to plot a circle with varying radii.

I have opened the '''plotting2dcurves.sce''' file using the '''GUIBuilder toolbox'''.

Now let us look at the '''objects''' that are taken on this graphic window.
|-
|
On '''Graphic Window Number 1''',

hover over the '''Text''' box.

|
We have a '''Text''' box with the '''Tag''' '''‘txt_radius'''’ and the '''String''' part is kept empty.

Hence, a default value '''UnName1''' is assigned to it as '''String.'''

The '''Text''' box will display the exact value of the radius that the '''Slider''' has selected.
|-
|
On '''Graphic Window Number 1''',

hover over '''Axes'''.

|
We also have an '''Axes''' with the '''Tag''' '''‘ax_radius’''' and the '''String''' as ‘'''Circle'''’.

This will display the '''response''' of the circle.
|-
|
| Now let us add a '''Slider''' to control the radius value.
|-
|
On '''GUIBuilder Palette,'''

click on the '''Slider'''.
|
On the '''GUIBuilder''' '''Palette''', click on the '''Slider'''.

The '''Scilab Multiple Values Request''' window appears.
|-
|
On '''Scilab Multiple Values Request''' Window,

type '''''sl_radius''''' in '''Tag''' field.

Type '''''Radius''''' in '''String''' field.

Click on '''OK.'''
|
Type '''''sl_radius''''' in the '''Tag''' field and '''''Radius''''' in the '''String''' field.

Close the window by clicking on the '''OK''' button.
|-
|
On '''Graphic Window Number 1''',

place the '''Slider''' above the '''Text''' box.
| Now place the '''Slider''' above the '''Text''' box.
|-
|
On '''Graphic Window Number 1''',

move the indicator on the '''Slider''' horizontally.
|
Then move the '''Slider''' indicator horizontally to vary the value.

However, we find that we are unable to move the indicator.

We must first enable the '''Slider''' to do so. Let us do that.
|-
|
On '''GUIBuilder Palette''' Window,

cursor on the right side panel.
|
Go to the '''GUIBuilder Palette''' and look at the right side panel.

It displays a list of '''Tag''' names for the objects on the '''Graphic''' window.
|-
|
On '''GUIBuilder Palette''' Window,

click on '''sl_radius'''.

Click on '''Object Properties'''.
|
Click on '''sl_radius.'''

Then click on the '''Object Properties''' button at the bottom right of the window.

The '''Scilab Multiple Values Request''' window will open.
|-
|
On the '''Scilab Multiple Values Request''' Window,

hover over '''Enable'''.

change '''Enable''' property to ‘'''on'''’.
|
Search for the object property '''Enable'''.

Change it from '''Off''' to '''On'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Max''' field.

Change the value from '''1 to 10'''.
|
We also have to change one more object property which is ''''Max''''.

This property will set the upper limit of the '''Slider.'''

Change it from '''1''' to '''10'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Min''' field.

Click on '''OK''' button.
|
Notice the object property ''''Min'''' which is lower limit of the '''Slider.'''

It is always set to '''0,''' by default.

Now, let us vary the value of the radius using the '''Slider''' from '''0 to 10'''.

Let us save the changes by clicking on the '''OK''' button at the bottom.
|-
|
On '''Graphic Window Number 1''',

hover cursor over the '''Graphic Window Number 1'''.
|
Now, I will generate the '''Scilab''' code for the same.

In the code file, we will write the code to connect the '''Slider''' and the '''Text''' box.

As a result, the '''Text''' box will display the exact value of the '''Slider'''.

We will also write a '''user-defined function''' to plot the circle.
|-
|
On the '''GUIBuilder Palette''' Window,

click on '''Generate,'''

Click on '''Generate GUI Code'''.
|
On the '''GUIBuilder Palette''' click on the '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-2d'''''.

Click on '''OK.'''

|
I will name this file as '''parametric-2d.'''

Click on the '''OK''' button to save it.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
A '''dialog''' box appears and displays the message “'''GUI created successfully!”'''

Click on '''OK.'''
|-
| Cursor on '''SciNotes''' Window.
| The corresponding '''Scilab''' code opens.
|-
|
On '''SciNotes''' Window,

highlight '''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight '''handles.ax_radius'''.
| '''handles.ax_radius''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight '''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

cursor on '''sl_radius_callback''' Function.
|
Now, let us write a function definition for '''sl_radius_callback''' function.

The function will basically link the '''Text''' box and the '''Slider'''.
|-
|
Cursor on '''SciNotes''' window,

within '''sl_radius_callback''' type,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Type the code as shown here with the same '''syntax'''.

The same code can be found in a file in the '''Code files''' section on this video page.

You can use it as explained earlier in this tutorial.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius.string = string(handles.sl_radius.value)'''
| This line will assign the value of the '''Slider''' to the '''Text''' box'''.'''
|-
|
On '''SciNotes''' Window,

highlight,

'''r = strtod(handles.txt_radius.string)'''
|
Next, we will assign the radius value from the '''Text''' box to a '''variable ‘r’.'''

Later on, we can use the '''variable ‘r'''’ while writing the equation of a circle.
|-
|
On '''SciNotes Window''',

cursor on new line outside the '''sl_radius_callback''' function, type,

'''''function plot_circle()'''''

'''''theta = 0:0.1:4*%pi'''''

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''

'''''plot(x,y)'''''

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Further, we will write a '''user defined function plot_circle()''' to plot the circle.

Type the code in the same way as before, with the same '''syntax'''.

This can also be found in the '''Code files''' section.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''theta = 0:0.1:4*%pi'''''
|
First, we have defined the range of '''theta'''.

It will vary from '''0 to 4𝝅''' with a step size of '''0.1.'''
|-
|
On the '''SciNotes Window,'''

highlight,

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''
| The next two lines define the '''parametric equation''' of the circle in terms of '''x''' and '''y'''.
|-
|
On the '''SciNotes Window,'''

highlight,

'''plot(x,y)'''
| The following line will plot the circle.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| The next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On '''SciNotes Window''',

Inside the '''sl_radius_callback Function''' type,

'''plot_circle()'''
|
Let us call the '''plot_circle()''' function inside the '''callback function'''.

At the end of the '''sl_radius_callback''' function definition, type '''plot_circle()'''

As a result, when we move the '''Slider''', the circle is plotted for each radius value.
|-
|
On the '''SciNotes Window''',

press '''Ctrl''' + '''S.'''
| Let us save the code by pressing '''Ctrl''' + '''S''' keys together on the keyboard.
|-
|
On '''SciNotes Window''',

click on '''Execute''' Button on '''menubar.'''

Click on '''File with echo.'''
|
We will now execute the code.

Click on the '''Execute''' button on the '''menu bar'''.

Then click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider'''.

hover over '''Text''' box.

move the '''Slider''' indicator on the right side'''.'''

move the '''Slider''' indicator on the left side'''.'''
|
Let us move the indicator given on the '''Slider.'''

We can see that as we move the indicator, a circle is being plotted.

Notice the '''Text''' box. The value of the radius is also getting changed along with it.

Moving the indicator towards the right increases the radius.

And moving the indicator towards the left decreases the radius.
|-
|
On '''Graphic Window Number 2''',

hover over '''Axes'''.

Close '''Graphic Window Number 2'''.
|
But, the earlier responses are still visible.

Let us delete them by adding a single line.

This line is to be written at the start of '''plot_circle() function''' definition'''.'''

Close the '''Graphic Window Number 2'''.
|-
|
On '''SciNotes Window''',

Type within '''''plot_circle()''''' function and then highlight,

'''''delete(handles.ax_radius.children)'''''
|
Type the line as shown here with the same syntax.

This line deletes all the '''children''' of the current '''Axes'''.

Here, '''children''' refers to the '''subplot''' of the '''Axes'''.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save the work by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On '''SciNotes Window''',

click on '''Execute,'''

Click on '''File with echo.'''
| Let us go back to the '''menu bar''' and click on '''Execute''' and then click on '''File with echo'''.
|-
|
On '''Graphic Window Number 2,'''

move the '''Slider''' indicator to the right and then on the left side'''.'''
|
Now move the '''Slider''' indicator to the right and then to the left.

The earlier responses are now deleted and no longer visible.

So, in this way we can build a '''GUI''' for plotting a '''2D parametric''' curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''Parametric''' equation of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Used a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Used the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Create a '''GUI''' to plot a '''Parabola''' using its '''parametric equations''', y = a*(t)^2, x = 2*a*t.</blockquote></li></ul>
<ul>
<li><blockquote>Change ''''a'''' from '''-1 to 1''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider, ''''t'''' varies from '''-10''' to '''10'''.</blockquote></li>
<li><blockquote>Add grid lines to the plot and label the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
<ul>
<li><blockquote>We conduct workshops using '''Spoken Tutorials''' and give certificates.</blockquote></li>
<li><blockquote>Please contact us.</blockquote></li></ul>
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
<ul>
<li><blockquote>Please post your timed queries in this forum.</blockquote></li></ul>
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-2D-parametric-curves-in-GUI/English

2021-09-20T03:03:37Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, delete, Scilab, Parametric equation, Circle, 2D, Text box, Axes, callback function, Tag, String'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting 2D parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn to:

<ul>
<li><blockquote>Plot the '''Parametric equation''' of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Use a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Use the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Circle?'''
|'''What is a Parametric Equation of a Circle?'''

The '''Parametric Equation''' of a circle is x = r*cos(Θ) and y = r*sin(Θ)'''.'''

Where,

<ul>
<li><blockquote>'''x''' & '''y''' are the coordinates for a given point on the circle and</blockquote></li>
<li><blockquote>'''r''' is the radius of the circle.</blockquote></li></ul>

We will use these two '''equations''' to plot the circle.
|-
|
Show Slide:

'''What is a Slider?'''
|'''What is a Slider?'''

'''Slider''' is an object that allows the user to dynamically change the value of a '''parameter'''.

It allows the user to move an indicator horizontally to set new values.

The user can also alter the values by clicking on any point on the '''Slider'''.
|-
|
Show Slide:

'''What is a delete function?'''
|'''What is a delete function?'''

The '''delete''' function is used to delete the '''graphical response'''.

The '''object’s''' '''handle''' whose response is to be deleted, is passed as an '''argument'''.

Syntax: '''delete(<handle of an object>)'''
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting2dcurves.sce''' file.

Video-editor: Please put a textbox on screen. “plotting2dcurves.sce”
|
Let us look at how to use a '''Slider''' to plot a circle with varying radii.

I have opened the '''plotting2dcurves.sce''' file using the '''GUIBuilder toolbox'''.

Now let us look at the '''objects''' that are taken on this graphic window.
|-
|
On '''Graphic Window Number 1''',

hover over the '''Text''' box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius”
|
We have a '''Text''' box with the '''Tag''' '''‘txt_radius'''’ and the '''String''' part is kept empty.

Hence, a default value '''UnName1''' is assigned to it as '''String.'''

The '''Text''' box will display the exact value of the radius that the '''Slider''' has selected.
|-
|
On '''Graphic Window Number 1''',

hover over '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_radius, String:Circle”
|
We also have an '''Axes''' with the '''Tag''' '''‘ax_radius’''' and the '''String''' as ‘'''Circle'''’.

This will display the '''response''' of the circle.
|-
|
| Now let us add a '''Slider''' to control the radius value.
|-
|
On '''GUIBuilder Palette,'''

click on the '''Slider'''.
|
On the '''GUIBuilder''' '''Palette''', click on the '''Slider'''.

The '''Scilab Multiple Values Request''' window appears.
|-
|
On '''Scilab Multiple Values Request''' Window,

type '''''sl_radius''''' in '''Tag''' field.

Type '''''Radius''''' in '''String''' field.

Click on '''OK.'''
|
Type '''''sl_radius''''' in the '''Tag''' field and '''''Radius''''' in the '''String''' field.

Close the window by clicking on the '''OK''' button.
|-
|
On '''Graphic Window Number 1''',

place the '''Slider''' above the '''Text''' box.
| Now place the '''Slider''' above the '''Text''' box.
|-
|
On '''Graphic Window Number 1''',

move the indicator on the '''Slider''' horizontally.
|
Then move the '''Slider''' indicator horizontally to vary the value.

However, we find that we are unable to move the indicator.

We must first enable the '''Slider''' to do so. Let us do that.
|-
|
On '''GUIBuilder Palette''' Window,

cursor on the right side panel.
|
Go to the '''GUIBuilder Palette''' and look at the right side panel.

It displays a list of '''Tag''' names for the objects on the '''Graphic''' window.
|-
|
On '''GUIBuilder Palette''' Window,

click on '''sl_radius'''.

Click on '''Object Properties'''.
|
Click on '''sl_radius.'''

Then click on the '''Object Properties''' button at the bottom right of the window.

The '''Scilab Multiple Values Request''' window will open.
|-
|
On the '''Scilab Multiple Values Request''' Window,

hover over '''Enable'''.

change '''Enable''' property to ‘'''on'''’.
|
Search for the object property '''Enable'''.

Change it from '''Off''' to '''On'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Max''' field.

Change the value from '''1 to 10'''.
|
We also have to change one more object property which is ''''Max''''.

This property will set the upper limit of the '''Slider.'''

Change it from '''1''' to '''10'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Min''' field.

Click on '''OK''' button.
|
Notice the object property ''''Min'''' which is lower limit of the '''Slider.'''

It is always set to '''0,''' by default.

Now, let us vary the value of the radius using the '''Slider''' from '''0 to 10'''.

Let us save the changes by clicking on the '''OK''' button at the bottom.
|-
|
On '''Graphic Window Number 1''',

hover cursor over the '''Graphic Window Number 1'''.
|
Now, I will generate the '''Scilab''' code for the same.

In the code file, we will write the code to connect the '''Slider''' and the '''Text''' box.

As a result, the '''Text''' box will display the exact value of the '''Slider'''.

We will also write a '''user-defined function''' to plot the circle.
|-
|
On the '''GUIBuilder Palette''' Window,

click on '''Generate,'''

Click on '''Generate GUI Code'''.
|
On the '''GUIBuilder Palette''' click on the '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-2d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as '''parametric-2d.'''

Click on the '''OK''' button to save it.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
A '''dialog''' box appears and displays the message “'''GUI created successfully!”'''

Click on '''OK.'''
|-
| Cursor on '''SciNotes''' Window.
| The corresponding '''Scilab''' code opens.
|-
|
On '''SciNotes''' Window,

highlight '''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight '''handles.ax_radius'''.
| '''handles.ax_radius''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight '''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

cursor on '''sl_radius_callback''' Function.
|
Now, let us write a function definition for '''sl_radius_callback''' function.

The function will basically link the '''Text''' box and the '''Slider'''.
|-
|
Cursor on '''SciNotes''' window,

within '''sl_radius_callback''' type,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Type the code as shown here with the same '''syntax'''.

The same code can be found in a file in the '''Code files''' section on this video page.

You can use it as explained earlier in this tutorial.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius.string = string(handles.sl_radius.value)'''
| This line will assign the value of the '''Slider''' to the '''Text''' box'''.'''
|-
|
On '''SciNotes''' Window,

highlight,

'''r = strtod(handles.txt_radius.string)'''
|
Next, we will assign the radius value from the '''Text''' box to a '''variable ‘r’.'''

Later on, we can use the '''variable ‘r'''’ while writing the equation of a circle.
|-
|
On '''SciNotes Window''',

cursor on new line outside the '''sl_radius_callback''' function, type,

'''''function plot_circle()'''''

'''''theta = 0:0.1:4*%pi'''''

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''

'''''plot(x,y)'''''

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Further, we will write a '''user defined function plot_circle()''' to plot the circle.

Type the code in the same way as before, with the same '''syntax'''.

This can also be found in the '''Code files''' section.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''theta = 0:0.1:4*%pi'''''
|
First, we have defined the range of '''theta'''.

It will vary from '''0 to 4𝝅''' with a step size of '''0.1.'''
|-
|
On the '''SciNotes Window,'''

highlight,

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''
| The next two lines define the '''parametric equation''' of the circle in terms of '''x''' and '''y'''.
|-
|
On the '''SciNotes Window,'''

highlight,

'''plot(x,y)'''
| The following line will plot the circle.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| The next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On '''SciNotes Window''',

Inside the '''sl_radius_callback Function''' type,

'''plot_circle()'''
|
Let us call the '''plot_circle()''' function inside the '''callback function'''.

At the end of the '''sl_radius_callback''' function definition, type '''plot_circle()'''

As a result, when we move the '''Slider''', the circle is plotted for each radius value.
|-
|
On the '''SciNotes Window''',

press '''Ctrl''' + '''S.'''
| Let us save the code by pressing '''Ctrl''' + '''S''' keys together on the keyboard.
|-
|
On '''SciNotes Window''',

click on '''Execute''' Button on '''menubar.'''

Click on '''File with echo.'''
|
We will now execute the code.

Click on the '''Execute''' button on the '''menu bar'''.

Then click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider'''.

hover over '''Text''' box.

move the '''Slider''' indicator on the right side'''.'''

move the '''Slider''' indicator on the left side'''.'''
|
Let us move the indicator given on the '''Slider.'''

We can see that as we move the indicator, a circle is being plotted.

Notice the '''Text''' box. The value of the radius is also getting changed along with it.

Moving the indicator towards the right increases the radius.

And moving the indicator towards the left decreases the radius.
|-
|
On '''Graphic Window Number 2''',

hover over '''Axes'''.

Close '''Graphic Window Number 2'''.
|
But, the earlier responses are still visible.

Let us delete them by adding a single line.

This line is to be written at the start of '''plot_circle() function''' definition'''.'''

Close the '''Graphic Window Number 2'''.
|-
|
On '''SciNotes Window''',

Type within '''''plot_circle()''''' function and then highlight,

'''''delete(handles.ax_radius.children)'''''
|
Type the line as shown here with the same syntax.

This line deletes all the '''children''' of the current '''Axes'''.

Here, '''children''' refers to the '''subplot''' of the '''Axes'''.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save the work by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On '''SciNotes Window''',

click on '''Execute,'''

Click on '''File with echo.'''
| Let us go back to the '''menu bar''' and click on '''Execute''' and then click on '''File with echo'''.
|-
|
On '''Graphic Window Number 2,'''

move the '''Slider''' indicator to the right and then on the left side'''.'''
|
Now move the '''Slider''' indicator to the right and then to the left.

The earlier responses are now deleted and no longer visible.

So, in this way we can build a '''GUI''' for plotting a '''2D parametric''' curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''Parametric''' equation of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Used a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Used the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Create a '''GUI''' to plot a '''Parabola''' using its '''parametric equations''', y = a*(t)^2, x = 2*a*t.</blockquote></li></ul>
<ul>
<li><blockquote>Change ''''a'''' from '''-1 to 1''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider, ''''t'''' varies from '''-10''' to '''10'''.</blockquote></li>
<li><blockquote>Add grid lines to the plot and label the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
<ul>
<li><blockquote>We conduct workshops using '''Spoken Tutorials''' and give certificates.</blockquote></li>
<li><blockquote>Please contact us.</blockquote></li></ul>
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
<ul>
<li><blockquote>Please post your timed queries in this forum.</blockquote></li></ul>
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Loading-and-saving-data-in-Xcos/English

2021-09-08T06:42:52Z

Utkarsha:

'''Title of script''': Loading and saving data in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos,TOWS_c, C_binary, workspace, read, write, data file, scilab'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “ '''Loading and saving data in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Save '''Xcos''' simulation data values to the '''workspace'''.</blockquote></li>
<li><blockquote>Read and write data in '''Xcos''' simulation using a '''C binary''' file</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Ubuntu 18.04 OS''' and</blockquote></li>
<li><blockquote>'''Scilab 6.1.0 version'''</blockquote></li></ul>
|-
|
Show Slide:

'''Pre-requisites'''
|
To follow this tutorial, you should have

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li>
<li><blockquote>If not, for relevant tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
| Cursor on the '''Untitled Xcos editing''' window.
|
I have already opened the '''Xcos''' windows.

We can see two windows named '''Untitled Xcos''' and the '''Palette browser''' are opened'''.'''
|-
|
On the '''Untitled Xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''SaveData.xcos''' >> Click on '''OK.'''
|
Go to the '''Untitled Xcos''' window.

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to the '''Downloads''' folder and select the file '''SaveData.xcos'''.

Then click on the '''OK''' button.
|-
| Adjust the Window accordingly.
|
Let me adjust the window.

I have already created this file for demonstration.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos''' window.
| This file has a simple '''Xcos''' simulation diagram.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''RAMP''' block.
| It uses the '''RAMP''' block to generate a '''Ramp''' signal.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''CSCOPE''' block.
|
And the '''CSCOPE''' block to plot it.

Let us see how to record the generated Ramp signal.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos window'''
| First we will see how to push the values generated by the '''RAMP''' block to '''workspace.'''
|-
|
On '''palette browser''',

click on '''Sinks''' >> scroll down >> click on '''TOWS_c.'''
|
Go to the '''palette browser''' window.

Click on the '''Sinks''' palette.

In the right panel, select the '''TOWS_c''' block. This is the '''To Workspace''' block.
|-
| As per narration
| '''Drag and Drop''' the '''TOWS_c''' block to the '''SaveData.xcos''' window'''.'''
|-
|
On the '''editing''' window,

Double click on the '''TOWS_c''' block.
| Double click on the '''TOWS_c''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Size of Buffer.''' Text field to highlight it.
|
The size of buffer is by default set to '''128.'''

This means that 128 values will be saved in the block .

If any more values are passed, the block will overwrite the previous values.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Variable Name''' text field to highlight it.
|
The '''Variable Name''' is the name of the variable to which the values are saved.

By default it is set to '''A.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Inherit''' Text field to highlight it.

Click on the '''OK''' button at the bottom.
|
'''Inherit''' is used to decide whether to take the event input or not.

By default Inherit is set to '''0''' which means it has to take event input.

Click on the '''OK''' button to close this window.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''TOWS_c''' block.

Connect it to the line joining the '''RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''TOWS_c''' block.

Connect it to the line joining the '''CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the '''Warning message.'''
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.

An '''Warning message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

Close the '''Graphic''' window.
|
We can see a straight line with slope 2.

Let’s close the graphic window.
|-
| Switch to '''workspace.'''
|
Now let us look at the values.

Switch to the '''workspace'''.
|-
|
On the '''workspace''',

Type '''''A''''' >> press '''Enter.'''
|
Let us execute the variable '''A'''.

Type '''A''' on the '''workspace''' and press '''Enter'''.
|-
|
On the '''workspace''' window,

Highlight '''variable A.'''

Highlight '''values.'''

Highlight '''time.'''
|
'''A''' is a special variable.

We can either extract '''values''' from '''A''' or we can extract '''times''' from '''A.'''

Let us look at the values.
|-
|
On the '''workspace''' window,

Type '''''A.values''''' >> Press '''Enter.'''
|
Type '''A.values''' on the '''workspace'''.

Press '''Enter.'''
|-
|
On the '''workspace''',

Scroll up to show all the values and Highlight them.
| These are all the values from the graph and are now saved in the workspace.
|-
|
On the '''workspace''',

hover cursor on a new line on the workspace.
| Now we need to save these values in a file so that we can share them.
|-
| Switch to '''SaveData.xcos''' window.
| Switch back to the '''SaveData.xcos''' window.
|-
|
On the '''palette browser''',

Click on '''Sinkss''' >> Click on '''WRITEC_f''' block.
|
To save these values, we will use the '''WRITEC_f''' block.

Go to the '''palette browser''' window.

Click on the '''Sinks''' palette.

Click on the '''WRITEC_f''' block in the right panel.

This is the '''Write to C binary file''' block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''SaveData.xcos''' window.
|-
|
On the '''SaveData.xcos''' window,

Double click on '''WRITEC_f''' block.
| Double click on the '''WRITEC_f''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Input Size''' Text field to highlight it.
| '''Input Size''' is the size of our input values.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Output File Name''' Text field to highlight it >> Change it to '''''‘data’'''''
|
'''Output File''' is the name of our output file.

I will name the output file as '''‘ data ‘'''.

If no file path is entered, the file will be saved in the '''Current working directory.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Output Format''' Text field to highlight it >> Change it to ‘ '''d''' ’
|
'''Output Format''' is the format of the output file.

By default it is '''‘ c ‘.''' That is, by default, values are saved as integers.

But, I want to save the values as '''double.''' So''',''' I will change it to '''‘d’.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.
| '''Buffer Size''' is the size of the buffer.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''WRITEC_f''' block.

Connect it to the line joining the '''RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''WRITEC_f''' block.

Connect it to the line joining the '''CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning message.
|
Let's run the simulation again by clicking on the '''Start''' Button on the '''toolbar.'''

A '''Warning message''' will appear. Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

'''Close''' the Graphic window.
|
We can see the graph.

Let’s close the graphic window.
|-
| As per narration.
| Let's go to the location where we have saved the data file.
|-
|
On '''file manager window''',

Click on the '''data''' file once.
|
We can see a file named '''‘ data ‘''' .

Since it is a binary encoded file we cannot simply read it.

We would need a special block to read this file.
|-
| Switch back to '''SaveData.xcos''' file
| Switch back to the '''SaveData.xcos''' window.
|-
|
On the '''SaveData.xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''LoadData.xcos''' >> Click on '''OK'''
|
Let us open the file '''LoadData.xcos'''

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to '''Downloads''' Folder and select the file '''LoadData.xcos'''.

Then click on the '''OK''' button.

We will use this file to read our data file.
|-
| Adjust the Window accordingly.
| Let me adjust the window.
|-
|
On the '''palette browser,'''

Click on '''Sources''' >> Click on '''READC_f''' block.
|
We will use the '''READC_f''' block to read our values.

Go to the '''palette browser''' window.

Click on the '''Sources''' palette.

Click on '''READC_f''' Block in the right panel.

This is the '''Read from C Binary''' block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''LoadData.xcos''' window.
|-
|
On the '''LoadData.xcos''' window,

Double click on '''READC_f''' block..
| Double click on the '''READC_f''' block to configure its properties'''.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input File Name''' Text field to highlight it. >> Change it to '''''data'''''
|
'''Input file''' name is the name and the path of your data file.

Since my data file was named '''data''' I will change it to '''data'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input Format''' Text field to highlight it >> Change it to '''''d.'''''
|
'''Input format''' is the format of the data file.

Since the format for my data file is '''double''' , I will change it to '''d'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.

Click the '''OK''' button .
|
This is the buffer size.

Let’s close this window by clicking on the '''OK''' button.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black output port''' of the '''READC_f''' block.

Connect it to the '''black input port''' of the '''CSCOPE''' block.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''READC_f''' block.

Connect it to the line joining the '''CLOCK_C''' & the '''CSCOPE''' block.
|-
|
On the '''LoadData.xcos''' window,

Click on '''Start''' button on the '''toolbar'''
| Let’s run this simulation again by clicking on the '''Start''' Button on the '''toolbar'''.
|-
|
On the '''Graphic''' Window,

Hover Cursor on the '''Graph.'''
|
We have a similar graph to the one we had earlier without using the '''RAMP''' block.

This is because we have loaded the values from the data file.
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Save '''Xcos''' simulation data values to the '''workspace'''.</blockquote></li>
<li><blockquote>Read and write data in '''Xcos''' Simulation using a '''C binary''' file</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment,

Create two '''Xcos''' simulation files:

<ul>
<li><blockquote>Use the first for plotting a straight line with slope 3.</blockquote></li>
<li><blockquote>Push the values to the workspace and save them as a binary encoded file.</blockquote></li>
<li><blockquote>Create another '''Xcos''' simulation to plot a new graph of a straight line with slope 3.</blockquote></li>
<li><blockquote>Use only the saved data values.</blockquote></li></ul>
|-
| Show Slide: '''About Spoken Tutorial project'''
|
The video at the following link summarises the Spoken Tutorial project.

Please download and watch it
|-
| Show Slide: '''Spoken Tutorial Workshops'''
|
The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
|
Please post your general and technical queries on '''Scilab''' in this forum.

|-
|
Show Slide:

'''Textbook Companion project.'''
|
The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this website.
|-
| Show Slide: '''Lab Migration'''
|
The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this website.
|-
| Show Slide: '''Acknowledgement'''
| Spoken Tutorial and FOSSEE projects are funded by the Ministry of Education, Government of India.
|-
| Show Slide: '''Thank you'''
|
This is Utkarsh Anand, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-09-04T16:18:51Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D parametric curves'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>To plot the '''parametric''' equation of a sphere using '''GUI.'''</blockquote></li>
<li><blockquote>Use of '''surf command'''.</blockquote></li>
<li><blockquote>Use of '''mesh command''' and;</blockquote></li>
<li><blockquote>Use of '''meshgrid command'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and;</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|
The '''parametric equation''' of a sphere is:

<math display="inline">x\ = \ r\ cos\theta\ sin\varphi\ ,\ y\ = \ r\ \ sin\theta\ sin\varphi\ </math>

'''&''' <math display="inline">z\ = r\ cos\varphi</math>'''.'''

Where''','''

<ul>
<li><blockquote>'''x''', '''y, z''' are the '''cartesian coordinates''' of a given point on the sphere.</blockquote></li>
<li><blockquote>'''r''' is the radius of the sphere and;</blockquote></li>
<li><blockquote>'''theta''' & '''phi''' are the '''spherical coordinates'''. They lie in the range '''0''' to '''2𝞹'''.</blockquote></li></ul>

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf''' and '''mesh''' commands in this tutorial.

These '''commands''' are used to create a '''3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|
The '''surf command''' draws a '''3D parametric''' surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf command''' will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|
The '''mesh command''' also draws a '''3D parametric''' surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh command''' will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf commands''' type the following on the '''Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

Video-editor: Please put a textbox on screen. “plotting3dcurves.sce”
|
Locate the '''plotting3dcurves.sce''' file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text''' box and an '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: sl_radius, String: Radius”
|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text''' box and an '''Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’''' and '''String ‘Radius’.'''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius, String: Radius”
|
Next, we have a '''Text''' box to display the radius.

It has '''Tag ‘txt_radius’''' and the '''String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_plot, String: Sphere”
|
Lastly, we have the '''Axes''' to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to the '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as '''parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
It shows a new dialog box that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback''' function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback function''' definition.

It has two lines of code in it.

The code essentially connects the '''Slider''' to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf(x, y, z);'''''

'''''//mesh(x, y, z);'''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a '''user-defined function plot_sphere()''' to plot the sphere.

Type the code as shown here with the same '''syntax'''.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete function''' to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi;'''''

'''''[phi, theta]= meshgrid(u,v);'''''
|
Notice the next three lines.

The '''meshgrid command''' is used.

It is used to generate '''u''' and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and '''theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric equation in terms of '''x, y''' and '''z'''.
|-
|
| Next, we will plot a '''3D parametric''' curve of a sphere.
|-
|
highlight,

'''''surf(x, y, z);'''''
| Firstly, we’ll see the output of the '''surf command'''.
|-
|
highlight,

'''''//mesh(x, y, z);'''''
|
Then next we will see the '''mesh command'''.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback''' function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere() function''' inside the '''callback function'''.

At the end of '''sl_radius_callback function''' definition type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save our code by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the '''indicator''' on the '''Slider,''' a sphere is being plotted.

The '''surf command''' now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh command'''.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf(x, y, z);'''''

'''''mesh(x, y, z);'''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf''' command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh''' command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
| Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh''' command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh''' command now plots a '''3D''' sphere with a white surface.
|-
|
| So this way we can build a '''GUI''' for plotting a '''3D''' parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''parametric''' equation of a sphere using '''GUI'''.</blockquote></li>
<li><blockquote>Used the '''surf command'''.</blockquote></li>
<li><blockquote>Used the '''mesh command''' and;</blockquote></li>
<li><blockquote>Used the '''meshgrid command'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Using '''surf''' and '''mesh''', build a '''GUI''' to plot a '''3D''' hemisphere.</blockquote></li></ul>

<blockquote>'''Parametric''' equations:<math display="inline">x\ = \ r\ cos\theta\ sin\varphi\ ,\ y\ = \ r\ \ sin\theta\ sin\varphi\ </math>

'''&''' <math display="inline">z\ = r\ cos\varphi</math>'''.'''
</blockquote>
<ul>
<li><blockquote>Place the hemisphere on a horizontal plane.</blockquote></li></ul>

<ul>
<li><blockquote>Change radius ‘'''r'''’ from '''1''' to '''10''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider that '''theta''' & '''phi''' vary from '''0''' to '''𝞹.'''</blockquote></li>
<li><blockquote>Add '''grid lines''' to the plot and '''label''' the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-2D-parametric-curves-in-GUI/English

2021-09-04T16:12:19Z

Utkarsha:

'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, delete, Scilab, Parametric equation, Circle, 2D, Text box, Axes, callback function, Tag, String'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting 2D parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn to:

<ul>
<li><blockquote>Plot the '''Parametric equation''' of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Use a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Use the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Ubuntu 18.04 OS'''</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0''' and</blockquote></li>
<li><blockquote>'''GUI Builder Toolbox 4.2.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Windows OS''' also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
To follow this tutorial:

<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab''' and '''GUI Builder toolbox.'''</blockquote></li>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a Parametric Equation of a Circle?'''
|
The '''Parametric Equation''' of a circle is <math display="inline">x\ = \ r\ cos\theta\ \ \text{and\ }y\ = \ r\ \ sin\theta</math>'''.'''

Where,

<ul>
<li><blockquote>'''x''' & '''y''' are the coordinates for a given point on the circle and</blockquote></li>
<li><blockquote>'''r''' is the radius of the circle.</blockquote></li></ul>

We will use these two '''equations''' to plot the circle.
|-
|
Show Slide:

'''What is a Slider?'''
|
'''Slider''' is an object that allows the user to dynamically change the value of a '''parameter'''.

It allows the user to move an indicator horizontally to set new values.

The user can also alter the values by clicking on any point on the '''Slider'''.
|-
|
Show Slide:

'''What is a delete function?'''
|
The '''delete''' function is used to delete the '''graphical response'''.

The '''object’s''' '''handle''' whose response is to be deleted, is passed as an '''argument'''.

Syntax: '''delete(<handle of an object>)'''
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting2dcurves.sce''' file.

Video-editor: Please put a textbox on screen. “plotting2dcurves.sce”
|
Let us look at how to use a '''Slider''' to plot a circle with varying radii.

I have opened the '''plotting2dcurves.sce''' file using the '''GUIBuilder toolbox'''.

Now let us look at the '''objects''' that are taken on this graphic window.
|-
|
On '''Graphic Window Number 1''',

hover over the '''Text''' box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius”
|
We have a '''Text''' box with the '''Tag''' '''‘txt_radius'''’ and the '''String''' part is kept empty.

Hence, a default value '''UnName1''' is assigned to it as '''String.'''

The '''Text''' box will display the exact value of the radius that the '''Slider''' has selected.
|-
|
On '''Graphic Window Number 1''',

hover over '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_radius, String:Circle”
|
We also have an '''Axes''' with the '''Tag''' '''‘ax_radius’''' and the '''String''' as ‘'''Circle'''’.

This will display the '''response''' of the circle.
|-
|
| Now let us add a '''Slider''' to control the radius value.
|-
|
On '''GUIBuilder Palette,'''

click on the '''Slider'''.
|
On the '''GUIBuilder''' '''Palette''', click on the '''Slider'''.

The '''Scilab Multiple Values Request''' window appears.
|-
|
On '''Scilab Multiple Values Request''' Window,

type '''''sl_radius''''' in '''Tag''' field.

Type '''''Radius''''' in '''String''' field.

Click on '''OK.'''
|
Type '''''sl_radius''''' in the '''Tag''' field and '''''Radius''''' in the '''String''' field.

Close the window by clicking on the '''OK''' button.
|-
|
On '''Graphic Window Number 1''',

place the '''Slider''' above the '''Text''' box.
| Now place the '''Slider''' above the '''Text''' box.
|-
|
On '''Graphic Window Number 1''',

move the indicator on the '''Slider''' horizontally.
|
Then move the '''Slider''' indicator horizontally to vary the value.

However, we find that we are unable to move the indicator.

We must first enable the '''Slider''' to do so. Let us do that.
|-
|
On '''GUIBuilder Palette''' Window,

cursor on the right side panel.
|
Go to the '''GUIBuilder Palette''' and look at the right side panel.

It displays a list of '''Tag''' names for the objects on the '''Graphic''' window.
|-
|
On '''GUIBuilder Palette''' Window,

click on '''sl_radius'''.

Click on '''Object Properties'''.
|
Click on '''sl_radius.'''

Then click on the '''Object Properties''' button at the bottom right of the window.

The '''Scilab Multiple Values Request''' window will open.
|-
|
On the '''Scilab Multiple Values Request''' Window,

hover over '''Enable'''.

change '''Enable''' property to ‘'''on'''’.
|
Search for the object property '''Enable'''.

Change it from '''Off''' to '''On'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Max''' field.

Change the value from '''1 to 10'''.
|
We also have to change one more object property which is ''''Max''''.

This property will set the upper limit of the '''Slider.'''

Change it from '''1''' to '''10'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Min''' field.

Click on '''OK''' button.
|
Notice the object property ''''Min'''' which is lower limit of the '''Slider.'''

It is always set to '''0,''' by default.

Now, let us vary the value of the radius using the '''Slider''' from '''0 to 10'''.

Let us save the changes by clicking on the '''OK''' button at the bottom.
|-
|
On '''Graphic Window Number 1''',

hover cursor over the '''Graphic Window Number 1'''.
|
Now, I will generate the '''Scilab''' code for the same.

In the code file, we will write the code to connect the '''Slider''' and the '''Text''' box.

As a result, the '''Text''' box will display the exact value of the '''Slider'''.

We will also write a '''user-defined function''' to plot the circle.
|-
|
On the '''GUIBuilder Palette''' Window,

click on '''Generate,'''

Click on '''Generate GUI Code'''.
|
On the '''GUIBuilder Palette''' click on the '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-2d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as '''parametric-2d.'''

Click on the '''OK''' button to save it.
|-
|
Cursor on '''GUI Created''' Window,

click on '''OK.'''
|
A '''dialog''' box appears and displays the message “'''GUI created successfully!”'''

Click on '''OK.'''
|-
| Cursor on '''SciNotes''' Window.
| The corresponding '''Scilab''' code opens.
|-
|
On '''SciNotes''' Window,

highlight '''handles.txt_radius'''.
| '''handles.txt_radius''' is the '''handle''' for the '''Text''' box.
|-
|
On '''SciNotes''' Window,

highlight '''handles.ax_radius'''.
| '''handles.ax_radius''' is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight '''handles.sl_radius'''.
| '''handles.sl_radius''' is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

cursor on '''sl_radius_callback''' Function.
|
Now, let us write a function definition for '''sl_radius_callback''' function.

The function will basically link the '''Text''' box and the '''Slider'''.
|-
|
Cursor on '''SciNotes''' window,

within '''sl_radius_callback''' type,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Type the code as shown here with the same '''syntax'''.

The same code can be found in a file in the '''Code files''' section on this video page.

You can use it as explained earlier in this tutorial.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius.string = string(handles.sl_radius.value)'''
| This line will assign the value of the '''Slider''' to the '''Text''' box'''.'''
|-
|
On '''SciNotes''' Window,

highlight,

'''r = strtod(handles.txt_radius.string)'''
|
Next, we will assign the radius value from the '''Text''' box to a '''variable ‘r’.'''

Later on, we can use the '''variable ‘r'''’ while writing the equation of a circle.
|-
|
On '''SciNotes Window''',

cursor on new line outside the '''sl_radius_callback''' function, type,

'''''function plot_circle()'''''

'''''theta = 0:0.1:4*%pi'''''

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''

'''''plot(x,y)'''''

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Further, we will write a '''user defined function plot_circle()''' to plot the circle.

Type the code in the same way as before, with the same '''syntax'''.

This can also be found in the '''Code files''' section.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''theta = 0:0.1:4*%pi'''''
|
First, we have defined the range of '''theta'''.

It will vary from '''0 to 4𝝅''' with a step size of '''0.1.'''
|-
|
On the '''SciNotes Window,'''

highlight,

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''
| The next two lines define the '''parametric equation''' of the circle in terms of '''x''' and '''y'''.
|-
|
On the '''SciNotes Window,'''

highlight,

'''plot(x,y)'''
| The following line will plot the circle.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| The next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On '''SciNotes Window''',

Inside the '''sl_radius_callback Function''' type,

'''plot_circle()'''
|
Let us call the '''plot_circle()''' function inside the '''callback function'''.

At the end of the '''sl_radius_callback''' function definition, type '''plot_circle()'''

As a result, when we move the '''Slider''', the circle is plotted for each radius value.
|-
|
On the '''SciNotes Window''',

press '''Ctrl''' + '''S.'''
| Let us save the code by pressing '''Ctrl''' + '''S''' keys together on the keyboard.
|-
|
On '''SciNotes Window''',

click on '''Execute''' Button on '''menubar.'''

Click on '''File with echo.'''
|
We will now execute the code.

Click on the '''Execute''' button on the '''menu bar'''.

Then click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider'''.

hover over '''Text''' box.

move the '''Slider''' indicator on the right side'''.'''

move the '''Slider''' indicator on the left side'''.'''
|
Let us move the indicator given on the '''Slider.'''

We can see that as we move the indicator, a circle is being plotted.

Notice the '''Text''' box. The value of the radius is also getting changed along with it.

Moving the indicator towards the right increases the radius.

And moving the indicator towards the left decreases the radius.
|-
|
On '''Graphic Window Number 2''',

hover over '''Axes'''.

Close '''Graphic Window Number 2'''.
|
But, the earlier responses are still visible.

Let us delete them by adding a single line.

This line is to be written at the start of '''plot_circle() function''' definition'''.'''

Close the '''Graphic Window Number 2'''.
|-
|
On '''SciNotes Window''',

Type within '''''plot_circle()''''' function and then highlight,

'''''delete(handles.ax_radius.children)'''''
|
Type the line as shown here with the same syntax.

This line deletes all the '''children''' of the current '''Axes'''.

Here, '''children''' refers to the '''subplot''' of the '''Axes'''.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl''' + '''S''' on the keyboard.
| Let us save the work by pressing '''Ctrl''' + '''S''' keys together.
|-
|
On '''SciNotes Window''',

click on '''Execute,'''

Click on '''File with echo.'''
| Let us go back to the '''menu bar''' and click on '''Execute''' and then click on '''File with echo'''.
|-
|
On '''Graphic Window Number 2,'''

move the '''Slider''' indicator to the right and then on the left side'''.'''
|
Now move the '''Slider''' indicator to the right and then to the left.

The earlier responses are now deleted and no longer visible.

So, in this way we can build a '''GUI''' for plotting a '''2D parametric''' curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this tutorial, we have:

<ul>
<li><blockquote>Plotted the '''Parametric''' equation of a circle using '''GUI'''.</blockquote></li>
<li><blockquote>Used a '''Slider''' to vary the radius of a circle and</blockquote></li>
<li><blockquote>Used the '''delete function'''.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<ul>
<li><blockquote>Create a '''GUI''' to plot a '''Parabola''' using its '''parametric equations'''.</blockquote></li></ul>

<blockquote><math display="inline">y = at^{2}</math>,<math display="inline">x = 2at</math>
</blockquote>
<ul>
<li><blockquote>Change ''''a'''' from '''-1 to 1''' using a '''Slider''' and display it in a '''Text''' box.</blockquote></li>
<li><blockquote>Consider, ''''t'''' varies from '''-10''' to '''10'''.</blockquote></li>
<li><blockquote>Add grid lines to the plot and label the '''Axes'''.</blockquote></li></ul>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
<ul>
<li><blockquote>We conduct workshops using '''Spoken Tutorials''' and give certificates.</blockquote></li>
<li><blockquote>Please contact us.</blockquote></li></ul>
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
<ul>
<li><blockquote>Please post your timed queries in this forum.</blockquote></li></ul>
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
| Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Conditional-operations-in-Xcos/English

2021-09-04T15:55:52Z

Utkarsha:

'''tTitle of script''': Conditional operations in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos, conditional operation, scilab, if-else, loops'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “'''Conditional Operations in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Use the '''If then Else''' conditional operator in '''Xcos'''.</blockquote></li>
<li><blockquote>Display the output of the conditional operations.</blockquote></li>
<li><blockquote>Halt the simulation after a condition is reached.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Ubuntu 18.04 OS''' and</blockquote></li>
<li><blockquote>'''Scilab 6.1.0'''</blockquote></li></ul>
|-
|
Show Slide:

'''Pre-requisites'''
|
To follow this tutorial, you should have :

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li></ul>

If not, then go through the '''Scilab''' spoken tutorials on this website.
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
| Cursor on the '''Untitled Xcos''' window.
|
I have already opened the '''Xcos''' window.

We can see two windows named '''Untitled Xcos''' and the '''Palette browser.'''
|-
|
On the '''Untitled Xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''ConditionalOperations.xcos''' >> Click on '''OK.'''
|
Go to the '''Untitled Xcos''' window.

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to the '''Downloads''' folder and select the file '''ConditionalOperations.xcos.'''

Then click on the '''OK''' button.

I have already created this file for demonstration.
|-
| cursor on the '''ConditionalOperations.xcos''' window.
| This file has a simple '''Xcos''' simulation diagram.
|-
| Cursor on '''ConditionalOperations.xcos window'''
|
Let us add conditional expressions to this file.

To add conditional expressions we will use the '''Expression''' block.
|-
|
On '''palette browser''',

click on '''user-defined-functions''' >> click on '''Expression.'''
|
Go to the '''palette browser''' window.

Click on the '''User-Defined-Functions''' section.

In the right panel, select the '''Expression''' block.
|-
| Drag the '''Expressio'''n block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''Expression''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On '''ConditionalOperations.xcos window''',

Double click on the '''Expression''' block.
| Double click on the '''Expression block''' to configure its properties.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on '''Number of Input''' textbox to highlight it >> Change it to '''1'''.
|
First is the '''number of inputs'''.

By default it is '''2''' which means it can receive 2 input values.

Let us change it to '''1'''.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on '''scilab expression''' textbox to highlight it >> type '''(u1>10)*1''' '''.'''
|
Next, is the '''conditional expression'''.

This is the expression which will be evaluated by the '''Expression''' block.

In '''Xcos,''' by default variables like '''u1, u2''' are used while writing the conditional expressions.

Let us change the default expression.

Enter the expression as shown here.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on the scilab '''expression''' textbox to highlight it.
| This means that, if '''''u1 > 10''''' then the block should return '''1'''.
|-
|
On '''Scilab Multiple Request''' Window,

Click on the '''OK''' button.
| Click on the '''OK''' button.
|-
| Cursor on '''ConditionalOperations.xcos window'''
|
Let us display the output of the '''Expression''' block.

To do this, we will use the '''AFFICH_m''' block.
|-
|
On '''palette browser''',

click on '''sinks''' >> click on '''AFFICH_m.'''
|
Go to the '''palette browser''' window.

Click on the '''Sinks''' palette.

In the right panel, select the '''AFFICH_m''' block.
|-
| Drag the '''AFFICH_m''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''AFFICH_m''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''EXPRESSION''' block.

Connect it to the line joining the '''RAMP''' and the '''CSCOPE''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''black output port''' of the '''EXPRESSION''' block.

Connect it to the '''black input port''' of the '''AFFICH_m''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''AFFICH_m''' block.

Connect it to the line joining the '''CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''menu bar,'''

Click on '''Simulation''' >> Click on '''Setup.'''
|
Before that, we need to change the execution time to Real time.

On the '''menu bar''', click on '''Simulation.'''

Click on '''Setup.'''
|-
|
On '''Set parameters''' window''','''

Change '''Real Time Scaling''' to 1 >> Click on '''OK''' button.
|
Change '''Real Time Scaling''' to '''1'''.

Click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning Message.
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.

A '''Warning Message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos''' window,

Cursor on '''AFFICH_m''' block.
|
We can see that the '''AFFICH_m''' block displays '''0''' as long as the graph is less than '''10''' .

After the graph exceeds '''10''' the '''AFFICH_m''' block displays '''1'''.
|-
| Cursor on the '''Graphic Window.'''
|
Suppose we want our simulation to end after some condition has been achieved.

To do this, we will use the '''IFTHEL_f''' block. This is the '''IF-ELSE''' block.
|-
| Close the '''Graphic Window.'''
| Let’s close the '''Graphic window.'''
|-
|
On '''palette browser''',

click on '''Event-Handling''' >> click on '''IFTHEL_f.'''
|
Go to the '''palette browser''' window.

Click on the '''Event Handling''' section.

In the right panel, select the '''IFTHEL_f''' block.
|-
| Drag the '''IFTHEL_f''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''IFTHEL_f''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On the '''ConditionalOperations.xcos''' window,

Cursor on '''IFTHEL_m''' block.
| Now, to halt the simulation we would need the '''HALT_f''' block.
|-
|
On '''palette browser''',

click on '''Event-Handling''' >> click on '''HALT_f.'''
|
Go to the '''palette browser''' window.

Click on the '''Event Handling''' section.

In the right panel, select the '''HALT_f''' block.
|-
| Drag the '''HALT_f''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''HALT_f''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On the '''ConditionalOperations.xcos''' window,

Cursor on '''HALT_f''' block.
| The '''HALT_f''' block will end the simulation when the condition in the '''IFTHEL_f''' block is satisfied.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''IFTHEL_f''' block.

Connect it to the line joining the '''EXPRESSION''' and the '''AFFICH_m''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Next, Select any of the '''red output ports''' of the '''IFTHEL_f''' block.

Connect it to the '''red input port''' of the '''HALT_f''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''IFTHEL_f''' block.

Connect it to the line entering the '''red input port''' of the '''AFFICH_m''' block'''.'''
|-
|
On the '''ConditionalOperations.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning Message.
|
Let us run this simulation again by clicking on the '''Start''' Button on the '''toolbar'''.

A '''Warning Message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos''' window,

Cursor on '''AFFICH_m''' block.
|
Observe that as soon as the value in the '''AFFICH_m''' block becomes '''1''', the simulation stops.

So this way we can use conditional operations in '''Xcos'''.
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Use the '''If then Else''' conditional operator in '''Xcos'''.</blockquote></li>
<li><blockquote>Display the output of the conditional operations.</blockquote></li>
<li><blockquote>Halt the simulation after a condition is reached.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment

Create a '''Xcos''' Simulation file to:

<ul>
<li><blockquote>Plot a straight line with slope 5.</blockquote></li>
<li><blockquote>Apply a conditional operator which will output 1 if the value is divisible by 9.</blockquote></li>
<li><blockquote>Halt the simulation when the condition evaluates to True.</blockquote></li></ul>
|-
| Show Slide: '''About Spoken Tutorial project'''
|
The video at the following link summarises the Spoken Tutorial project.

Please download and watch it
|-
| Show Slide: '''Spoken Tutorial Workshops'''
|
The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project.'''
|
The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this website.
|-
| Show Slide: '''Lab Migration'''
|
The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this website.
|-
| Show Slide: '''Acknowledgement'''
| Spoken Tutorial and FOSSEE projects are funded by the Ministry of Education, Government of India.
|-
| Show Slide: '''Thank you'''
|
This is Utkarsh, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Loading-and-saving-data-in-Xcos/English

2021-09-04T15:47:29Z

Utkarsha:

'''Title of script''': Loading and saving data in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos,TOWS_c, C_binary, workspace, read, write, data file, scilab'''

{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “ '''Loading and saving data in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Save '''Xcos''' simulation data values to the '''workspace'''.</blockquote></li>
<li><blockquote>Read and write data in '''Xcos''' simulation using a '''C binary''' file</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Ubuntu 18.04 OS''' and</blockquote></li>
<li><blockquote>'''Scilab 6.1.0 version'''</blockquote></li></ul>
|-
|
Show Slide:

'''Pre-requisites'''
|
To follow this tutorial, you should have

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li>
<li><blockquote>If not, for relevant tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
| Cursor on the '''Untitled Xcos editing''' window.
|
I have already opened the '''Xcos''' windows.

We can see two windows named '''Untitled Xcos''' and the '''Palette browser''' are opened'''.'''
|-
|
On the '''Untitled Xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''SaveData.xcos''' >> Click on '''OK.'''
|
Go to the '''Untitled Xcos''' window.

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to the '''Downloads''' folder and select the file '''SaveData.xcos'''.

Then click on the '''OK''' button.
|-
| Adjust the Window accordingly.
|
Let me adjust the window.

I have already created this file for demonstration.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos''' window.
| This file has a simple '''Xcos''' simulation diagram.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''RAMP''' block.
| It uses the '''RAMP''' block to generate a '''Ramp''' signal.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''CSCOPE''' block.
|
And the '''CSCOPE''' block to plot it.

Let us see how to record the generated Ramp signal.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos window'''
| First we will see how to push the values generated by the '''RAMP''' block to '''workspace.'''
|-
|
On '''palette browser''',

click on '''Sinks''' >> scroll down >> click on '''TOWS_c.'''
|
Go to the '''palette browser''' window.

Click on the '''Sinks''' palette.

In the right panel, select the '''TOWS_c''' block. This is the '''To Workspace''' block.
|-
| As per narration
| '''Drag and Drop''' the '''TOWS_c''' block to the '''SaveData.xcos''' window'''.'''
|-
|
On the '''editing''' window,

Double click on the '''TOWS_c''' block.
| Double click on the '''TOWS_c''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Size of Buffer.''' Text field to highlight it.
|
The size of buffer is by default set to '''128.'''

This means that 128 values will be saved in the block .

If any more values are passed, the block will overwrite the previous values.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Variable Name''' text field to highlight it.
|
The '''Variable Name''' is the name of the variable to which the values are saved.

By default it is set to '''A.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Inherit''' Text field to highlight it.

Click on the '''OK''' button at the bottom.
|
'''Inherit''' is used to decide whether to take the event input or not.

By default Inherit is set to '''0''' which means it has to take event input.

Click on the '''OK''' button to close this window.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''TOWS_c''' block.

Connect it to the line joining the '''RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''TOWS_c''' block.

Connect it to the line joining the '''CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the '''Warning message.'''
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.

An '''Warning message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

Close the '''Graphic''' window.
|
We can see a straight line with slope 2.

Let’s close the graphic window.
|-
| Switch to '''workspace.'''
|
Now let us look at the values.

Switch to the '''workspace'''.
|-
|
On the '''workspace''',

Type '''''A''''' >> press '''Enter.'''
|
Let us execute the variable '''A'''.

Type '''A''' on the '''workspace''' and press '''Enter'''.
|-
|
On the '''workspace''' window,

Highlight '''variable A.'''

Highlight '''values.'''

Highlight '''time.'''
|
'''A''' is a special variable.

We can either extract '''values''' from '''A''' or we can extract '''times''' from '''A.'''

Let us look at the values.
|-
|
On the '''workspace''' window,

Type '''''A.values''''' >> Press '''Enter.'''
|
Type '''A.values''' on the '''workspace'''.

Press '''Enter.'''
|-
|
On the '''workspace''',

Scroll up to show all the values and Highlight them.
| These are all the values from the graph and are now saved in the workspace.
|-
|
On the '''workspace''',

hover cursor on a new line on the workspace.
| Now we need to save these values in a file so that we can share them.
|-
| Switch to '''SaveData.xcos''' window.
| Switch back to the '''SaveData.xcos''' window.
|-
|
On the '''palette browser''',

Click on '''Sinkss''' >> Click on '''WRITEC_f''' block.
|
To save these values, we will use the '''WRITEC_f''' block.

Go to the '''palette browser''' window.

Click on the '''Sinks''' palette.

Click on the '''WRITEC_f''' block in the right panel.

This is the '''Write to C binary file''' block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''SaveData.xcos''' window.
|-
|
On the '''SaveData.xcos''' window,

Double click on '''WRITEC_f''' block.
| Double click on the '''WRITEC_f''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Input Size''' Text field to highlight it.
| '''Input Size''' is the size of our input values.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Output File Name''' Text field to highlight it >> Change it to '''''‘data’'''''
|
'''Output File''' is the name of our output file.

I will name the output file as '''‘ data ‘'''.

If no file path is entered, the file will be saved in the '''Current working directory.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Output Format''' Text field to highlight it >> Change it to ‘ '''d''' ’
|
'''Output Format''' is the format of the output file.

By default it is '''‘ c ‘.''' That is, by default, values are saved as integers.

But, I want to save the values as '''double.''' So''',''' I will change it to '''‘d’.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.
| '''Buffer Size''' is the size of the buffer.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Click on the '''OK''' button.
|
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''WRITEC_f''' block.

Connect it to the line joining the '''RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''WRITEC_f''' block.

Connect it to the line joining the '''CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning message.
|
Let's run the simulation again by clicking on the '''Start''' Button on the '''toolbar.'''

A '''Warning message''' will appear. Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

'''Close''' the Graphic window.
|
We can see the graph.

Let’s close the graphic window.
|-
| As per narration.
| Let's go to the location where we have saved the data file.
|-
|
On '''file manager window''',

Click on the '''data''' file once.
|
We can see a file named '''‘ data ‘''' .

Since it is a binary encoded file we cannot simply read it.

We would need a special block to read this file.
|-
| Switch back to '''SaveData.xcos''' file
| Switch back to the '''SaveData.xcos''' window.
|-
|
On the '''SaveData.xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''LoadData.xcos''' >> Click on '''OK'''
|
Let us open the file '''LoadData.xcos'''

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to '''Downloads''' Folder and select the file '''LoadData.xcos'''.

Then click on the '''OK''' button.

We will use this file to read our data file.
|-
| Adjust the Window accordingly.
| Let me adjust the window.
|-
|
On the '''palette browser,'''

Click on '''Sources''' >> Click on '''READC_f''' block.
|
We will use the '''READC_f''' block to read our values.

Go to the '''palette browser''' window.

Click on the '''Sources''' palette.

Click on '''READC_f''' Block in the right panel.

This is the '''Read from C Binary''' block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''LoadData.xcos''' window.
|-
|
On the '''LoadData.xcos''' window,

Double click on '''READC_f''' block..
| Double click on the '''READC_f''' block to configure its properties'''.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input File Name''' Text field to highlight it. >> Change it to '''''data'''''
|
'''Input file''' name is the name and the path of your data file.

Since my data file was named '''data''' I will change it to '''data'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input Format''' Text field to highlight it >> Change it to '''''d.'''''
|
'''Input format''' is the format of the data file.

Since the format for my data file is '''double''' , I will change it to '''d'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.

Click the '''OK''' button .
|
This is the buffer size.

Let’s close this window by clicking on the '''OK''' button.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black output port''' of the '''READC_f''' block.

Connect it to the '''black input port''' of the '''CSCOPE''' block.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''READC_f''' block.

Connect it to the line joining the '''CLOCK_C''' & the '''CSCOPE''' block.
|-
|
On the '''LoadData.xcos''' window,

Click on '''Start''' button on the '''toolbar'''
| Let’s run this simulation again by clicking on the '''Start''' Button on the '''toolbar'''.
|-
|
On the '''Graphic''' Window,

Hover Cursor on the '''Graph.'''
|
We have a similar graph to the one we had earlier without using the '''RAMP''' block.

This is because we have loaded the values from the data file.
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Save '''Xcos''' simulation data values to the '''workspace'''.</blockquote></li>
<li><blockquote>Read and write data in '''Xcos''' Simulation using a '''C binary''' file</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
As an assignment,

Create two '''Xcos''' simulation files:

<ul>
<li><blockquote>Use the first for plotting a straight line with slope 3.</blockquote></li>
<li><blockquote>Push the values to the workspace and save them as a binary encoded file.</blockquote></li>
<li><blockquote>Create another '''Xcos''' simulation to plot a new graph of a straight line with slope 3.</blockquote></li>
<li><blockquote>Use only the saved data values.</blockquote></li></ul>
|-
| Show Slide: '''About Spoken Tutorial project'''
|
The video at the following link summarises the Spoken Tutorial project.

Please download and watch it
|-
| Show Slide: '''Spoken Tutorial Workshops'''
|
The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
|
Please post your general and technical queries on '''Scilab''' in this forum.

|-
|
Show Slide:

'''Textbook Companion project.'''
|
The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this website.
|-
| Show Slide: '''Lab Migration'''
|
The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this website.
|-
| Show Slide: '''Acknowledgement'''
| Spoken Tutorial and FOSSEE projects are funded by the Ministry of Education, Government of India.
|-
| Show Slide: '''Thank you'''
|
This is Utkarsh Anand, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-3D-parametric-curves-in-GUI/English

2021-08-06T13:21:15Z

Utkarsha: Created page with "'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves '''Author: Rashmi Patankar, Utkarsh Anand''' '''Keywords: GUI, GUI Builder Toolbox,..."

'''Title of the script:''' Building a '''GUI''' for plotting '''3D''' parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, Scilab, Parametric equation, Sphere, 3D, Text box, Axes, callback function, surf, mesh, meshgrid'''

{|border = 1
| '''Visual Cue'''
| '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting '''3D parametric curves'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this''' '''tutorial, we will learn:
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

The process demonstrated in this tutorial is identical in '''Windows OS '''also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
| To follow this tutorial:
|-
|
Show Slide:

'''Code Files'''
|
|-
|
Show Slide:

'''What is a Parametric Equation of a Sphere?'''
|
The''' parametric equation''' of a sphere is:

<math display="block">{x = r}\cos ⁡\theta\mathit{sin\varphi},{y = r}\sin ⁡\theta\mathit{sin\varphi}</math>

'''& '''<math display="block">{z = r}\cos\varphi</math>'''.'''

Where''','''

We will use these three equations to plot the sphere.
|-
|
Show Slide:

'''Commands to create 3D surface plots'''
|
'''Scilab''' offers many ways to create and customize various types of '''3D''' plots.

We will learn to use the '''surf '''and '''mesh '''commands in this tutorial.

These '''commands''' are used to create a''' 3D''' surface plot.
|-
|
Show slide:

'''What is the surf command?'''

'''Only Narration'''
|
The '''surf command''' draws a '''3D parametric''' surface plot.

It essentially creates a surface with a solid edge and solid face colors.

Hence, in this tutorial, the '''surf command''' will plot a colored '''3D''' sphere.
|-
|
Show slide:

'''What is the mesh command?'''

'''Only Narration'''
|
The '''mesh command''' also draws a '''3D parametric''' surface plot.

In this case, the surface has solid edge colors but no face colors.

So, in this tutorial, the '''mesh command''' will plot a '''3D''' sphere with a white surface.
|-
|
Show slide:

'''Scilab Help Documentation'''
|
For more information on '''mesh''' and '''surf commands''' type the following on the''' Scilab console''':

'''''help surf'''''

'''''help mesh'''''
|-
|
|
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting3dcurves.sce''' file.

Video-editor: Please put a textbox on screen. “plotting3dcurves.sce”
|
Locate the '''plotting3dcurves.sce '''file in the saved folder.

Open the file '''plotting3dcurves.sce''' using the '''GUIBuilder''' '''Toolbox.'''
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Slider, Text '''box''' '''and an''' Axes'''.

Video-editor: Please put a textbox on screen. “Tag: sl_radius, String: Radius”
|
It shows the '''GUI''' with three '''objects''', namely '''Slider, Text '''box''' '''and an''' Axes'''.

The '''Slider''' has '''Tag ‘sl_radius’ '''and '''String ‘Radius’. '''

Its value can vary from '''10''' to '''20'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Text''' box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius, String: Radius”
|
Next we have a '''Text '''box''' '''to display the radius.

It has '''Tag ‘txt_radius’ '''and the''' String''' '''‘Radius’'''.
|-
|
On the '''Graphic Window Number 1''',

hover over the '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_plot, String: Sphere”
|
Lastly, we have the '''Axes '''to display the plot of the sphere.

It has '''Tag ‘ax_plot’''' and '''String ‘Sphere’'''.

Now let us generate the '''Scilab''' code for the same.
|-
|
On the '''GUIBuilder Palette''' Window,

in the '''menu bar''',

click on '''Generate.'''

Click on '''Generate GUI Code''' .
|
Go to '''GUIBuilder Palette''', and click on '''Generate''' in the '''menu bar.'''

Then click on the '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-3d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as''' parametric-3d.'''

Click on the '''OK''' button.
|-
|
Cursor on '''GUI Created '''Window,

click on '''OK.'''
|
It shows a new dialog''' '''box''' '''that displays “'''GUI created successfully!”'''

Click on '''OK.'''

The corresponding '''Scilab''' code file opens.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius'''.
| '''handles.txt_radius '''is the '''handle''' for the '''Text '''box.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.ax_plot'''.
| '''handles.ax_plot '''is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.sl_radius'''.
| '''handles.sl_radius '''is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

inside '''sl_radius_callback '''function,

highlight,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Now notice the '''sl_radius_callback function definition'''.

It has two lines of code in it.

The code essentially connects the '''Slider '''to the '''Text''' box.

As a result when the '''Slider''' is moved, its exact value is displayed in the '''Text''' box.

Then the value of the '''Text''' box is stored inside a '''variable ‘r’'''.
|-
|
On the '''SciNotes Window''',

type on new line outside the '''sl_radius_callback''' function,

'''''function plot_sphere()'''''

'''''delete(handles.ax_plot.children)'''''

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi; '''''

'''''[phi, theta]= ''''''meshgrid''''''(u,v)'''''

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''

'''''surf''''''(x, y, z); '''''

'''''//mesh(x, y, z); '''''

'''''xtitle('Plotting sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Now, let us write a '''user-defined function plot_sphere()''' to plot the sphere.

Type the code as shown here with the same '''syntax'''.

The same code can be found under the Code files section.

You can use it as explained earlier in this tutorial.
|-
|
Highlight,

'''delete(handles.ax_sphere.children).'''
| First, I have written a '''delete function''' to remove the subplots of the graph.
|-
|
highlight,

'''''u = 0:0.1:2*%pi;'''''

'''''v = 0:0.1:2*%pi; '''''

'''''[phi, theta]= ''''''meshgrid''''''(u,v);'''''
|
Notice the next three lines.

The '''meshgrid command''' is used.

It is used to generate''' u '''and '''v matrices''' for '''three-dimensional''' plots.

The range of '''u''' and '''v''' is defined from '''0''' to '''2𝞹''' with a '''step''' size of '''0.1'''.

Finally, the '''matrices''' '''u''' and '''v''' are stored into '''phi''' and''' theta''' respectively.
|-
|
highlight,

'''''x = r*cos(theta)*sin(phi);'''''

'''''y = r*sin(theta)*sin(phi);'''''

'''''z = r*cos(phi);'''''
| Further three lines define the sphere's parametric''' '''equation in terms of '''x, y '''and '''z'''.
|-
|
| Next, we will plot a '''3D parametric''' curve of a sphere.
|-
|
highlight,

'''''surf''''''(x, y, z); '''''
| Firstly, we’ll see the output of the '''surf command'''.
|-
|
highlight,

'''''//mesh(x, y, z); '''''
|
Then next we will see the '''mesh command'''.

For now, I have commented out this line by putting two forward slashes.

Hence the output of only '''surf''' command will be plotted.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of sphere', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| Then the next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On the '''SciNotes Window''',

inside '''sl_radius_callback '''function,

type,

'''''plot_sphere()'''''
|
Now let us call the '''plot_sphere() function''' inside the '''callback function'''.

At the end of '''sl_radius_callback function '''definition''' '''type '''plot_sphere().'''

As a result, varying the radius value on the '''Slider''' the sphere will be plotted.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl '''+''' S''' on the keyboard.
| Let us save our code by pressing '''Ctrl '''+''' S''' keys together.
|-
|
On the '''SciNotes Window''',

click on the '''Execute''' button in the '''menu bar.'''

Click on '''File with echo.'''
|
Now, run this simulation by clicking on the '''Execute''' button in the '''menu bar'''.

Click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider''' indicator towards right slowly.
|
We can see that as we move the '''indicator''' on the '''Slider,''' a sphere is being plotted.

The '''surf command''' now plots a colored '''3D''' sphere.
|-
| Close '''Graphic Window Number 2'''.
|
Now let us test the output of the '''mesh command'''.

Close the '''Graphic Window Number 2.'''
|-
|
On the '''SciNotes Window''',

//'''''surf''''''(x, y, z); '''''

'''''mesh(x, y, z); '''''

Press '''Ctrl + S.'''
|
I'll now add two forward slashes before the '''surf '''command to comment it out.

Then I’ll remove the forward slashes added before the '''mesh '''command to now see its output.

Save the code by pressing '''Ctrl + S''' keys together.
|-
|
On '''SciNotes Window,'''

click on '''Execute''',

click on '''File with echo.'''
|
Again, click on the '''Execute''' menu and then on '''File with echo.'''
|-
|
On '''Graphic window Number 2.'''

move the '''Slider''' indicator towards the right slowly.
|
The '''Graphic window Number 2''' will now show the output of the '''mesh '''command.

Let us move the '''Slider''' indicator and observe the output.

As stated earlier, the '''mesh '''command now plots a '''3D''' sphere with a white surface.
|-
|
| So this way we can build a '''GUI '''for plotting a '''3D '''parametric curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this''' '''tutorial, we have:
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

'''Parametric''' equations:<math display="block">{x = r}\cos ⁡\theta\mathit{sin\varphi},{y = r}\sin ⁡\theta\mathit{sin\varphi}</math>

'''& '''<math display="block">{z = r}\cos\varphi</math>'''.'''
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
|
Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The''' Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Plotting-2D-parametric-curves-in-GUI/English

2021-08-06T13:15:10Z

Utkarsha: Created page with "'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves '''Author: Rashmi Patankar, Utkarsh Anand''' '''Keywords: GUI, GUI Builder Toolbox, Slider..."

'''Title of the script:''' Building a '''GUI''' for plotting 2D parametric curves

'''Author: Rashmi Patankar, Utkarsh Anand'''

'''Keywords: GUI, GUI Builder Toolbox, Slider, delete, Scilab, Parametric equation, Circle, 2D, Text box, Axes, callback function, Tag, String'''

{|border = 1
| '''Visual Cue'''
| '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello, and welcome to the Spoken Tutorial on “Building a '''GUI''' for plotting 2D parametric curves”.
|-
|
Show Slide:

'''Learning Objectives'''
| In this''' '''tutorial, we will learn to:
|-
|
Show Slide:

'''System Requirements'''

'''Only Narration'''
|
To record this tutorial, I am using:

The process demonstrated in this tutorial is identical in '''Windows OS '''also.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
| To follow this tutorial:
|-
|
Show Slide:

'''Code Files'''
|
|-
|
Show Slide:

'''What is a Parametric Equation of a Circle?'''
|
The''' Parametric Equation''' of a circle is <math display="block">{x = r}\cos ⁡{{\theta \land y} = r}\sin ⁡\theta</math>'''.'''

Where,

We will use these two '''equations''' to plot the circle.
|-
|
Show Slide:

'''What is a Slider?'''
|
'''Slider''' is an object that allows the user to dynamically change the value of a '''parameter'''.

It allows the user to move an indicator horizontally to set new values.

The user can also alter the values by clicking on any point on the '''Slider'''.
|-
|
Show Slide:

'''What is a delete function?'''
|
The '''delete '''function is used to delete the '''graphical response'''.

The '''object’s''' '''handle''' whose response is to be deleted, is passed as an '''argument'''.

Syntax: '''delete(<handle of an object>)'''
|-
|
Switch to '''GUIBuilder Toolbox.'''

Open the '''plotting2dcurves.sce '''file.

Video-editor: Please put a textbox on screen. “plotting2dcurves.sce”
|
Let us look at how to use a''' Slider''' to plot a circle with varying radii.

I have opened the '''plotting2dcurves.sce''' file using the '''GUIBuilder toolbox'''.

Now let us look at the '''objects''' that are taken on this graphic window.
|-
|
On '''Graphic Window Number 1''',

hover over the '''Text '''box.

Video-editor: Please put a textbox on screen. “Tag: txt_radius”
|
We have a '''Text '''box with the '''Tag''' '''‘txt_radius'''’ and the '''String '''part is kept empty.

Hence a default value '''UnName1''' is assigned to it as '''String.'''

The '''Text''' box will display the exact value of the radius that the '''Slider''' has selected.
|-
|
On '''Graphic Window Number 1''',

hover over '''Axes'''.

Video-editor: Please put a textbox on screen. “Tag: ax_radius, String:Circle”
|
We also have an '''Axes''' with the '''Tag''' '''‘ax_radius’''' and '''String '''as ‘'''Circle'''’.

This will display the '''response''' of the circle.
|-
|
| Now let us add a '''Slider '''to control the radius value.
|-
|
On '''GUIBuilder Palette,'''

click on the '''Slider'''.
|
On the '''GUIBuilder''' '''Palette''', click on the '''Slider'''.

The '''Scilab Multiple Values Request''' window appears.
|-
|
On '''Scilab Multiple Values Request '''Window,

type '''''sl_radius''''' in '''Tag''' field.

Type '''''Radius''''' in '''String''' field.

Click on '''OK.'''
|
Type '''''sl_radius '''''in the '''Tag''' field and '''''Radius''''' in the '''String''' field.

Close the window by clicking on the '''OK''' button.
|-
|
On '''Graphic Window Number 1''',

place the '''Slider''' above the '''Text '''box.
|
Now place the '''Slider''' above the '''Text '''box.
|-
|
On '''Graphic Window Number 1''',

move the indicator on the '''Slider '''horizontally.
|
Then move the '''Slider''' indicator horizontally to vary the value.

However, we find that we are unable to move the indicator.

We must first enable the '''Slider''' to do so. Let us do that.
|-
|
On '''GUIBuilder Palette '''Window,

cursor on the right side panel.
|
Go to '''GUIBuilder Palette''' and look at the right side panel.

It displays a list of '''Tag''' names for the objects on the '''Graphic '''window.
|-
|
On '''GUIBuilder Palette '''Window,

click on '''sl_radius'''.

Click on '''Object Properties'''.
|
Click on the '''sl_radius.'''

Then click on the '''Object Properties''' button at the bottom right of the window.

The '''Scilab Multiple Values Request '''window will open.
|-
|
On the '''Scilab Multiple Values Request''' Window,

hover over '''Enable'''.

change '''Enable''' property to ‘'''on'''’.
|
Search for the object property '''Enable'''.

Change it from '''Off '''to '''On'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Max''' field.

Change the value from '''1 to 10'''.
|
We also have to change one more object property which is ''''Max''''.

This property will set the upper limit of the '''Slider.'''

Change it from '''1 '''to''' 10'''.
|-
|
On the '''Scilab Multiple Values Request''' Window,

highlight '''Min''' field.

Click on '''OK''' button.
|
Notice the object property ''''Min'''' which is lower limit of the '''Slider.'''

It is always set to '''0, '''by default.

Now let’s vary the value of the radius using the '''Slider''' from '''0 to 10'''.

Let us save the changes by clicking on the '''OK''' button at the bottom.
|-
|
On '''Graphic Window Number 1''',

hover cursor over the '''Graphic Window Number 1'''.
|
Now I will generate the '''Scilab''' code for the same.

In the code file, we will write the code to connect the '''Slider''' and the '''Text''' box.

As a result, the '''Text''' box will display the exact value of the '''Slider'''.

We will also write a '''user-defined function''' to plot the circle.
|-
|
On the '''GUIBuilder Palette''' Window,

click on '''Generate,'''

Click on '''Generate GUI Code'''.
|
On the '''GUIBuilder Palette''' click on the '''Generate''' in the '''menu bar.'''

Then click on '''Generate GUI Code'''.
|-
|
On the '''uiputfile''' Window,

type '''''parametric-2d'''''.

Click on '''OK.'''

Video-editor: Please put a textbox on screen. “In Windows OS, click on Save button.”
|
I will name this file as '''parametric-2d.'''

Click on the '''OK''' button to save it.
|-
|
Cursor on '''GUI Created '''Window,

click on '''OK.'''
|
A '''dialog '''box''' '''appears and displays the message “'''GUI created successfully!”'''

Click on '''OK.'''
|-
| Cursor on '''SciNotes''' Window.
| The corresponding '''Scilab''' code opens.
|-
|
On '''SciNotes''' Window,

highlight '''handles.txt_radius'''.
| '''handles.txt_radius '''is the '''handle''' for the '''Text '''box.
|-
|
On '''SciNotes''' Window,

highlight '''handles.ax_radius'''.
| '''handles.ax_radius '''is the '''handle''' for the '''Axes'''.
|-
|
On '''SciNotes''' Window,

highlight '''handles.sl_radius'''.
| '''handles.sl_radius '''is the '''handle''' for the '''Slider'''.
|-
|
On '''SciNotes''' Window,

cursor on '''sl_radius_callback''' Function.
|
Now let us write a function definition for '''sl_radius_callback '''function.

The function will basically link the '''Text '''box and the '''Slider'''.
|-
|
Cursor on '''SciNotes''' window,

within '''sl_radius_callback''' type,

'''''handles.txt_radius.string = string(handles.sl_radius.value)'''''

'''''r = strtod(handles.txt_radius.string)'''''
|
Type the code as shown here with the same '''syntax'''.

The same code can be found in a file in the '''Code files''' section on this video page.

You can use it as explained earlier in this tutorial.
|-
|
On '''SciNotes''' Window,

highlight,

'''handles.txt_radius.string = string(handles.sl_radius.value)'''
|
This line will assign the value of the '''Slider''' to the '''Text '''box'''.'''
|-
|
On '''SciNotes''' Window,

highlight,

'''r = strtod(handles.txt_radius.string)'''
|
Next, we will assign the radius value from the '''Text''' box to a '''variable ‘r’.'''

Later on, we can use the '''variable ‘r'''’ while writing the equation of a circle.
|-
|
On '''SciNotes Window''',

cursor on new line outside the '''sl_radius_callback''' function, type,

'''''function ''''''plot_circle''''''()'''''

'''''theta = 0:0.1:4*%pi'''''

'''''x = r*cos(theta)'''''

'''''y = r*sin(theta)'''''

'''''plot''''''(x,y)'''''

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''

'''''endfunction'''''
|
Further we will write a '''user defined function plot_circle()''' to plot the circle.

Type the code in the same way as before, with the same '''syntax'''.

This can also be found in the '''Code files''' section.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''theta = 0:0.1:4*%pi'''''
|
First, we have defined the range of '''theta'''.

It will vary from '''0 to 4𝝅 '''with a step size of''' 0.1.'''
|-
|
On the '''SciNotes Window,'''

highlight,

'''''x = r*cos(theta) '''''

'''''y = r*sin(theta)'''''
| The next two lines define the '''parametric equation''' of the circle in terms of '''x''' and '''y'''.
|-
|
On the '''SciNotes Window,'''

highlight,

'''plot(x,y)'''
| The following line will plot the circle.
|-
|
On the '''SciNotes Window,'''

highlight,

'''''xtitle('Plot of circle', 'X-axis', 'Y-axis')'''''

'''''xgrid()'''''
| The next two lines are used to add labels and grid lines to the '''Axes'''.
|-
|
On '''SciNotes Window''',

Inside the '''sl_radius_callback Function '''type,

'''plot_circle()'''
|
Let us call the '''plot_circle() '''function inside the '''callback function'''.

At the end of '''sl_radius_callback '''function definition type '''plot_circle()'''

As a result, when we move the '''Slider''', the circle is plotted for each radius value.
|-
|
On the '''SciNotes Window''',

press '''Ctrl '''+''' S.'''
| Let us save the code by pressing '''Ctrl '''+''' S''' on the keyboard.
|-
|
On '''SciNotes Window''',

click on '''Execute '''Button on '''menubar.'''

Click on '''File with echo.'''
|
We will now execute the code.

Click on the '''Execute '''button on the '''menu bar'''.

Then click on '''File with echo.'''

The '''Graphic Window Number 2''' will appear.
|-
|
On the '''Graphic Window Number 2''',

move the '''Slider'''.

hover over '''Text''' box.

move the '''Slider '''indicator on the right side'''.'''

move the '''Slider '''indicator on the left side'''.'''
|
Let us move the indicator given on the '''Slider.'''

We can see that as we move the indicator, a circle is being plotted.

Notice the '''Text''' box. The value of the radius is also getting changed along with it.

Moving the indicator towards the right increases the radius.

And moving the indicator towards the left decreases the radius.
|-
|
On '''Graphic Window Number 2''',

hover over''' Axes'''.

Close '''Graphic Window Number 2'''.
|
But, the earlier responses are still visible.

Let us delete them by adding a single line.

This line is to be written at the start of '''plot_circle() function definition.'''

Close the '''Graphic Window Number 2'''.
|-
|
On '''SciNotes Window''',

Type within '''''plot_circle''''''()'''''''' '''function and then highlight,

'''''delete(handles.ax_radius.children)'''''
|
Type the line as shown here with the same syntax.

This line deletes all the '''children '''of the current '''Axes'''.

Here, '''children '''refers to the '''subplot''' of the '''Axes'''.
|-
|
On the '''SciNotes Window''',

Press '''Ctrl '''+''' S''' on the keyboard.
| Let us save the work by pressing '''Ctrl '''+''' S''' keys together.
|-
|
On '''SciNotes Window''',

click on '''Execute,'''

Click on '''File with echo.'''
|
Let's go back to the '''menu bar''' and click on '''Execute''' and then on '''File with echo'''.
|-
|
On''' Graphic Window Number 2,'''

move the '''Slider '''indicator to the right and then on the left side'''.'''
|
Now move the '''Slider''' indicator to the right and then to the left side.

The earlier responses are now deleted and no longer visible.

So in this way, we can build a '''GUI '''for plotting a '''2D parametric '''curve in '''Scilab'''.
|-
|
Show Slide:

'''Summary'''
|
Let us summarize.

In this''' '''tutorial, we have:
|-
|
Show Slide:

'''Assignment'''
|
As an assignment, please do the following.

<math display="block">{y = a}t^{2}</math>,<math display="block">{x = 2}\mathit{at}</math>
|-
|
Show Slide:

'''About Spoken Tutorial Project'''
|
The video at the following link summarises the '''Spoken Tutorial''' project.

Please download and watch it.
|-
|
Show Slide:

'''Spoken Tutorial Workshops'''
|
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

For more details, please visit this site.
|-
|
Show Slide: '''Lab Migration'''
|
The '''FOSSEE''' team coordinates the '''Lab Migration project'''.

For more details, please visit this site.
|-
|
Show Slide:

'''Acknowledgements'''
| The''' Spoken Tutorial''' project is funded by the '''Ministry of Education, Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
This is '''Utkarsh Anand''', a '''FOSSEE''' intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Conditional-operations-in-Xcos/English

2021-08-06T13:08:23Z

Utkarsha: Created page with "'''Title of script''': Conditional operations in Xcos '''Author: Rupak Rokade and Utkarsh''' '''Keywords: Xcos, conditional operation, scilab, if-else, loops''' {|border..."

'''Title of script''': Conditional operations in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos, conditional operation, scilab, if-else, loops'''

{|border = 1
| '''Visual Cue'''
| '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “'''Conditional Operations in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:
|-
|
Show Slide:

'''System Requirements'''
| To record this tutorial, I am using
|-
|
Show Slide:

'''Pre-requisites'''
|
To follow this tutorial, you should have :

If not, then go through the '''Scilab''' spoken tutorials on this website.
|-
|
Show Slide:

'''Code Files'''
|
|-
| Cursor on the '''Untitled Xcos''' window.
|
I have already opened the '''Xcos''' window.

We can see two windows named '''Untitled Xcos''' and the '''Palette browser.'''
|-
|
On the '''Untitled Xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''ConditionalOperations.xcos''' >> Click on '''OK.'''
|
Go to the '''Untitled Xcos''' window.

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to the '''Downloads''' folder and select the file '''ConditionalOperations.xcos.'''

Then click on the '''OK''' button.

I have already created this file for demonstration.
|-
| cursor on the '''ConditionalOperations.xcos '''window.
|
This file has a simple '''Xcos''' simulation diagram.
|-
| Cursor on '''ConditionalOperations.xcos window'''
|
Let us add conditional expressions to this file.

To add conditional expressions we will use the '''Expression''' block.
|-
|
On '''palette browser''',

click on '''user-defined-functions''' >> click on '''Expression.'''
|
Go to the''' palette browser''' window.

Click on the '''User-Defined-Functions''' section.

In the right panel, select the '''Expression''' block.
|-
| Drag the '''Expressio'''n block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''Expression''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On '''ConditionalOperations.xcos window''',

Double click on the '''Expression''' block.
| Double click on the''' Expression block''' to configure its properties.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on '''Number of Input''' textbox to highlight it >> Change it to '''1'''.
|
First is the '''number of inputs'''.

By default it is '''2''' which means it can receive 2 input values.

Let us change it to '''1'''.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on '''scilab expression '''textbox to highlight it >> type '''(u1>10)*1 .'''
|
Next, is the '''conditional expression'''.

This is the expression which will be evaluated by the '''Expression''' block.

In '''Xcos, '''by default variables like '''u1, u2''' are used while writing the conditional expressions.

Let us change the default expression.

Enter the expression as shown here.
|-
|
On '''Scilab Multiple Request''' Window,

Double click on the scilab''' expression '''textbox to highlight it.
|
This means that, if '''''u1 > 10''''' then the block should return''' 1'''.
|-
|
On '''Scilab Multiple Request''' Window,

Click on the '''OK''' button.
| Click on the '''OK''' button.
|-
| Cursor on '''ConditionalOperations.xcos window'''
|
Let us display the output of the '''Expression''' block.

To do this, we will use the '''AFFICH_m''' block.
|-
|
On '''palette browser''',

click on '''sinks''' >> click on '''AFFICH_m.'''
|
Go to the''' palette browser''' window.

Click on the '''Sinks''' section.

In the right panel, select the '''AFFICH_m''' block.
|-
| Drag the '''AFFICH_m''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''AFFICH_m''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''EXPRESSION''' block.

Connect it to the line joining the''' RAMP''' and the '''CSCOPE''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''black output port''' of the '''EXPRESSION''' block.

Connect it to the '''black input port''' of the '''AFFICH_m''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''AFFICH_m '''block.

Connect it to the line joining the''' CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the''' menu bar,'''

Click on '''Simulation''' >> Click on '''Setup.'''
|
Before that, we need to change the execution time to Real time.

On the '''menu bar''', click on '''Simulation.'''

Click on '''Setup.'''
|-
|
On '''Set parameters '''window''','''

Change '''Real Time Scaling''' to 1 >> Click on '''OK''' button.
|
Change '''Real Time Scaling''' to '''1'''.

Click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning Message.
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.

An '''Warning Message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos '''window,

Cursor on '''AFFICH_m''' block.
|
We can see the '''AFFICH_m '''block displays '''0''' as long as the graph is less than '''10''' .

After the graph exceeds '''10''' the '''AFFICH_m''' block displays '''1'''.
|-
| Cursor on the '''Graphic Window.'''
|
Suppose we want our simulation to end after some condition has been achieved.

To do this, we will use the '''IFTHEL_f''' block. This is the '''IF-ELSE''' block.
|-
| Close the '''Graphic Window.'''
| Let us close the '''Graphic window.'''
|-
|
On '''palette browser''',

click on '''Event-Handling''' >> click on '''IFTHEL_f.'''
|
Go to the''' palette browser''' window.

Click on the '''Event Handling''' section.

In the right panel, select the '''IFTHEL_f''' block.
|-
| Drag the '''IFTHEL_f ''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''IFTHEL_f''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On the '''ConditionalOperations.xcos '''window,

Cursor on '''IFTHEL_m '''block.
| Now, to halt the simulation we would need the '''HALT_f''' block.
|-
|
On '''palette browser''',

click on '''Event-Handling''' >> click on '''HALT_f.'''
|
Go to the''' palette browser''' window.

Click on the '''Event Handling''' section.

In the right panel, select the '''HALT_f''' block.
|-
| Drag the '''HALT_f ''' block and drop it on the '''ConditionalOperations.xcos window.'''
| '''Drag and drop''' the '''HALT_f''' block on the '''ConditionalOperations.xcos''' window.
|-
|
On the '''ConditionalOperations.xcos '''window,

Cursor on '''HALT_f '''block.
| The''' HALT_f '''block will end the simulation when the condition in the '''IFTHEL_f''' block is satisfied.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''IFTHEL_f''' block.

Connect it to the line joining the''' EXPRESSION''' and the '''AFFICH_m''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Next, Select any of the '''red output ports''' of the '''IFTHEL_f''' block.

Connect it to the '''red input port''' of the '''HALT_f''' block.
|-
|
On '''ConditionalOperations.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''IFTHEL_f''' block.

Connect it to the line entering the '''red input port''' of the '''AFFICH_m '''block'''.'''
|-
|
On the '''ConditionalOperations.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning Message.
|
Let us run this simulation again by clicking on the '''Start''' Button on the '''toolbar'''.

An '''Warning Message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''ConditionalOperations.xcos '''window,

Cursor on '''AFFICH_m '''block.
|
Observe that as soon as the value in the '''AFFICH_m''' block becomes '''1''', the simulation stops.

So this way we can use conditional operations in '''Xcos'''.
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:
|-
|
Show Slide:

'''Assignment'''
|
As an assignment

Create a '''Xcos''' Simulation file to:
|-
| Show Slide: '''About Spoken Tutorial project'''
|
The video at the following link summarises the Spoken Tutorial project.

Please download and watch it
|-
| Show Slide: '''Spoken Tutorial Workshops'''
|
The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
|
Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project.'''
|
The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this site.
|-
|
Show Slide: '''Lab Migration'''
|
The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this site.
|-
|
Show Slide: '''Acknowledgement'''
| Spoken Tutorial and FOSSEE projects are funded by the Ministry of Education, Government of India.
|-
| Show Slide: '''Thank you'''
|
This is Utkarsh, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

''' '''

Scilab/C4/Loading-and-saving-data-in-Xcos/English

2021-08-06T13:04:10Z

Utkarsha:

'''Title of script''': Loading and saving data in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos,TOWS_c, C_binary, workspace, read, write, data file, scilab'''

{| border=1
| '''Visual Cue'''
| '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “ '''Loading and saving data in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:
|-
|
Show Slide:

'''System Requirements'''
| To record this tutorial, I am using
|-
|
Show Slide:

'''Pre-requisites'''
| To follow this tutorial, you should have
|-
|
Show Slide:

'''Code Files'''
|
|-
| Cursor on the '''Untitled Xcos editing''' window.
|
I have already opened the '''Xcos''' windows.

We can see two windows named '''Untitled Xcos''' and the '''Palette browser '''are opened'''.'''
|-
|
On the '''Untitled Xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''SaveData.xcos''' >> Click on '''OK.'''
|
Go to the '''Untitled Xcos''' window.

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to the '''Downloads''' folder and select the file '''SaveData.xcos'''.

Then click on the '''OK''' button.
|-
| Adjust the Window accordingly.
|
Let me adjust the window.

I have already created this file for demonstration.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos '''window.
|
This file has a simple '''Xcos''' simulation diagram.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''RAMP''' block.
| It uses the '''RAMP''' block to generate a '''Ramp''' signal.
|-
|
On the '''SaveData.xcos''' window,

Hover cursor on '''CSCOPE''' block.
|
And the '''CSCOPE''' block to plot it.

Let us see how to record the generated Ramp signal.
|-
|
On the '''SaveData.xcos''' window,

cursor on the '''SaveData.xcos window'''
| First we will see how to push values generated by the '''RAMP''' block to '''workspace.'''
|-
|
On '''palette browser''',

click on '''Sinks''' >> scroll down >> click on '''TOWS_c.'''
|
Go to the''' palette browser''' window.

Click on the '''Sinks''' palette.

In the right panel, select the '''TOWS_c''' block. This is the '''To Workspace '''block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''SaveData.xcos '''window'''.'''
|-
|
On the '''editing '''window,

Double click on the '''TOWS_c''' block.
| Double click on the '''TOWS_c''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Size of Buffer.''' Text field to highlight it.
|
The size of buffer is by default set to '''128.'''

This means that 128 values will be saved in the block .

If any more values are passed, the block will overwrite the previous values.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Variable Name''' text field to highlight it.
|
The '''Variable Name''' is the name of the variable to which the values are saved.

By default it is set to '''A.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''TOWS_c''' block,

Double click on the '''Inherit''' Text field to highlight it.

Click on the '''OK''' button at the bottom.
|
'''Inherit''' is used to decide whether to take the event input or not.

By default Inherit is set to '''0 '''which means it has to take event input.

Click on '''OK''' to close this window.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''TOWS_c''' block.

Connect it to the line joining the''' RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''TOWS_c '''block.

Connect it to the line joining the''' CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the '''SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the '''Warning message.'''
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.

An '''Warning message''' will appear.

Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

Close the '''Graphic''' window.
|
We can see a straight line with slope 2.

Let’s close the graphic window.
|-
| Switch to '''workspace.'''
|
Now let us look at the values.

Switch to the '''workspace'''.
|-
|
On the '''workspace''',

Type '''''A''''' >> press '''Enter.'''
|
Now let us execute the variable '''A'''.

Type '''A''' on the '''workspace''' and press '''Enter'''.
|-
|
On the '''workspace''' window,

Highlight '''variable A.'''

Highlight '''values.'''

Highlight '''time.'''
|

'''A''' is a special variable.

We can either extract''' values''' from '''A''' or we can extract '''times '''from '''A.'''

Let us look at the values.
|-
|
On the '''workspace''' window,

Type''''' A.values''''' >> Press '''Enter.'''
|
Type '''A.values''' on the '''workspace'''.

Press '''Enter.'''
|-
|
On the '''workspace''',

Scroll up to show all the values and Highlight them.
| These are all the values from the graph and are now saved in the workspace.
|-
|
On the '''workspace''',

hover cursor on a new line on the workspace.
| Now we need to save these values in a file so that we can share them.
|-
| Switch to '''SaveData.xcos''' window.
| Let's switch back to the '''SaveData.xcos''' window.
|-
|
On the '''palette browser''',

Click on '''Sinkss''' >> Click on '''WRITEC_f''' block.
|
To save the values, we will use the '''WRITEC_f '''block.

Go to the''' palette browser''' window.

Click on the '''Sinks''' palette.

Click on the''' WRITEC_f''' block in the right panel.

This is the '''Write to C binary file '''block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''SaveData.xcos''' window.
|-
|
On the '''SaveData.xcos''' window,

Double click on '''WRITEC_f''' block.
| Double click on the '''WRITEC_f''' block to configure its properties.
|-
|
On the '''Scilab Multiple Values Request '''Window of '''WRITEC_f''' block,

Double click on the '''Input Size''' Text field to highlight it.
| '''Input Size''' is the size of our input values.
|-
|
On the '''Scilab Multiple Values Request '''Window of '''WRITEC_f''' block,

Double click on the '''Output File Name''' Text field to highlight it >> Change it to '''''‘data’'''''
|
'''Output File''' is the name of our output file.

I will name the output file as '''‘ data ‘'''.

If no file path is entered, the file will be saved in the '''Current working directory.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Output Format''' Text field to highlight it >> Change it to ‘ '''d '''’
|
'''Output Format''' is the format of the output file.

By default it is '''‘ c ‘. '''That is, by default, values are saved as integers.

But, I want to save the data values as '''double. '''So''',''' I will change it to''' ‘d’.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''WRITEC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.
| '''Buffer Size''' is the size of the buffer.
|-
|
On the '''Scilab Multiple Values Request '''Window of '''WRITEC_f '''block,

Click on the '''OK''' button.
|
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black input port''' of the '''WRITEC_f''' block.

Connect it to the line joining the''' RAMP''' and the '''CSCOPE''' block.
|-
|
On '''SaveData.xcos Window''',

Connect as per narration'''.'''
|
Next, Select the '''red input port''' of the '''WRITEC_f '''block.

Connect it to the line joining the''' CLOCK_c''' and the '''CSCOPE''' block.

Our file is ready for simulation.
|-
|
On the''' SaveData.xcos''' window,

Click on '''Start''' button on the toolbar >> click on '''OK''' button on the Warning message.
|
Let's run the simulation again by clicking on the '''Start''' Button on the '''toolbar.'''

An '''Warning message''' will appear. Ignore the message and click on the '''OK''' button.
|-
|
On the '''Graphic''' window,

Hover cursor on the '''graph.'''

'''Close '''the Graphic window.
|
We can see the graph.

Let’s close the graphic window.
|-
| As per narration.
| Let's go to the location where we have saved the data file.
|-
|
On '''file manager window''',

Click on the '''data''' file once.
|
We can see a file named '''‘ data ‘''' .

Since it is a binary encoded file we cannot simply read it.

We would need a special block to read this file.
|-
| Switch back to '''SaveData.xcos''' file
| Let's switch back to the '''SaveData.xcos '''window.
|-
|
On the '''SaveData.xcos''' window,

Cursor on '''Toolbar''' >> Click on '''Open file''' option >> Click on '''LoadData.xcos''' >> Click on '''OK'''
|
Let us open the file '''LoadData.xcos'''

Click on the '''Open File''' icon on the '''Toolbar'''.

A window will appear.

Go to''' Downloads '''Folder and select the file '''LoadData.xcos'''.

Then click on the '''OK''' button.

We will use this file to read our data file.
|-
| Adjust the Window accordingly.
| Let me adjust the window.
|-
|
On the '''palette browser,'''

Click on '''Sources''' >> Click on '''READC_f '''block.
|
We will use the '''READC_f''' block to read our values.

Go to the''' palette browser''' window.

Click on the '''Sources''' palette.

Click on''' READC_f '''Block in the right panel.

This is the '''Read from C Binary''' block.
|-
| As per narration
| '''Drag and Drop''' the block on the '''LoadData.xcos''' window.
|-
|
On the '''LoadData.xcos''' window,

Double click on '''READC_f '''block..
| Double click on the '''READC_f '''block''' '''to configure its properties'''.'''
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input File Name '''Text field to highlight it. >> Change it to '''''data'''''
|
'''Input file''' name is the name and the path of your data file.

Since my data file was named '''data''' I will change it to '''data'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Input Format''' Text field to highlight it >> Change it to '''''d.'''''
|
'''Input format''' is the format of the data file.

Since the format for my data file is '''double''' , I will change it to '''d'''.
|-
|
On the '''Scilab Multiple Values Request''' Window of '''READC_f''' block,

Double click on the '''Buffer Size''' Text field to highlight it.

Click the '''OK''' button .
|
This is the buffer size.

Close this window by clicking on the '''OK''' button.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Let us make the connections.

Select the '''black output port''' of the '''READC_f''' block.

Connect it to the''' black input port '''of the '''CSCOPE '''block.
|-
|
On '''LoadData.xcos Window''',

Connect as per narration'''.'''
|
Lastly, Select the '''red input port''' of the '''READC_f''' block.

Connect it to the line joining the''' CLOCK_C '''& the''' CSCOPE '''block.
|-
|
On the '''LoadData.xcos '''window,

Click on '''Start''' button on the '''toolbar'''
|
Let us run this simulation by clicking on the '''Start''' Button on the '''toolbar'''.
|-
|
On the''' Graphic''' Window,

Hover Cursor on the '''Graph.'''
|
We have a similar graph to the one we had earlier without using the '''RAMP''' block.

This is because we have loaded the values from the data file.
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:
|-
|
Show Slide:

'''Assignment'''
|
As an assignment,

Create two '''Xcos''' simulation files:
|-
| Show Slide: '''About Spoken Tutorial project'''
|
The video at the following link summarises the Spoken Tutorial project.

Please download and watch it
|-
| Show Slide: '''Spoken Tutorial Workshops'''
|
The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project.'''
|
The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this site.
|-
|
Show Slide: '''Lab Migration'''
|
The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this site.
|-
|
Show Slide: '''Acknowledgement'''
| Spoken Tutorial and FOSSEE projects are funded by the Ministry of Education, Government of India.
|-
| Show Slide: '''Thank you'''
|
This is Utkarsh Anand, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

''' '''

Scilab/C4/Loading-and-saving-data-in-Xcos/English

2021-08-06T12:51:29Z

Utkarsha: Created page with "'''Title of script''': Loading and saving data in Xcos '''Author: Rupak Rokade and Utkarsh''' '''Keywords: Xcos,TOWS_c, C_binary, workspace, read, write, data file, scilab''..."

'''Title of script''': Loading and saving data in Xcos

'''Author: Rupak Rokade and Utkarsh'''

'''Keywords: Xcos,TOWS_c, C_binary, workspace, read, write, data file, scilab'''

{|
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|-
|}

''' '''