Setup¶
The system setup defines the set of system properties, which can be changed during run-time, with some exceptions.
This version of the setup is based on YAML and a plain hierachical parameter naming scheme.
The following categories of parameters are defined:
Exposure Control
Simulation
Pipeline Processing
An example of a setup, in this case the Initialisation Setup, is available in CCF: “ccf/control/resource/config/ccf/control/initSetup1.yaml”.
Adding new adapters, it is possible to also add new Setup Parameters. The ones defines in this chapter are the standard/common parameters.
Exposure Control Parameters¶
In the following the table the exposure control related setup parameters are listed:
expo.mode (String) |
Defines the mode to acquire the camera. Possible value are “Continuous” and “Finite”. |
expo.nb (Integer) |
Defines the number of image acquisitions to carry out in “Finite” Exposure Mode. Note: Not supported for the ICSv3 release. |
expo.time (Double) |
Exposure time in seconds to apply for the image acquisition. |
expo.frame.rate (Double) |
The requested frame rate to apply. Note the frame rate is correlated with the exposure time. Note: Not supported for the ICSv3 release. |
expo.win.start_x (Integer) |
Defines the lower left x-coordinate of the current ROI. The first pixel is 1. |
expo.win.start_y (Integer) |
Defines the lower left y-coordinate of the current ROI. The first pixel is 1. |
expo.win.width (Integer) |
The width of the current ROI in pixels. |
expo.win.height (Integer) |
The height of the current ROI in pixels. |
expo.bin_x (Integer) |
The binning in X. |
expo.bin_y (Integer) |
The binning in Y. |
Simulation Parameters¶
In the following the table the exposure control related setup parameters are listed:
sim.type (String) |
Defines the type of the simulation. Not relevant for the simulated behaviour provided by the Simulation Communication Adapter in this release as it supports play-back of an FITS Data Simulation File. |
sim.file (String) |
Name of Simulation Data File to use as basis for the simulated behaviour. |
Pipeline Processing¶
In the following the table the exposure control related setup parameters are listed:
proc#.enabled (Boolean) |
Used to toggle the given Processing Pipeline on/off. |
proc#.recipe#.enabled (Boolean) |
Used to enable/disable the individual Processing Recipe registered and defined. |
proc#.recipe#. recipe_base.delay (Double) |
Engineering parameter used to introduce an artificial delay, given in seconds, in the Base Recipe Class (“ccf::common::RecipeBase”). |
proc#.pub#.enabled (Boolean) |
Used to enable/disable the individual Data Publisher Thread. |
proc#.pub#.pub_base.delay (Double) |
Engineering parameter used to introduce an artificial delay, given in seconds, in the Base Recipe Class (“ccf::common::RecipeBase”). |
Note, for each Data Publisher Adapter, specific setup Parameters may be defined. The parameters for the standard Data Publisher Adapters provided by the CCF Package, are documented in the chapter “Standard Adapters”.