Commit 4480eae3 authored by Laurent Claustre's avatar Laurent Claustre

Added a doc

parent 21abf1df
Frelon
----------
.. image:: FReLoN-2k.jpg
Introduction
````````````
TODO
Prerequisite
````````````
Installation & Module configuration
````````````````````````````````````
- follow first the steps for the linux installation :ref:`linux_installation`
The minimum configuration file is *config.inc* :
.. code-block:: sh
COMPILE_CORE=1
COMPILE_SIMULATOR=0
COMPILE_SPS_IMAGE=1
COMPILE_ESPIA=0
COMPILE_FRELON=1
COMPILE_MAXIPIX=0
COMPILE_PILATUS=0
COMPILE_BASLER=0
COMPILE_PROSILICA=0
COMPILE_ROPERSCIENTIFIC=0
COMPILE_MYTHEN=0
COMPILE_ADSC=0
COMPILE_UEYE=0
COMPILE_XH=0
COMPILE_XSPRESS3=0
COMPILE_XPAD=0
COMPILE_PERKINELMER=0
COMPILE_ANDOR=0
COMPILE_PHOTONICSCIENCE=0
COMPILE_PCO=0
COMPILE_MARCCD=0
COMPILE_POINTGREY=0
COMPILE_IMXPAD=0
COMPILE_DEXELA=0
COMPILE_RAYONIXHS=0
COMPILE_CBF_SAVING=0
COMPILE_NXS_SAVING=0
COMPILE_FITS_SAVING=0
COMPILE_EDFGZ_SAVING=0
COMPILE_TIFF_SAVING=0
COMPILE_CONFIG=1
LINK_STRICT_VERSION=0
export COMPILE_CORE COMPILE_SPS_IMAGE COMPILE_SIMULATOR \
COMPILE_ESPIA COMPILE_FRELON COMPILE_MAXIPIX COMPILE_PILATUS \
COMPILE_BASLER COMPILE_PROSILICA COMPILE_ROPERSCIENTIFIC COMPILE_ADSC \
COMPILE_MYTHEN COMPILE_UEYE COMPILE_XH COMPILE_XSPRESS3 COMPILE_XPAD COMPILE_PERKINELMER \
COMPILE_ANDOR COMPILE_PHOTONICSCIENCE COMPILE_PCO COMPILE_MARCCD COMPILE_DEXELA\
COMPILE_POINTGREY COMPILE_IMXPAD COMPILE_RAYONIXHS COMPILE_CBF_SAVING COMPILE_NXS_SAVING \
COMPILE_FITS_SAVING COMPILE_EDFGZ_SAVING COMPILE_TIFF_SAVING COMPILE_CONFIG\
LINK_STRICT_VERSION
- start the linux compilation :ref:`linux_compilation`
- finally with the Tango server installation :ref:`tango_installation`
Initialisation and Capabilities
````````````````````````````````
In order to help people to understand how the camera plugin has been implemented in LImA this section
provide some important information about the developer's choices.
Camera initialisation
......................
The Frelon plugin is providing a helper class **FrelonAcq** which manages the initialisation sequence with
the camera and interface object. One should only provide an Espia board channel number as the initialisation
parameter (default is 0).
frelon = Frelon.FrelonAcq(int(espia_dev_nb))
return frelon.getGlobalControl()
Std capabilites
................
This plugin has been implemented in respect of the mandatory capabilites but with limitations according
due to the detector specific features and with some programmer's choices. We do not explain here the standard Lima capabilites
but you can find in this section the useful information on the Dexela specfic features.
* HwDetInfo
TODO
* HwSync
TODO
Optional capabilites
........................
In addition to the standard capabilities, we make the choice to implement some optional capabilities in order to
have an improved simulation.
* HwShutter
TODO
* HwRoi
TODO
* HwBin
TODO
Configuration
`````````````
The main configuration will consist in providing the correct "DexelaConfig.cfg" file to the detector API.
The file has to be provided by the manufacturer with a second file like "sensor2923.fmt". The .fmt file contains
some calibration data.
How to use
````````````
The LimaCCDs tango server provides a complete interface to the dexela plugin so feel free to test.
For a quick test one can use python, is this a short code example:
.. code-block:: python
from Lima import Frelon
from lima impor Core
import time
FrelonAcq = Frelon.FrelonAcq(int(espia_dev_nb))
control = FrelonAcq.getGlobalControl()
acq = control.acquisition()
# setting new file parameters and autosaving mode
saving=control.saving()
pars=saving.getParameters()
pars.directory='/tmp/'
pars.prefix='testfrelon_'
pars.suffix='.edf'
pars.fileFormat=Core.CtSaving.EDF
pars.savingMode=Core.CtSaving.AutoFrame
saving.setParameters(pars)
# now ask for 2 sec. exposure and 10 frames
acq.setAcqExpoTime(2)
acq.setNbImages(10)
acq.prepareAcq()
acq.startAcq()
# wait for last image (#9) ready
lastimg = control.getStatus().ImageCounters.LastImageReady
while lastimg !=9:
time.sleep(1)
lastimg = control.getStatus().ImageCounters.LastImageReady
# read a image
im0 = control.ReadImage(0)
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