Commit 1caacdb4 authored by Cyril Guilloud's avatar Cyril Guilloud
Browse files

flint doc for stat curves

parent 3a88fa7c
Pipeline #75317 passed with stages
in 98 minutes and 6 seconds
......@@ -18,7 +18,7 @@ This scans have to be created usually per beamline in a very specific way.
For this examples we will use a function to simulate them.
```
```python
import gevent
import numpy
from bliss.scanning.group import Sequence
......@@ -53,7 +53,7 @@ This example create a regular scatter.
![Regular scatter in Flint](img/scan_info/regular-scatter.png)
```
```python
from bliss.scanning.scan_info import ScanInfo
import numpy
......@@ -109,7 +109,7 @@ For now only Flint will only display the last frame.
![Regular scatter in Flint](img/scan_info/regular-scatter-3d.png)
```
```python
from bliss.scanning.scan_info import ScanInfo
import numpy
......@@ -157,7 +157,7 @@ That's what we simulate here. `axis1` and `axis2` are also provided as
![Axis and encoder together](img/scan_info/scatter-encoder.png)
```
```python
from bliss.scanning.scan_info import ScanInfo
import numpy
......@@ -217,7 +217,7 @@ used to know the amount of pixels to used per axis.
![Non-regular scatter in Flint](img/scan_info/irregular-scatter.png)
```
```python
from bliss.scanning.scan_info import ScanInfo
import numpy
......@@ -255,7 +255,7 @@ This also can work for extra dimensions with steppers.
![Non-regular scatter in Flint](img/scan_info/irregular-scatter-3d.png)
```
```python
from bliss.scanning.scan_info import ScanInfo
import numpy
......
......@@ -8,7 +8,7 @@ with the data to be displayed.
## Basic plot display
A generic display is provided through the BLISS `plot` command.
A generic display is provided through the BLISS `plot()` command.
It checks the data dimensionality to select the kind of charts.
......@@ -40,7 +40,7 @@ plot(cube)
To use more features another way is provided.
First a plot have to be created from Flint.
First a plot has to be created from Flint.
The first argument (here `curve`) is used to select the kind of expected plot.
See the following documentation for example of each kind.
......@@ -384,7 +384,7 @@ p.export_to_logbook()
From a scripts Flint also can be used to display plot.
The `plot` command can be imported the following way:
The `plot()` command can be imported the following way:
```python
from bliss.common.plot import plot
......
......@@ -55,7 +55,7 @@ From BLISS shell, few basic interaction with Flint are provided.
To invoke or retrieve a proxy to interact with Flint you can use:
```
```python
flint()
```
......@@ -65,7 +65,7 @@ flint()
The returned object provides few methods to close the application:
```
```python
f = flint()
f.close() # request a normal close of the application
f.kill() # kill
......@@ -77,7 +77,7 @@ f.kill9() # kill -9
If your window manager provides this feature, you can force the focus on the
application this way:
```
```python
f = flint()
f.focus()
```
......
......@@ -4,6 +4,33 @@ If the scan contains counters, the curve widget will be displayed automatically.
![Flint screenshot](img/flint-curve-widget.png)
## Statistic tools
Some statistics can be added to the graph as curve or markers.
By clicking on the "Create new items in the plot" ![Flint
screenshot](img/curve_icon_add_curve.png) icon, a new curve or marker can be
added to represent a calculation based on the current curve.
The statistical filters available are:
* Max marker
* Min marker
* Derivative function
* Negative function
* Gaussian fit
* Normalized function
* Normalized range
* Sliding windows mean
For example, on this plot, min/max markers and a 11-points sliding window mean
have been added.
![Curve statistics](img/curve_statistics.png)
## Compare scans
A tool provided in the property tool bar allow to compare scans.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment