10 User Manual: Chapter 2
Ad5001 edited this page 2023-05-24 02:11:45 +00:00
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

← Previous chapter | Chapter 2: Editing object properties (≡ Index) | Next chapter →

Editing object properties

Introduction

Each object (as seen in chapter 0) has properties, which are the core of the customisability of objects. There exists many different kind of properties for different things, like naming objects, the position of points, the expression and domains of functions...

When creating an object, or when clicking on it on the object list, you open the Object Property Editor dialog.

Image of the Object Property Editor dialog

Example dialog for a distribution

This dialog contains all of the properties of the object that can be modified. Each property is updated in real time. You can drag the dialog away to see the consequences of your changes on the graph.

That dialog can be closed by either closing the window or clicking the "OK" button. Both these options save all changes done.

Type of properties

There exists a lot of properties, but each of them are separated in different kinds.

Type Editor Example(s) Comment
Strings Inline text input Object name At the end of the input, the little "α" button allows to enter symbols (greek letters, and indices or supscripts letters and numbers).
Numbers (integers and decimals) Inline text input Label position All inputs other than digits, one optional minus at the start and a dot in the middle are forbidden.
Expressions Inline text input Point position, function expression Like strings, they have the symbol character input dialog. You can use values like e or pi (can also be noted π) in it.
Domains & ranges (sets) Inline text input Function domain and range Use symbolic expressions (e.g R+* will translate to ℝ⁺*, the strictly positive integer set), ranges (e.g ]0;1[) or even sets (e.g {0;3;4}).
Booleans (true or false) Checkbox Show graduation on ω0 for Bode Magnitude
Enumerations (set of predefined values) Combo box Label position and content, point style, bode pass
Other objects Combo box Bode's ω0, X Cursor's target objects. Contains a list of all objects created in required type, and allows to create a new one if needed. X Cursor target object is an exception as it can target several different types of objects.
Lists (lists of values) List of inline text inputs Unused at the moment Sometimes allows the creation of values, at other the number of values is constant.
Dictionaries (list of values associated with another value) List of lines having two text inputs separated by text Sequence expression and default values, distribution default values Sometimes allows the creation of values, at other the number of values is constant.

There can also be comments and notes in between properties to explain the specialties of certain non intuitive properties.

Object properties

The following section is a reference for all object properties. It's currently up to date with LogarithmPlotter v0.4.0.

Reference:

For all objects

Icon Property Type Value Comment
label icon Name string It must not be the same for two objects. This value represents the object.
label icon Label content Enumeration
  • null: No label
  • name: Name of the object
  • name + value: Name of the object and it's value (generally in "name = value")
It's generally used with a positioning property (Label position or Label's X position).

Icon Points

Icon Property Type Value Comment
Position icon X Expression Default: 1 Position of the point on the x-axis.
Position icon Y Expression Default: 0 Position of the point on the y-axis.
All direction icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↑ Above
Position of the label relative to the point.
Appearance icon Point style Enumeration
Default: ●
Visual style of the point representation.

Icon Texts

Icon Property Type Value Comment
Position icon X Expression Default: 1 Position of the text on the x-axis.
Position icon Y Expression Default: 0 Position of the text on the y-axis.
All direction icon Label position Enumeration
  • >|< Center
  • ↑ Top
  • ↓ Bottom
  • ← Left
  • → Right
  • ↖ Top left
  • ↗ Top right
  • ↙ Bottom left
  • ↘ Bottom right
Default: >|< Center
Position of the label relative to the position.
Label icon Content string Default: New text Content of the text item.
Disable LaTeX rendering for this text boolean True or false
Default: false
When enabled, it will use LaTeX to render the whole text, and the parts within $$ will be rendered as a LaTeX mathematical expression string.

Icon Functions

Icon Property Type Value Comment
Expression icon Expression Expression Default: x Expression of the function (depending on variable x).
Domain icon Domain Domain Default: ℝ⁺* Domain (definition range) of the function.
Range icon Range Domain Default: Range (destination range) of the function.
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↑ Above
Position of the label relative to the position.
Appearance icon Display mode Enumeration
  • Application:
    name: domain range
    x expression
  • Function:
    name(x) = expression
Default: Application
Display style of the function's label.
Position icon Label's X position number Default: 1 Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis of the function.
Show points boolean True or false
Default: true
When using a non continous domain (for example , , sets like {0;3}) the function can be displayed using points at the points where the function is defined. Unticking this hides the points.
Show dashed lines boolean True or false
Default: true
When using a non continous domain (for example , , sets like {0;3}) the function can be displayed dashed lines between at the points where the function is defined. Unticking this hides the dashed lines.

Icon Bode Magnitude

Icon Property Type Value Comment
Angle icon ω0 Point By default, a newly created point prefixed by ω in (1,0). Used as the base for the beginning/end of the transitional side of the bode magnitude as well.
Bode pass icon Pass Enumeration
  • High
  • Low
Default: High
Type of bode magnitude pass used for this this object.
Gain icon Gain Expression Default: 20 Amount of decibels per decade used for the bode gain (should be positive for high pass, and negative for low pass).
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↓ Below
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis on the function.
Show graduation on ω0 boolean True or false
Default: false
When ticked, will show a vertical dashed line on top of the assigned ω0.

Icon Bode Magnitudes Sum

Icon Property Type Value Comment
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↑ Above
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the bode magnitude based on the specified x-axis position and it's corresponding y-axis of the bode magnitude.

Icon Bode Phases

Icon Property Type Value Comment
Angle icon ω0 Point By default, a newly created point prefixed by ω in (1,0). Used as the base for the beginning/end of the transitional side of the bode phase as well.
Angle icon Phase Expression Default: 90 Amount of phase (defined in the unit below) used for the bode phase.
Angle icon Unit to use Enumeration
  • °
  • deg
  • rad
Default: °
Unit of the phase to be used (used for display).
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↓ Below
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis on the function.

Icon Bode Phases Sum

Icon Property Type Value Comment
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ↑ Above
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the bode phase based on the specified x-axis position and it's corresponding y-axis of the bode phase.

Icon X Cursors

Icon Property Type Value Comment
Position icon X Expression Default: 1 Position of the cursor on the x-axis.
Target icon Object to target Executable object* Default: no object is selected. Target object of which to show the value of through the X Cursor.
*Executable objects are objects which take values all along the x-axis with a corresponding y-axis value. Functions, bode magnitudes and phases, sequences and distributions qualify as such.
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ← Left
Position of the label relative to the position.
Show approximate value boolean True or false
Default: true
When ticked, will show an approximate version of the value of the targeted object at a the given x next to the value of the simplified expression.
Rounding icon Rounding number Default: 3 Rounding of the approximate value.
Arrows icon Display style Enumeration
  •               
  •               
  • • • •
Default:               
Style of the vertical bar of the cursor.
Position icon Target's value position Enumeration
  • Next to target
  • With label
  • Hidden
Default: Next to target
Position of the target's value on the x cursor. When using "Next to target", it will be at the intersection between the target and the cursor vertical bar, while "With label" puts it just below the name of the cursor and it's position.

Icon Sequences

Icon Property Type Value Comment
Show points boolean True or false
Default: true
Sequences are be displayed using points at each integer the points where the sequence is defined. Unticking this hides the points.
Show dashed lines boolean True or false
Default: true
Sequences are displayed dashed lines between at the points where the sequence is defined. Unticking this hides the dashed lines.
Default expression Dictionary (fixed length at 1, key is a number, value an expression) var[n+k] = expression
Default:
var=u, k=1, expression=n
u[n+1] = n
Note: The expression is being defined through the n variable. You can use the array-syntax to access previous value. For example, for the variable u, you can define u[n+1] depending on u[n] or u[n+2] depending on u[n] and u[n+1] for recursive definition.
Initialisation values Dictionary (key is a number, value an expression var[k] = expr
Default:
var=u, k=0, expr=1
u[0] = 1
Note: You need as many initialisation values (which can be added through the "Add entry button" and removed with the trash buttons) as k.
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ← Left
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the sequence based on the specified x-axis position (integer) and it's corresponding y-axis of the sequence.

Icon Distributions

Icon Property Type Value Comment
Arrows icon Label position Enumeration
  • ↑ Above
  • ↓ Below
  • ← Left
  • → Right
  • ↖ Above left
  • ↗ Above right
  • ↙ Below left
  • ↘ Below right
Default: ← Left
Position of the label relative to the position.
Position icon Label's X position number Default: 1 Base position for the label of the distribution based on the specified x-axis position and it's corresponding y-axis of the distribution.
Probabilities list Dictionary (key is a number, value an number) P(var=k) = value
Default:
var=X, k=0, expr=1
P(X=0) = 0
Note: You need as many probabilities as needed (which can be added through the "Add entry button" and removed with the trash buttons) as k. The displayed graph will be the distribution function.

Next chapter →