Commit 7130a061 authored by PERNOT Guillaume's avatar PERNOT Guillaume

doc updates

parent a9f89392
......@@ -25,35 +25,45 @@ Server will listen on port 9999 on all interfaces by default.
Commands are sent using `nc`. *e.g.* :
```
echo "maa 0.1,0.2,0.3,0.4,0.5" | nc localhost 9999
echo "maa 0.1,0.2,0.3,0.4,0.5 0 0.01 outputs" | nc localhost 9999
```
## Outputs
FITS files are copied in `destination_dir`. Stats about each acquisition are appended to `destination_dir/stats.csv`, whose columns are : filename, x, y, z, theta, phi, flux, x_max, y_max.
with :
flux : intensity of the most bright pixel in image
x_max, y_max : coordinates of the most bright pixel
## Commands
### `maa` $`x`$,$`y`$,$`z`$,$`\theta`$,$`\phi`$ `[repeat]` - Move and acquire
### `maa` $`x`$,$`y`$,$`z`$,$`\theta`$,$`\phi`$ `repeat time destination_dir` - Move and acquire
Do a move_rel_pos_ats and acquire a fits file from `atik`.
Resulting file is copied in `outputs` directory.
Resulting file is copied in `destination_dir` directory.
If `repeat` is given, repeat the process `repeat` times.
Repeat the process `repeat` times.
*e.g.* :
```
echo "maa 0.1,0.2,0.3,0.4,0.5 4" | nc localhost 9999
echo "maa 0.1,0.2,0.3,0.4,0.5 4 0.005 outputs" | nc localhost 9999
```
### `scan2d y_inc z_inc n_y n_z time` - Scan a 2d area
### `scan2d y_inc z_inc n_y n_z time destination_dir` - Scan a 2d area
`y_inc` and `z_inc` are the $`y`$ and $`z`$ increments, respectively.
`n_y` and `n_z` are the numbers of $`y`$ and $`z`$ steps, respectively.
### `scan3d x_inc y_inc z_inc n_x n_y n_z time` - Scan a 3d cube
Resulting files are moved to `destination_dir` directory.
### `scan3d x_inc y_inc z_inc n_x n_y n_z time destination_dir` - Scan a 3d cube
`x_inc`, `y_inc` and `z_inc` are the $`x`$, $`y`$ and $`z`$ increments, respectively.
`n_y` and `n_z` are the numbers of $`x`$, $`y`$ and $`z`$ steps, respectively.
*e.g.* :
```
echo "scan3d 0.1 0.1 0.05 10 10 20 0.005" | nc localhost 9999
echo "scan3d 0.1 0.1 0.05 10 10 20 0.005 outputs" | nc localhost 9999
```
......@@ -115,8 +115,6 @@ def move_and_acquire(atsctl, atik, rel_pos, repeat, _time, destdir):
for i in range(repeat):
print("maa {}/{}".format(i+1, repeat))
cmd(atsctl, 'move_rel_pos_ats {}'.format(rel_pos), error='ERROR')
cmd(atsctl, 'wait_move', error='ERROR')
acquire_and_save(atsctl, atik, destdir)
......
Markdown is supported
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