Skip to content

Commit 09be2bf

Browse files
PierreRaybautPierreRaybaut
committed
Doc: add icons in menu creation documentation for images and signals
1 parent bb7fe21 commit 09be2bf

File tree

2 files changed

+107
-38
lines changed

2 files changed

+107
-38
lines changed

‎doc/features/image/menu_create.rst‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,53 @@ Create a new image from various models
2222

2323
.. list-table::
2424
:header-rows: 1
25-
:widths: 20, 80
25+
:widths: 10, 20, 70
2626
:class: longtable
2727

28-
* - Model
28+
* - Icon
29+
- Model
2930
- Equation
30-
* - Zero
31+
* - .. image:: ../../../datalab/data/icons/create/2d-zero.svg
32+
:width: 30px
33+
- Zero
3134
- :math:`z[i] = 0`
32-
* - Normal distribution
35+
* - .. image:: ../../../datalab/data/icons/create/2d-normal.svg
36+
:width: 30px
37+
- Normal distribution
3338
- :math:`z[i]` is normally distributed with configurable mean and standard deviation
34-
* - Poisson distribution
39+
* - .. image:: ../../../datalab/data/icons/create/2d-poisson.svg
40+
:width: 30px
41+
- Poisson distribution
3542
- :math:`z[i]` is Poisson distributed with configurable mean
36-
* - Uniform distribution
43+
* - .. image:: ../../../datalab/data/icons/create/2d-uniform.svg
44+
:width: 30px
45+
- Uniform distribution
3746
- :math:`z[i]` is uniformly distributed between two configurable bounds
38-
* - 2D Gaussian
47+
* - .. image:: ../../../datalab/data/icons/create/2d-gaussian.svg
48+
:width: 30px
49+
- 2D Gaussian
3950
- :math:`z = A \cdot \exp\left(-\dfrac{\left(\sqrt{\left(x-x_0\right)^2+\left(y-y_0\right)^2}-\mu\right)^2}{2\sigma^2}\right)`
40-
* - 2D Ramp
51+
* - .. image:: ../../../datalab/data/icons/create/2d-ramp.svg
52+
:width: 30px
53+
- 2D Ramp
4154
- :math:`z = A (x - x_0) + B (y - y_0) + C`
42-
* - Checkerboard
55+
* - .. image:: ../../../datalab/data/icons/create/checkerboard.svg
56+
:width: 30px
57+
- Checkerboard
4358
- Alternating square pattern for calibration and spatial frequency analysis
44-
* - Sinusoidal grating
59+
* - .. image:: ../../../datalab/data/icons/create/grating.svg
60+
:width: 30px
61+
- Sinusoidal grating
4562
- :math:`z = A \sin(2\pi(f_x \cdot x + f_y \cdot y) + \varphi) + C`
46-
* - Ring pattern
63+
* - .. image:: ../../../datalab/data/icons/create/ring.svg
64+
:width: 30px
65+
- Ring pattern
4766
- Concentric circular rings for radial analysis
48-
* - Siemens star
67+
* - .. image:: ../../../datalab/data/icons/create/siemens.svg
68+
:width: 30px
69+
- Siemens star
4970
- Radial spoke pattern for resolution testing
50-
* - 2D sinc
71+
* - .. image:: ../../../datalab/data/icons/create/2d-sinc.svg
72+
:width: 30px
73+
- 2D sinc
5174
- :math:`z = A \cdot \mathrm{sinc}\left(\dfrac{\sqrt{(x-x_0)^2+(y-y_0)^2}}{\sigma}\right) + C`

‎doc/features/signal/menu_create.rst‎

Lines changed: 71 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,50 +21,91 @@ Create a new signal from various models:
2121

2222
.. list-table::
2323
:header-rows: 1
24-
:widths: 20, 80
24+
:widths: 10, 20, 70
2525
:class: longtable
2626

27-
* - Model
27+
* - Icon
28+
- Model
2829
- Equation
29-
* - Zero
30+
* - .. image:: ../../../datalab/data/icons/create/1d-zero.svg
31+
:width: 30px
32+
- Zero
3033
- :math:`y[i] = 0`
31-
* - Normal distribution
34+
* - .. image:: ../../../datalab/data/icons/create/1d-normal.svg
35+
:width: 30px
36+
- Normal distribution
3237
- :math:`y[i]` is normally distributed with configurable mean and standard deviation
33-
* - Poisson distribution
38+
* - .. image:: ../../../datalab/data/icons/create/1d-poisson.svg
39+
:width: 30px
40+
- Poisson distribution
3441
- :math:`y[i]` is Poisson distributed with configurable mean
35-
* - Uniform distribution
42+
* - .. image:: ../../../datalab/data/icons/create/1d-uniform.svg
43+
:width: 30px
44+
- Uniform distribution
3645
- :math:`y[i]` is uniformly distributed between two configurable bounds
37-
* - Gaussian
46+
* - .. image:: ../../../datalab/data/icons/create/gaussian.svg
47+
:width: 30px
48+
- Gaussian
3849
- :math:`y = y_{0}+\dfrac{A}{\sqrt{2\pi} \cdot \sigma} \cdot \exp\left(-\dfrac{1}{2} \cdot \left(\dfrac{x-x_{0}}{\sigma}\right)^2\right)`
39-
* - Lorentzian
50+
* - .. image:: ../../../datalab/data/icons/create/lorentzian.svg
51+
:width: 30px
52+
- Lorentzian
4053
- :math:`y = y_{0}+\dfrac{A}{\sigma \cdot \pi} \cdot \dfrac{1}{1+\left(\dfrac{x-x_{0}}{\sigma}\right)^2}`
41-
* - Voigt
54+
* - .. image:: ../../../datalab/data/icons/create/voigt.svg
55+
:width: 30px
56+
- Voigt
4257
- :math:`y = y_{0}+A \cdot \dfrac{\Re\left(\exp\left(-z^2\right) \cdot \erfc(-j \cdot z)\right)}{\sqrt{2\pi} \cdot \sigma}` with :math:`z = \dfrac{x-x_{0}-j \cdot \sigma}{\sqrt{2} \cdot \sigma}`
43-
* - Blackbody (Planck's law)
58+
* - .. image:: ../../../datalab/data/icons/create/planck.svg
59+
:width: 30px
60+
- Blackbody (Planck's law)
4461
- :math:`y = \dfrac{2 h c^2}{\lambda^5 \left(\exp\left(\dfrac{h c}{\lambda k T}\right)-1\right)}`
45-
* - Sine
62+
* - .. image:: ../../../datalab/data/icons/create/sine.svg
63+
:width: 30px
64+
- Sine
4665
- :math:`y = y_{0}+A\sin\left(2\pi \cdot f \cdot x+\phi\right)`
47-
* - Cosine
66+
* - .. image:: ../../../datalab/data/icons/create/cosine.svg
67+
:width: 30px
68+
- Cosine
4869
- :math:`y = y_{0}+A\cos\left(2\pi \cdot f \cdot x+\phi\right)`
49-
* - Sawtooth
70+
* - .. image:: ../../../datalab/data/icons/create/sawtooth.svg
71+
:width: 30px
72+
- Sawtooth
5073
- :math:`y = y_{0}+A \left( 2 \left( f x + \frac{\phi}{2\pi} - \left\lfloor f x + \frac{\phi}{2\pi} + \frac{1}{2} \right\rfloor \right) \right)`
51-
* - Triangle
74+
* - .. image:: ../../../datalab/data/icons/create/triangle.svg
75+
:width: 30px
76+
- Triangle
5277
- :math:`y = y_{0}+A \sawtooth\left(2 \pi f x + \phi, \text{width} = 0.5\right)`
53-
* - Square
78+
* - .. image:: ../../../datalab/data/icons/create/square.svg
79+
:width: 30px
80+
- Square
5481
- :math:`y = y_0 + A \sgn\left( \sin\left( 2\pi f x + \phi \right) \right)`
55-
* - Cardinal sine
82+
* - .. image:: ../../../datalab/data/icons/create/sinc.svg
83+
:width: 30px
84+
- Cardinal sine
5685
- :math:`y = y_0 + A \sinc\left(2\pi f x + \phi\right)`
57-
* - Linear chirp
86+
* - .. image:: ../../../datalab/data/icons/create/linear_chirp.svg
87+
:width: 30px
88+
- Linear chirp
5889
- :math:`y = y_{0} + A \sin\left(\phi_{0} + 2\pi \left(f_{0}\, x + \frac{1}{2} c\, x^{2}\right)\right)`
59-
* - Step
90+
* - .. image:: ../../../datalab/data/icons/create/step.svg
91+
:width: 30px
92+
- Step
6093
- :math:`y = y_{0}+A \left\{\begin{array}{ll}1 & \text{if } x > x_{0} \\ 0 & \text{otherwise}\end{array}\right.`
61-
* - Exponential
94+
* - .. image:: ../../../datalab/data/icons/create/exponential.svg
95+
:width: 30px
96+
- Exponential
6297
- :math:`y = y_{0}+A \exp\left(B \cdot x\right)`
63-
* - Logistic
98+
* - .. image:: ../../../datalab/data/icons/create/logistic.svg
99+
:width: 30px
100+
- Logistic
64101
- :math:`y = y_{0} + \dfrac{A}{1 + \exp\left(-k \left(x - x_{0}\right)\right)}`
65-
* - Pulse
102+
* - .. image:: ../../../datalab/data/icons/create/pulse.svg
103+
:width: 30px
104+
- Pulse
66105
- :math:`y = y_{0}+A \left\{\begin{array}{ll}1 & \text{if } x_{0} < x < x_{1} \\ 0 & \text{otherwise}\end{array}\right.`
67-
* - Step Pulse
106+
* - .. image:: ../../../datalab/data/icons/create/step_pulse.svg
107+
:width: 30px
108+
- Step Pulse
68109
- | :math:`y = \left( \begin{cases} y_0 & \text{if } x < t_0 \\ y_0 + A \cdot \dfrac{x - t_0}{t_r} & \text{if } t_0 \leq x < t_0 + t_r \\ y_0 + A & \text{if } x \geq t_0 + t_r \end{cases} \right) + \mathcal{N}\left(0, \sigma_n\right)`
69110

70111
| where:
@@ -73,7 +114,9 @@ Create a new signal from various models:
73114
* :math:`t_r` is the rise time,
74115
* :math:`\sigma_n` is the noise amplitude
75116

76-
* - Square Pulse
117+
* - .. image:: ../../../datalab/data/icons/create/square_pulse.svg
118+
:width: 30px
119+
- Square Pulse
77120
- | :math:`y(x) = \left(\begin{cases} y_0 & \text{if } x < t_0 \\ y_0 + A \cdot \dfrac{x - t_0}{t_r} & \text{if } t_0 \leq x < t_0 + t_r \\ y_0 + A & \text{if } t_0 + t_r \leq x < t_1 \\ y_0 + A - A \cdot \dfrac{x - t_1}{t_f} & \text{if } t_1 \leq x < t_1 + t_f \\ y_0 & \text{if } x \geq t_1 + t_f \end{cases} \right) + \mathcal{N}(0, \sigma_n)`
78121

79122
| where:
@@ -89,7 +132,10 @@ Create a new signal from various models:
89132

90133
The duration of the plateau :math:`d` should not be negative.
91134

92-
* - Polynomial
135+
* - .. image:: ../../../datalab/data/icons/create/polynomial.svg
136+
:width: 30px
137+
- Polynomial
93138
- :math:`y = y_{0}+A_{0}+A_{1} \cdot x+A_{2} \cdot x^2+\ldots+A_{n} \cdot x^n`
94-
* - Custom
139+
* -
140+
- Custom
95141
- Manual input of X and Y values

0 commit comments

Comments
 (0)