Commit a9020398 authored by Samuel Debionne's avatar Samuel Debionne

Update the documentation (build with CMake) and cleanup

parent d4c302e3
......@@ -5,73 +5,88 @@ MarCCD
.. image:: marccd.png
Intoduction
```````````
Introduction
````````````
The SX165 features a round, 165 mm diameter active area, and a versatile, high resolution CCD chip. It is the ideal X-ray detector for research applications with both synchrotrons and rotating anode X-ray sources.
Prerequisite
````````````
The MarCCD software server should be started on the MarCCD host computer, by running the command:
.. code-block:: bash
marccd -r
$ marccd -r
Then you can launch your lima/marccd client on another host, as the MarCCD server can be reached by network
Installation & Module configuration
```````````````````````````````````
Follow the generic instructions in :ref:`build_installation`. If using CMake directly, add the following flag:
.. code-block:: sh
-DLIMACAMERA_MARCCD=true
For the Tango server installation, refers to :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.
```````````````````````````````
Implementing a new plugin for new detector is driven by the LIMA framework but the developer has some freedoms to choose which standard and specific features will be made available. This section is supposed to give you good knowledge regarding camera features within the LIMA framework.
Camera initialisation
......................
There are 4 parameter to be filled by your Lima client:
There are 4 parameters to be filled by your Lima client:
- The IPAddress of the host where the marccd server is running
- The port of the marccd server process
- The detector target path: the path where will be saved the marccd image files
- Reader timeout: in ms, the timeout after which the plugin will be in fault if no marccd image file is present
- Reader timeout: in ms, the timeout after which the plugin will be in fault if no marccd image file is present
Std capabilites
Std capabilities
................
This plugin has been implemented in respect of the mandatory capabilites but with some limitations according
This plugin has been implemented in respect of the mandatory capabilites but with some limitations according
to some programmer's choices. We only provide here extra information for a better understanding
of the capabilities for the MarCCD camera.
* HwDetInfo
- Max image size is : 4096 * 4096
- 16 bit unsigned type is supported
- Max image size is : 4096 * 4096
- 16 bit unsigned type is supported
* HwSync
trigger type supported are:
- IntTrig
Optional capabilites
........................
- trigger type supported are:
- IntTrig
Optional capabilities
.....................
* HwBin
- 2 * 2
- 4 * 4
- 8 * 8
* HwRoi
TODO
Configuration
`````````````
No Specific hardware configuration are needed
No Specific hardware configuration is needed.
How to use
````````````
here is the list of accessible fonctions to configure and use the MarCCD detector:
Here is the list of accessible fonctions to configure and use the MarCCD detector:
.. code-block:: cpp
......@@ -96,7 +111,3 @@ here is the list of accessible fonctions to configure and use the MarCCD detect
void setWavelength(float);
float getWavelength();
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