CFEL - ASG Software Suite  2.5.0
CASS
.ini Parameter List
Class cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/%layername%/One
groupname of the first wireend. See cass::ACQIRIS::SignalProducer

AcqirisDetectors/%detectorname%/%layername%/Two
groupname of the second wireend See cass::ACQIRIS::SignalProducer

Class cass::ACQIRIS::CFD8Bit

.../ConstantFraction/{AcqirisInstrument}
Acqiris Instrument that this channel is in:

  • 8: Camp (Acqiris Multiinstrument with 5 Cards (20 Channels))
  • 4: AMO I-ToF
  • 5: AMO Magnetic Bottle
  • 2: AMO Gas Detector

.../ConstantFraction/{ChannelNumber}
Channel within the instrument (starts counting from 0)

.../ConstantFraction/Timeranges/(0,1,...)/{LowerLimit|UpperLimit}
set of timeranges. One can set more than one range of interest. Default is no timerange, which will result in no signal will be found.

.../ConstantFraction/{Polarity}
the polarity of the signals that we are interested in:

  • 1: Positive Polarity
  • 2: Negative Polarity

.../ConstantFraction/{Threshold}
the theshold for the signals in Volts:

.../ConstantFraction/{Delay}
delay in ns used by the constant fraction method:

.../ConstantFraction/{Fraction}
fraction used by the constant fraction method:

.../ConstantFraction/{Walk}
walk of the Constant Fraction Discriminator in Volts

Class cass::ACQIRIS::CoM8Bit

.../CenterOfMass/{AcqirisInstrument}
Acqiris Instrument that this channel is in:

  • 8: Camp (Acqiris Multiinstrument with 5 Cards (20 Channels))
  • 4: AMO I-ToF
  • 5: AMO Magnetic Bottle
  • 2: AMO Gas Detector

.../CenterOfMass/{ChannelNumber}
Channel within the instrument (starts counting from 0)

.../CenterOfMass/Timeranges/(0,1,...)/{LowerLimit|UpperLimit}
set of timeranges. One can set more than one range of interest. Default is no timerange, which will result in no signal will be found.

.../CenterOfMass/{Polarity}
the polarity of the signals that we are interested in:

  • 1: Positive Polarity
  • 2: Negative Polarity

.../CenterOfMass/{Threshold}
the theshold for the signals in Volts:

Class cass::ACQIRIS::CombineConditions< FirstCondition, SecondCondition >
see TofCond, RadCond and RectCond for possible settings
Class cass::ACQIRIS::Converter

Converter/LCLSAcqirisDevices/Detector/{size}
Number of user defined detectors to be pulled out of the xtc

Converter/LCLSPixelDetectors/Detector/%id%/{TypeName}
The type of the detector. Only the following types are supported:

  • Id_AcqConfig : config for Acqiris device
  • Id_AcqWaveform : data of the Acqiris device

Converter/LCLSAcqirisDevices/%id%/{DetectorName}
Name of the detector. Default is invalid

Converter/LCLSAcqirisDevices/%id%/{DetectorID}
the id of the detector. Default is 0.

Converter/LCLSAcqirisDevices/%id%/{DeviceName}
Name of the detector device

Converter/LCLSAcqirisDevices/%id%/{DeviceID}
Id of the detector device

Converter/LCLSAcqirisDevices/%id%/{CASSID}
the Id the Acqiris should get in the CASSEvent. One needs this number for further processing. Note that the config and the data part must have the same CASSID.

Class cass::ACQIRIS::DelaylineDetector

AcqirisDetectors/%detectorname%/{AnalysisMethod}
Method that is used to reconstruct the detector hits. Default is 0. Choises are:

AcqirisDetectors/%detectorname%/{DelaylineType}
What kind of Delaylinedetector are we. Default is 0

  • 0: Quad Anode
  • 1: Hex Anode

AcqirisDetectors/%detectorname%/MCP
Name of the MCP Signal. See cass::ACQIRIS::SignalProducer

AcqirisDetectors/%detectorname%/XLayer
groupname of the X Layer, when DelaylineType is Quad see cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/YLayer
groupname of the Y Layer, when DelaylineType is Quad see cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/ULayer
groupname of the U Layer, when DelaylineType is Hex see cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/VLayer
groupname of the V Layer, when DelaylineType is Hex see cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/WLayer
groupname of the W Layer, when DelaylineType is Hex see cass::ACQIRIS::AnodeLayer

AcqirisDetectors/%detectorname%/Particles
groupname of the user definable Particles. see cass::ACQIRIS::Particle

Class cass::ACQIRIS::DelaylineDetectorAnalyzerSimple

AcqirisDetectors/%detectorname%/Simple/{Runtime}
maximum time a signal will run over the complete delayline. Default is 150.

AcqirisDetectors/%detectorname%/Simple/{McpRadius}
Radius of the MCP in mm. Default is 88

AcqirisDetectors/%detectorname%/Simple/{LayersToUse}
Layers that should be used for sorting. Default is 0. Possible choises are:

  • 0: Layers X and Y (Quad Anode)
  • 1: Layers U and V (Hex Anode)
  • 2: Layers U and W (Hex Anode)
  • 3: Layers V and W (Hex Anode)

AcqirisDetectors/%detectorname%/Simple/{TimesumFirstLayerLow|TimesumFirstLayerHigh}
the timesum condition range for the first layer. Default is 0 | 200

AcqirisDetectors/%detectorname%/Simple/{TimesumSecondLayerLow|TimesumSecondLayerHigh}
the timesum condition range for the second layer. Default is 0 | 200

AcqirisDetectors/%detectorname%/Simple/{ScalefactorFirstLayer|ScalefactorSecondLayer}
the scalefactors that convert ns to mm for the two layers. Default is 0.4 | 0.4

Class cass::ACQIRIS::DelaylineNonSorting

.../NonSorting/{LayersToUse}
Layers that should be used for sorting. Default is 0. Possible choises are:

  • 0: Layers X and Y (Quad Anode)
  • 1: Layers U and V (Hex Anode)
  • 2: Layers U and W (Hex Anode)
  • 3: Layers V and W (Hex Anode)

.../NonSorting/{ScalefactorFirstLayer|ScalefactorSecondLayer}
the scalefactors that convert ns to mm for the two layers. Default is 0.4 | 0.4

Class cass::ACQIRIS::HelperAcqirisDetectors
AcqirisDetectors/%name%/{DetectorType}
Type of the detector that this helper should be managing. Default is 1 (TofDetector). Possible choises are
Class cass::ACQIRIS::HexSorter

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumU}
Center of the timesum of layer U. Default is 100.

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumUWidth}
With at the base of timesum of layer U. Default is 0.

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumV}
Center of the timesum of layer W. Default is 100.

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumVWidth}
With at the base of timesum of layer U. Default is 0.

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumW}
Center of the timesum of layer W. Default is 100.

AcqirisDetectors/%detectorname%/HexSorting/{TimeSumWWidth}
With at the base of timesum of layer U. Default is 0.

AcqirisDetectors/%detectorname%/HexSorting/{MaxRuntime}
the maximum time it takes a signal to get across the delayline wire. Default is 150.

AcqirisDetectors/%detectorname%/HexSorting/{DeadTimeAnode}
the deadtime betwenn 2 anode singals in ns. Default is 20.

AcqirisDetectors/%detectorname%/HexSorting/{DeadTimeMCP}
the deadtime between 2 mcp signals in ns. Default is 20.

AcqirisDetectors/%detectorname%/HexSorting/{MCPRadius}
The radius of the MCP in mm. Should be ~10 percent bigger that the actual value. Default is 88.

AcqirisDetectors/%detectorname%/HexSorting/{UseMCP}
use the mcp signal when reconstructing the detector hits. Default is 'true'

AcqirisDetectors/%detectorname%/HexSorting/{ScalefactorU}
Conversion factor to convert position from ns to mm. The scalefactors of the other two layers will be determined by the calibrator and written into the settingsfile (see parameter SettingsFilename)

AcqirisDetectors/%detectorname%/HexSorting/{CenterX|CenterY}
Center position of the detector image, if not centered around 0. Default is 0|0

AcqirisDetectors/%detectorname%/HexSorting/{SettingsFilename}
Name of the file that contains the advanced settings. This will be created by the PostProcessor that does the Hex calibration (pp170). See cass::HexCalibrator for descriptions of this PostProcessor.

Class cass::ACQIRIS::HitCorrector

AcqirisDetectors/%detectorname%/Particles/%particlename%/Corrections/{T0}
Time in ns that should be substracted from the recorded time of the detectorhit. Default is 0.

AcqirisDetectors/%detectorname%/Particles/%particlename%/Corrections/{CorrectX|CorrectY}
Position in mm that should be substracted from the x and y position of the detectorhit. Default is 0|0.

AcqirisDetectors/%detectorname%/%particlename%/Corrections/{ScaleX|ScaleY}
Factor by which the corrected position should be multiplied, to get a right sized image. Default is 1|1.

AcqirisDetectors/%detectorname%/Particles/%particlename%/Corrections/{Angle}
Angle in degree around which the corrected and scaled position should be roated. Default is 0.

Class cass::ACQIRIS::Particle

AcqirisDetectors/%detectorname%/Particles/%particlename%/{Charge}
The charge of the particle in atomic units. Default is 1.

AcqirisDetectors/%detectorname%/%particlename%/{Mass}
The Mass of the particle in atomic mass units. When one wants to define a electron the charge has to be -1 and the Mass 1. Default is 1.

AcqirisDetectors/%detectorname%/Particles/%particlename%/{Spectrometer}
The Spectrometer that the Particles fly through. See cass::ACQIRIS::Spectrometer

AcqirisDetectors/%detectorname%/Particles/%particlename%/{Corrections}
The corrections that one has to do to the raw values of a hit in order to convert the hit values to momentum. See cass::ACQIRIS::HitCorrector

AcqirisDetectors/%detectorname%/Particles/%particlename%/{ConditionType}
The type of condition that we use to identify a particle hit from a detectorhit. Default is 0. Possible choises are:

Class cass::ACQIRIS::RadCond

AcqirisDetectors/%detectorname%/%particlename%/RadiusCondition/{CenterX|CenterY}
The position of the center of the radius to check for in mm Default is 0|0.

AcqirisDetectors/%detectorname%/%particlename%/RadiusCondition/{MaximumRadius}
The maximum radius the position is checked for in mm. Default is 100.

Class cass::ACQIRIS::RectCond

AcqirisDetectors/%detectorname%/%particlename%/SimplePositionCondition/{XLow|XHigh}
The range in the x-axis to check in mm. Default is -10|10.

AcqirisDetectors/%detectorname%/%particlename%/SimplePositionCondition/{YLow|YHigh}
The range in the y-axis to check in mm. Default is -10|10.

Class cass::ACQIRIS::SignalProducer

.../{SignalExtractionMethod}
the method type that will be used to extract the signals from the recorded data. To see what options need to be set for the specific signalextraction methods description. There are the following options :

.../{GoodRangeLow|GoodRangeHigh}
The lower an upper boundaries of the range where good single hits appear in. Default is 0.

Class cass::ACQIRIS::Spectrometer

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/{BFieldIsOn}
Flag to tell whether a magnetic field is present in the spectrometer. Default is false

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/{RotationClockwise}
Flag to tell in which direction the magentic field is pointing This can be told by telling in which way the electrons rotate. If they rotate clockwise this should be true. Default is true.

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/{CyclotronPeriode}
The time it takes for an electron to make a complete rotation in the magnetic field in ns. Default is 10

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/{Regions}
The groupname of the regions of a spectrometer. See cass::ACQIRIS::SpectrometerRegion

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/Regions/{Size}
The number of spectrometer regions available. Default is 0.

Class cass::ACQIRIS::SpectrometerRegion

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/Regions/%regionindex%/{Length}
The length of the spectrometer region in mm. Default is 10.

AcqirisDetectors/%detectorname%/Particles/%particlename%/Spectrometer/Regions/%regionindex%/{EField}
The strength of the electric field in the spectrometer region in $\frac{V}{cm}$. Default is 10.

Class cass::ACQIRIS::TofCond
AcqirisDetectors/%detectorname%/%particlename%/ToFCondition/{Low|High}
The range to check whether the detectorhit is in. Default is 0|20000.
Class cass::ACQIRIS::TofDetector
AcqirisDetectors/%detectorname%/MCP
Name of the MCP Signal. See cass::ACQIRIS::SignalProducer
Class cass::ACQIRISTDC::TDCExtractor

.../TDCExtraction/{TDCInstrument}
Acqiris Instrument that this channel is in:

  • 0: TDC in SXR-Hutch

.../TDCExtraction/{ChannelNumber}
Channel within the instrument (starts counting from 0). Default is 0.

.../TDCExtraction/Timeranges/(0,1,...)/{LowerLimit|UpperLimit}
set of timeranges. One can set more than one range of interest. Default is no timerange, which will result in no signal will be found.

Class cass::FileInput
FileInput/{Parallelize}
When true, it will read the files on the fileinput list in parallel. Default is false.
Class cass::FormatConverter
Converter/{Used}
comma separated list of Converters that should be active. Default is "". Possible values are:
Class cass::HDF5FileInput

HDF5FileInput/{EventIDKey}
The name of the dataset within the hdf5 file that allows to retrieve the current event ID. The Groupname of the Event can be omitted. Default is "EventID"

HDF5FileInput/MachineValues/{size}
The number of machine parameters that one wants to retrieve. Ensure that each parameter has a unique id in the list. All reuested machine parameters will be stored in the beamlineparameter part of the CASSEvent. Use PostProcessor 120 to retrieve those values for processing later on.

HDF5FileInput/MachineValues/%index%/{HDF5Key}
Name of the dataset that contains the requested machine parameter. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/MachineValues/%index%/{CASSName}
Name of the parameter within the Beamlineparameter part of the CASSEvent. Default is "Invalid" in which case the name of the dataset will be used.

HDF5FileInput/MachineValues/%index%/{ArrayIndex}
In case the value is contained within an array. This is the index at which the values stand within the array. Default is 0

HDF5FileInput/AcqirisValues/{size}
The number of acqirs instrument channels that one wants to retrieve. Each channel of an instrument has to be defined separately. Ensure that each parameter has a unique id in the list.

HDF5FileInput/AcqirisValues/%index%/{HDF5DataKey}
Name of the dataset that contains the requested acqiris channel data. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/AcqirisValues/%index%/{HDF5HorposKey}
Name of the dataset that contains the Horpos value of the requested acqiris channel. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/AcqirisValues/%index%/{HDF5VerticalOffsetKey}
Name of the dataset that contains vertical offset value of the requested acqiris channel. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/AcqirisValues/%index%/{HDF5GainKey}
Name of the dataset that contains the vertical gain value of the requested acqiris channel. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/AcqirisValues/%index%/{HDF5SampleIntervalKey}
Name of the dataset that contains the sample interval value of the requested acqiris channel. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/AcqirisValues/%index%/{CASSInstrumentID}
The id of the insturment within the CASSEVent that the acqiris data should be copied to. Default is "1". This should not be changed since this is the generic instrument id. Note that not all ids are available.

HDF5FileInput/AcqirisValues/%index%/{CASSChannelNumber}
The channel number within the instrument of the CASSEvent that the channel data should be copied to. Default is 0.

HDF5FileInput/PixelDetectorValues/{size}
The number of pixeldetectors that one wants to retrieve. Ensure that each parameter has a unique id in the list.

HDF5FileInput/PixelDetectorValues/%index%/{HDF5DataKey}
Name of the dataset that contains the requested pixel detector data. The Groupname of the Event can be omitted. Default is "Invalid"

HDF5FileInput/PixelDetectorValues/%index%/{CASSID}
The id that the pixel detector should have whithin the CASSEvent Default is 0.

Class cass::HexCalibrator

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" Speciality of this Processor is, that it will only work with hex Delayline detectors and the appropriate HexSorter. Make sure that all settings of the HexSorter are correctly set. See cass::ACQIRIS::HexSorter and cass::ACQIRIS::DelaylineDetector.

Processor/%name%/{RatioFullBins}
The ratio of how many bins in the detector image have to be full before the calibration is started and the results written to the settingsfile.

Class cass::ImageGenerator
TestInput/ImageGenerator/{InstrumentId}
Class cass::Log

Log/{MaxLoggingLevel}
The maximum Level of output requested.

Log/{Directory}
The directory where the log file will be written to. Default is the directory that cass was started in.

Log/{Filename}
The name of the log file. Default is "casslog_%yyyyMMdd%".

Class cass::MultiFileInput

MultiFileInput/{NbrDifferentSources}
Tells the program how many different sources it should expect. If for one eventId there are less sources recognized than this number a warning will be issued and the event is skipped. Default is 2.

MultiFileInput/{UseNewContainer}
set to true if you want to use the new container for pixeldetector data that can make use of the new analysis chain. Default is false.

MultiFileInput/{Rewind}
Tells the program to start over running over all files when true. Default is false.

Class cass::pixeldetector::AboveNoiseFinder
PixelDetectors/%name%/AboveNoiseFinder/{Multiplier}
Value multiplied to the noise value before comparing whether the pixel is above the noise. Default is 4.
Member cass::pixeldetector::addCircle (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{CenterX|CenterY}
The center of the circle. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{Radius}
The radius of the circle. Default is 2.

Member cass::pixeldetector::addEllipse (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{CenterX|CenterY}
The central point of the ellipse. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{SemiAxisX|SemiAxisY}
The semi axis along x and y of the ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 5|4.

Member cass::pixeldetector::addRing (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{InnerCenterX|InnerCenterY}
The central point of the inner ellipse. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{InnerSemiAxisX|InnerSemiAxisY}
The semi axis along x and y of the inner ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 5|4.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{OuterCenterX|OuterCenterY}
The central point of the outer ellipse. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{OuterSemiAxisX|OuterSemiAxisY}
The semi axis along x and y of the outer ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 20|20.

Member cass::pixeldetector::addSquare (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{LowerLeftX|LowerLeftY}
The lower left pixel of the square element. The indizes given are . included in the square. Default is 0|0.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{UpperRightX|UpperRightY}
The upper right pixel of the square element. The indizes given are . included in the square. Default is 1023|1023.

Member cass::pixeldetector::addTriangle (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{PointA_X|PointA_Y}
The triangles first point. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{PointB_X|PointB_Y}
The triangles first point. Default is 500|500.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{PointC_X|PointC_Y}
The triangles first point. Default is 500|500.

Class cass::pixeldetector::AdvancedDetector

PixelDetectors/%name%/{Detector}
The detector that contains the ccd image. Default is 0. Options are:

  • 0: Front pnCCD
  • 1: Rear pnCCD
  • 2: 1st commercial CCD in AMO
  • 3: 2nd commercial CCD in AMO
  • 4: 3rd commercial CCD in AMO
  • 6: 4th commercial CCD in AMO
  • 5: 1st commercial CCD in XPP
  • 7: Front CsPad in CXI
  • 8: Rear CsPad in CXI

PixelDetectors/%name%/{FrameProcessorType}
Functor for processing the frame. Default is "none". Options are:

  • "none": No processing is done to the frame, just the raw frame will be returned
  • "hll": The type of processing that the semiconductor lab applies to their frame data. see cass::pixeldetector::HLLProcessor

PixelDetectors/%name%/{PixelFinderType}
Functor for finding pixels of interest in the frame. The pixels will be found after the frame processor has processed the frame. Default is "aboveNoise". Options are:

PixelDetectors/%name%/{CoalescingFunctionType}
Functor to coalesce the pixels into hits. Default is "simple". Options are:

there are more settings for the common data. Please see cass::pixeldetector::CommonData for details on what to set.

Class cass::pixeldetector::CommonData

PixelDetectors/%name%/CorrectionMaps/{MapCreatorType}
The type of functor that will create the maps used for correcting the frames from individual frames. See Map-Creators List for a list of all possible values. Default is "none".

PixelDetectors/%name%/CorrectionMaps/{InputOffsetNoiseFilename}
The filename containing the saved noise and offset maps. Default is "darkcal_%detectorId%.lnk". Which is a link to the most recent darkcalibration file. If no file is found, the offset will be set to 0 and the noise will be set to 4000. When the user has chosen a "NoisyPixelThreshold" lower than 4000 this will result in a completly masked frame.

PixelDetectors/%name%/CorrectionMaps/{InputOffsetNoiseFiletype}
The filetype that the values are stored in. Default is "hll". Options are:

  • "hll": the filetype used by the semi conductor lab.
  • "cass": the filetype formerly used in CASS.

PixelDetectors/%name%/CorrectionMaps/{OutputOffsetNoiseFilename}
The filename where the offset and noise values will be written to. If the name is "darkcal", the name will be build by the detector id and the current date and time when it was written. Also when writing a link to the written file will be created like this: "darkcal_%detectorID%.lnk". When the name differs from "darkcal", the values will be written only to the given filename. See cass::pixeldetector::CommonData::saveOffsetNoiseMaps for more details. Default is "darkcal".

PixelDetectors/%name%/CorrectionMaps/{OutputOffsetNoiseFiletype}
The filetype that the noise and offset values are stored to. Default is "hll". Options are:

  • "hll": the filetype used by the semi conductor lab.
  • "cass": the filetype formerly used in CASS.

PixelDetectors/%name%/CorrectionMaps/{GainMapCreatorType}
The type of functor that will create the gain used for correcting the frames from individual frames. See Gainmap-Creators List for a list of all possible values. Default is "none".

PixelDetectors/%name%/CorrectionMaps/{InputGainFilename}
The filename containing the gain (/cte) values. Default is "gain_\%detectorId\%.lnk".

PixelDetectors/%name%/CorrectionMaps/{InputGainFiletype}
The filetype that the gain (/cte) values are stored in. Default is "hll". Options are:

  • "hll": the filetype used by the semi conductor lab.
  • "cass": the filetype used by CASS.

PixelDetectors/%name%/CorrectionMaps/{OutputGainFilename}
The filename where the gain (/cte) values will be written to. If the name is "gain", the name will be build by the detector id and the current date and time when it was written. Also when writing a link to the written file will be created like this: "gain_\%detectorID\%.lnk". When the name differs from "gain", the values will be written only to the given filename. See cass::pixeldetector::CommonData::saveGainMap for more details. Default is "gain".

PixelDetectors/%name%/CorrectionMaps/{OutputGainFiletype}
The filetype that the gain (/cte) values are stored in. Default is "cass". Options are:

  • "cass": the filetype used by CASS.

PixelDetectors/%name%/CorrectionMaps/{NoisyPixelThreshold | LowerNoisyPixelThreshold}
The boundaries to identify noisy pixels. Will be used when creating the correction map. When the noise of the pixel is outside these exclusive bounds the pixel will be masked. If NoisyPixelThreshold is -1, good values for the bound will be determined from the noise map. Default is 40000 | 0

PixelDetectors/%name%/CorrectionMaps/{AutoMultiplier}
When automatically determining the noise threshold, this is the multiplier by which the autovalue is determined. $ NoisyPixelThreshold = mean_noise + AutoMultiplier + stdv_noise $. $ LowerNoisyPixelThreshold = mean_noise - AutoMultiplier + stdv_noise $. Default is 4.

PixelDetectors/%name%/CorrectionMaps/{nColumns}

PixelDetectors/%name%/CorrectionMaps/{nRows}

Class cass::pixeldetector::commonmode::CalculatorBase

PixelDetectors/%name%/HLLProcessing/CommonModeCorrection/{Width}
How many pixels shoudl be included in the common mode correction. The width of one Camex is 128 pixels. Sometimes it is better to to calculate the common mode from the entire quadrant in which case it should be 512. Default is 128.

PixelDetectors/%name%/HLLProcessing/CommonModeCorrection/{Multiplier}
When suppressing pixels in the common mode calculation that contain photons this is the multiplier that should be added to the noise before checking for photons. Default is 4

Class cass::pixeldetector::commonmode::MeanCalculator

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{NbrMinDisregardedValues}
The number of lowest values that should be disreagarded when calculating the mean value. Default is 5.

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{NbrMaxDisregardedValues}
The number of highest values that should be disreagarded when calculating the mean value. Default is 0.

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{MinNbrPixels}
The minimal number of Pixels that should be found in the range before the common mode value will be calculated. Default is 8

Class cass::pixeldetector::commonmode::MedianCalculator

PixelDetectors/%name%/HLLProcessing/MedianCommonMode/{NbrMinDisregardedValues}
The number of lowest values that should be disreagarded when getting the median value. Default is 5.

PixelDetectors/%name%/HLLProcessing/MedianCommonMode/{NbrMinDisregardedValues}
The number of highest values that should be disreagarded when getting the median value. Default is 0.

PixelDetectors/%name%/HLLProcessing/MedianCommonMode/{MinNbrPixels}
The minimal number of Pixels that should be found in the range before the common mode value will be calculated. Default is 8.

Class cass::pixeldetector::commonmode::SimpleMeanCalculator
PixelDetectors/%name%/HLLProcessing/SimpleMeanCommonMode/{MinNbrPixels}
The minimal number of Pixels that should be found in the range before the common mode value will be calculated. Default is 8
Class cass::pixeldetector::Converter

Converter/LCLSPixelDetectors/{size}
Number of user defined detectors to be pulled out of the xtc

Converter/LCLSPixelDetectors/%id%/{TypeName}
The type of the detector. Only the following types are supported:

  • Id_pnCCDconfig : config for pnCCD data
  • Id_pnCCDframe : the pnCCD data
  • Id_Frame : Opal, TM6740 images
  • Id_CspadConfig: config for CsPad data
  • Id_CspadElement: the CsPad data
  • Id_Cspad2x2Element: the CsPad2x2 data

Converter/LCLSPixelDetectors/%id%/{DetectorName}
Name of the detector. Default is invalid

Converter/LCLSPixelDetectors/%id%/{DetectorID}
the id of the detector. Default is 0.

Converter/LCLSPixelDetectors/%id%/{DeviceName}
Name of the detector device

Converter/LCLSPixelDetectors/%id%/{DeviceID}
Id of the detector device

Converter/LCLSPixelDetectors/%id%/{CASSID}
the Id the detector should get in the CASSEvent. One needs this number for further processing. Note that the config and the data part must have the same CASSID.

Member cass::pixeldetector::createCASSMask (CommonData &data, CASSSettings &s)

PixelDetectors/%name%/CorrectionMaps/Mask/{size}
The number of mask elements that are part of the complete mask. Default is 0.

PixelDetectors/%name%/CorrectionMaps/Mask/%index%/{MaskElementType}
Name of the mask element. Default is "Unknown", which let the code ignore that element. Possible values are:

Class cass::pixeldetector::DetectorHelper
PixelDetectors/{Name}
Name of the Pixeldetector. See cass::pixeldetector::AdvancedDetector for more information.
Class cass::pixeldetector::FixedMaps

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{NbrFrames}
The number of frames that should be collected for calculating the maps. Default is 200.

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{StartInstantly}
Flag to tell whether the calculator should start instantly with collecting the frames and calculating the maps. If false it will wait until told by the program through the available GUI's. Default is false.

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{DisregardedHighValues}
Number of highest values that should be disregarded when calculating the offset value. Default is 5

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{DisregardedLowValues}
Number of lowest values that should be disregarded when calculating the offset value. Default is 0

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{UseMedian}
Tell the creator to use a median to calculate the offset value. If this is false the offset is calculated via the mean value. Default is false

PixelDetectors/%name%/CorrectionMaps/FixedCreator/{WriteMaps}
Tell the creator to write the calulated maps once they have been calculated. For further infomration on how the files are written, see cass::pixeldetector::CommonData. Default is true.

Class cass::pixeldetector::GainCalibration

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{StartInstantly}
Flag to tell whether the calculator should start instantly after loading the seetings. If false it will wait until told by the program through the available GUI's. Default is false.

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{NbrFrames}
The number of frames that should be processed before the gain map is calculated. Default is -1, which means that the only criteria is that the MinimumMedianCounts have to be reached before calulating the gain map.

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{MinimumPhotonCount}
How many times the adu value of the pixel was in the user defined ADURange, before the gain for this pixel will be calculated. Default is 50

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{MinimumMedianCounts}
The gain values are only calculates when median counts per pixel exeed this value. Default is 50.

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{MinADURange|MaxADURange}
The range in ADU in which the pixelvalue has to lie before it is taken into the statistics. Default is 0|1000.

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{SaveCalibration}
If true writes the gain calibration to file. For further information on how the files are written, see cass::pixeldetector::CommonData. Default is true.

PixelDetectors/%name%/CorrectionMaps/GainFixedADURange/{CommonModeCalculationType}
defines what kind of common mode correction should be done with the frames. There are settings that are used fo all calculation types. see cass::pixeldetector::commonmode::CalculatorBase. Default type is "none". Possible values are:

Class cass::pixeldetector::HLLProcessor
PixelDetectors/%name%/HLLProcessing/{CommonModeCalculationType}
defines what kind of common mode correction should be done with the frames. There are settings that are used fo all calculation types. see cass::pixeldetector::commonmode::CalculatorBase. Default type is "none". Possible values are:
Class cass::pixeldetector::HotPixelsFinder

PixelDetectors/%name%/CorrectionMaps/HotPixelFinder/{ADUThreshold}

PixelDetectors/%name%/CorrectionMaps/HotPixelFinder/{NbrConsecutiveFrames}

Class cass::pixeldetector::MovingMaps

PixelDetectors/%name%/CorrectionMaps/ChangingCreator/{NbrTrainingFrames}
The number of frames that should be collected for calculating the initial maps. Default is 50.

PixelDetectors/%name%/CorrectionMaps/ChangingCreator/{DoTraining}
Before updating collect a set of "training" frames from which the initial maps are created. This is recommended if one does not have or has an outdated noise and offset map. Default is false.

PixelDetectors/%name%/CorrectionMaps/ChangingCreator/{NbrOfAverages}
The number of past frames that should be taken into account when calculating the noise and offset map. Default is 50.

PixelDetectors/%name%/CorrectionMaps/ChangingCreator/{Multiplier}
How much bigger does the pixel value have to be than the noise before The pixel is not taken into account when calculating the offset and noise of that pixel. Default is 4.

PixelDetectors/%name%/CorrectionMaps/ChangingCreator/{AutoSaveSize}
Tells to save the noise and offset map and recalculate the correction map after this many frames. Default is 1e6.

Class cass::pixeldetector::OnlineFixedCreator

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreator/{Multiplier}
How much bigger does the pixel value have to be than the noise before The pixel is not taken into account when calculating the offset and noise of that pixel. Default is 4.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreator/{NbrFrames}
The number of frames that should be collected for calculating the maps. Default is 200.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreator/{StartInstantly}
Flag to tell whether the calculator should start instantly with collecting the frames and calculating the maps. If false it will wait until told by the program through the available GUI's. Default is false.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreator/{WriteMaps}
Tell the creator to write the calulated maps once they have been calculated. For further infomration on how the files are written, see cass::pixeldetector::CommonData. Default is true.

Class cass::pixeldetector::OnlineFixedCreatorCommonMode

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreatorCommonMode/{Multiplier}
How much bigger does the pixel value have to be than the noise before The pixel is not taken into account when calculating the offset and noise of that pixel. Default is 4.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreatorCommonMode/{NbrFrames}
The number of frames that should be collected for calculating the maps. Default is 200.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreatorCommonMode/{StartInstantly}
Flag to tell whether the calculator should start instantly with collecting the frames and calculating the maps. If false it will wait until told by the program through the available GUI's. Default is false.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreatorCommonMode/{WriteMaps}
Tell the creator to write the calulated maps once they have been calculated. For further infomration on how the files are written, see cass::pixeldetector::CommonData. Default is true.

PixelDetectors/%name%/CorrectionMaps/FixedOnlineCreatorCommonMode/{CommonModeCalculationType}
The type of commonmode calculation thats used to correct the common mode when trying to get rid of it. Default is "simpleMean". Possible values are:

Class cass::pixeldetector::PixelFinderSimple
PixelDetectors/%name%/SimpleFinder/{Threshold}
The threshold above which the pixels have to be. Default is 0.
Class cass::pixeldetector::PixelFinderSimpleMoreOptions

PixelDetectors/%name%/SimpleFinder/{SquareSize}
The size of the box.

PixelDetectors/%name%/SimpleFinder/{Threshold}
The threshold above which the pixels have to be. Default is 0.

Class cass::pixeldetector::SimpleCoalesce

PixelDetectors/%name%/SimpleCoalescing/{MaxPixelListSize}
Maximum size of the incomming pixel list that will be still treated by this functor. Default is 10000

PixelDetectors/%name%/SimpleCoalescing/{MipThreshold}
The threhold in ADU above which a pixel is regarded as part of a Ionizing Particle. Default is 1e6

PixelDetectors/%name%/SimpleCoalescing/{ShouldNotCheckCoalsescing}
Once a sublist of pixels that should be coalesced is found, usually the function checks whether it should be coalesced based on whether non of the sourrounding pixels is 0. This is bad when using this with detectors other than pnCCD. This flag when true will disable this check. Default is 'false'

PixelDetectors/%name%/SimpleCoalescing/{MaxRecursionDepth}
The maximum recursion depth whith which the recursive search for neighbouring pixels will be done. For details see cass::findNeighbours(). Default is 7

Class cass::pixeldetector::WithinRange

PixelDetectors/%name%/InRangeFinder/{LowerThreshold}
The threshold above which the pixels have to be. Default is 0.

PixelDetectors/%name%/InRangeFinder/{UpperThreshold}
The threshold above which the pixels have to be. Default is 1e6.

Class cass::pp1

Processor/%name%/{InputOne}
the processor name that contain the first result. Needs to be of the same dimension and size as the second.

Processor/%name%/{InputTwo}
the processor name that contain the second result. Needs to be of the same dimension and size as the first

Processor/%name%/{Operation}
Default is "+". Possible values are:

  • "+": Use add as operation
  • "-": Use minus as operation
  • "/": Use divide as operation
  • "*": Use multiply as operation
  • "AND": Use logical AND as operation
  • "OR": Use logical OR as operation
  • ">": Use greater as operation
  • ">=": Use greater or equal as operation
  • "<": Use less than as operation
  • "<=": Use less or equal as operation
  • "==": Use equal to as operation
  • "!=": Use not equal to as operation
Class cass::pp1002

Processor/%name%/{CompressLevel}
The compression level. Default is 2

Processor/%name%/{FileBaseName}
Base Name of the Files to be written. In case of writing mutiple Events to the same file an alpha counter will be added to the file name. In case of writing an event to a single file the event id Will be appended to the file name.

Processor/%name%/{WriteMultipleEventsInOneFile}
Flag to tell whether to write multiple events to the same file (true) or each event into a single file (false). Default is false.

Processor/%name%/{WriteToSingleDatasets}
In case one writes multiple events into the same file, this flag allows to tell, that the data will be written into a single dataset. The dataset will have an additional dimension in the slowest axis that holds the data of all the events. In addition to that a dataset is written that lists all the eventids of the events that are written. Default is false.

Processor/%name%/{MaximumNbrFilesPerDir}
In case of single files per event, distribute the files over subdirectories where each subdir contains this amount of files. If -1 it will not distribute the files. Default is -1.

Processor/%name%/{MaximumFileSize_GB}
In case of multiple events per file, this is the maximum file size before the alpha counter of the filename will be increased and a the events will be written to the new file. Default is 200

Processor/%name%/Processor/{size}
How many Processors should be written to the h5 file.

Processor/%name%/Processor/%id%/{Name}
Name of the Processor that should be written into the h5 file. Default is "unknown"

Processor/%name%/Processor/%id%/{GroupName}
Name of the group in the h5 file into which the Processor should be written into. Default is "/"

Processor/%name%/Processor/%id%/{ValName}
Name that the data should have in the h5 file. Default is the name of the Processor.

Processor/%name%/ProcessorSummary/{size}
How many Processors should be written to the h5 file.

Processor/%name%/ProcessorSummary/%id%/{Name}
Name of the Processor that should be written into the h5 file. Default is "unknown"

Processor/%name%/ProcessorSummary/%id%/{GroupName}
Name of the group in the h5 file into which the Processor should be written into. Default is "/"

Processor/%name%/ProcessorSummary/%id%/{ValName}
Name that the data should have in the h5 file. Default is the name of the Processor.

Class cass::pp105
Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.
Class cass::pp107

Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.

Processor/%name%/{MapType}
the type of the map that should be displayed. See cass::pixeldetector::CommonData for details. Default is "offset". Possible values are:

  • "offset": The offset map
  • "noise": The noise map
  • "gain_cte": The map containing cte and gain values
  • "correction": The map containing the correction values used for processing.
Class cass::pp109

Processor/%name%/{CASSID}
The CASS ID of the detector device that one wants to extract. One can set up which CASS ID the detector has in the converter part.

Processor/%name%/{nRows}
The number of rows of the device (only needed when value cannot be determined from the name of the Processor)

Processor/%name%/{nCols}
The number of columns of the device (only needed when value cannot be determined from the name of the Processor)

Class cass::pp110

Processor/%name%/{InstrumentId}
The instrument id of the acqiris instrument that contains the channel. Default is 8. Options are:

  • 8: Camp Acqiris
  • 4: AMO ITof Acqiris
  • 2: AMO GD Acqiris
  • 5: AMO Mbes Acqiris
  • 22: XPP Acqiris

Processor/%name%/{ChannelNbr}
The channel number of the acqiris instrument. Default is 0.

Processor/%name%/{NbrSamples}
Number of samples in the waveform. Default is 40000

Processor/%name%/{SampleInterval}
Sample Interval (Time between to samples in s. Default is 1e-9

Class cass::pp111

Processor/%name%/{Waveform}
The name of the Processor containing the waveform that should be converted. Default is 'Unknown'

Processor/%name%/{Delay_ns}
Delay in ns used. Default is 5.

Processor/%name%/{Fraction}
Fraction used. Default is 0.6

Processor/%name%/{Walk_V}
walk in V used. Default is 0.

Class cass::pp112

Processor/%name%/{Waveform}
The name of the Processor containing the waveform that should be converted. Default is 'Unknown'

Processor/%name%/{Delay}
Delay in units of the input x-axis is used. Default is 5.

Processor/%name%/{Fraction}
Fraction used. Default is 0.6

Processor/%name%/{Threshold}
threshold in units of the y-axis. Default is 0.1

Processor/%name%/{Walk}
walk in units of the y-axis. Default is 0.

Class cass::pp12

Processor/%name%/{Value}
The value of the processors 0d result Default is 0.

Processor/%name%/{ValueType}
The type of constant that will we returned. Default is '0D'. Possible values are:

  • '0D': A 0d result will be returned
  • '1D': A 1d array result will be returned
  • '2D': A 2d image result will be returned

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
Optional settings, needed when selected 1D or 2D as type

Class cass::pp120
Processor/%name%/{VariableName} The name of the beamline data variable you are interested in. Default is "". Available values are:
  • FEE Gas Detector values
    • f_11_ENRC
    • f_12_ENRC
    • f_21_ENRC
    • f_22_ENRC
  • E-Beam values
    • EbeamCharge
    • EbeamL3Energy
    • EbeamLTUAngX
    • EbeamLTUAngY
    • EbeamLTUPosX
    • EbeamLTUPosY
    • EbeamPkCurrBC1
    • EbeamPkEnergyBC1
    • EbeamPkCurrBC2
    • EbeamPkEnergyBC2
    • EbeamUndAngX
    • EbeamUndAngY
    • EbeamUndPosX
    • EbeamUndPosY
  • Phase Cavity values
    • Charge1
    • Charge2
    • FitTime1
    • FitTime2
  • Ipimb values
    • DetectorName_Channel0
    • DetectorName_Channel1
    • DetectorName_Channel2
    • DetectorName_Channel3
  • IpmFex values
    • DetectorName_CorrectChannel0
    • DetectorName_CorrectChannel1
    • DetectorName_CorrectChannel2
    • DetectorName_CorrectChannel3
    • DetectorName_sum
    • DetectorName_xPos
    • DetectorName_yPos
Class cass::pp121
Processor/%name%/{EventCode} The EventCode to check for. Default is 0
Class cass::pp122
Processor/%name%/{EventIDPart} The part of the event id that is of interest. The event id is a 64 bit value, but Processors can only return a float (32 bit) value. Therefore this allows to retrieve either the upper or lower 32 bit of the 64 bit variable. Default is 0, possible values are:
  • 0: Unambiguous. historically the default, don't use.
  • 1: the lower 32 bits of the id
  • 2: the upper 32 bits of the id.
    Author
    Lutz Foucar
Class cass::pp123

Processor/%name%/{SpectrometerName} The name of the spectrometer one is interested in. One needs to add either "_horiz" or "_vert" to the name to tell wether one wants to use the vertical or horizontal projection.

Processor/%name%/{Size} The size of the projection. Will defaulty be determined from the spectrometer name addition. If "horiz" its set to 1024, if its "vert" it is set to 256. Only set this when the default values are not working.

Class cass::pp13
Processor/%name%/{InputName}
the processor name that contain the input result to be copied
Class cass::pp130
Processor/%name%/{VariableName} The name of the epics data variable you are interested in. Default is "". If the EPICS variable is not part of the standart list, but contained in an additional list, you have to prepend the additional lists name to the epics variable. For a complete list of available variables, please look into the casslog, when the logging level is set to INFO
Class cass::pp14

Processor/%name%/{InputOne}
Name of the result that should be returned when condition is true. Needs to have the same dimension as InputTwo.

Processor/%name%/{InputTwo}
Name of the result that should be returned when condition is false. Needs to have the same dimension as InputOne.

Class cass::pp144

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.

Processor/%name%/{SpectralLowerLimit|SpectralUpperLimit}
The range of the z value of the pixel. Only when the pixel is in this range the pixel will be drawn. Default is 0.0|0.0

Processor/%name%/{SplitLevelUpperLimit|SplitLevelLowerLimit}
The range of the Splitlevel of the photon hit. Splitlevel tells how many pixels contributed to the photonhit. Both limits are exclusive. IE: to only see a splitlevel of 1 (single pixel contributed to the photon hit) lower limit needs to be 0 and upper limit needs to be 2. Default is 0|2

Processor/%name%/{PixelvalueAsWeight}
When filling the 2D histogram one can select whether for each hit the z value should be added on the coordinate or a constant. If true the z value will be used. If false the coordinate will be increased by 1. Default is true.

Processor/%name%/{BaseValue}
Value of the pixels that are not set. Default is 0

Class cass::pp145
Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.
Class cass::pp146

Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.

Processor/%name%/{XNbrBins|XLow|Xup}
properties of the 1D histogram:

Class cass::pp148

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelper for infos how to set up that detector.

Processor/%name%/{SpectralLowerLimit|SpectralUpperLimit}
The range of the z value of the pixel. Only when the pixel is in this range the pixel will be drawn. Default is 0.0|0.0

Processor/%name%/{PixelvalueAsWeight}
When filling the 2D histogram one can select whether for each hit the z value should be added on the coordinate or a constant. If true the z value will be used. If false the coordinate will be increased by 1. Default is true.

Processor/%name%/{BaseValue}
Value of the pixels that are not set. Default is 0

Class cass::pp149
Processor/%name%/{Detector}
Name of the Detector that one is interested in. Default "blubb" See cass::pixeldetector::DetectorHelperHelper for infos how to set up that detector.
Class cass::pp15

Processor/%name%/{InputName}
The Processor name that contain the 0D result that should be monitored.

Processor/%name%/{Difference}
The maximum allowed difference between the previous and the current value of the 0D result. Default is 0 which results in a value given by std::numeric_limits<float>::epsilon().

Class cass::pp150
Processor/%name%/{Detector}
Name of the detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.
Class cass::pp1500

Processor/%name%/{Name}
processor name containing the histogram that write to cbf. If not set then no cbf file will be written when condition is true

Processor/%name%/{SummaryName}
processor name containing Histogram to be written as summary to cbf. If not set then no summary will be written

Processor/%name%/{FileBaseName}
Default name given by program parameter

Processor/%name%/{MaximumNbrFilesPerDir}
Distribute the files over subdirectories where each subdir contains this amount of files. If -1 it will not distribute the files. Default is -1.

Class cass::pp151

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the 1d histogram

Processor/%name%/{Detector}
Name of the detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Class cass::pp152

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Class cass::pp153
Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.
Class cass::pp160

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Layer}
The anode layer. Default is U. Options are:

  • for HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • for Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{Wireend}
    The anode layer Wireend. Default is 1. Options are:

  • 1: first wireend
  • 2: second wireend
Class cass::pp1600
Processor/%name%/{ImageName}
the processor name that contains the histogram containing the cspad image in cass layout. Default is "".
Class cass::pp1601
Processor/%name%/{ImageName}
the processor name that contains the histogram containing the cspad image in cass layout. Default is "".
Class cass::pp1602

Processor/%name%/{ImageName}
the processor name that contains the histogram containing the cspad image in cass layout. Default is "".

Processor/%name%/{GeometryFilename}

Processor/%name%/{ConvertCheetahToCASSLayout}

Processor/%name%/{BackgroundValue}

Class cass::pp161

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Layer}
The anode layer. Default is U. Options are:

  • for HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • for Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{Wireend}
    The anode layer Wireend. Default is 1. Options are:

  • 1: first wireend
  • 2: second wireend
Class cass::pp162

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Layer}
The anode layer. Default is U. Options are:

  • if detector type is HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • if detector type is Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{TimeRangeLow|TimeRangeHigh}
    The time range in which we will take the first hits on the wireends and the mcp signal to calculate the timesum. This should be a timerange in which mostly single detectorhits are to be expected. Default is 0 | 20000.

Class cass::pp163

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Layer}
The anode layer. Default is U. Options are:

  • if detector type is HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • if detector type is Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{TimeRangeLow|TimeRangeHigh}
    The time range in which we will take the first hits on the wireends and the mcp signal to calculate the timesum. This should be a timerange in which mostly single detectorhits are to be expected. Default is 0 | 20000.

Class cass::pp164

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{FirstLayer}
The anode layer of the first coordinate. Default is U. Options are:

  • for HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • for Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{SecondLayer}
    The anode layer of the second coordinate. Default is U. Options are:

  • for HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • for Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{TimesumFirstLayerLow|TimesumFirstLayerHigh}
    The Timesumcondition range for the first layer. Default is 20 | 200.

    Processor/%name%/{TimesumSecondLayerLow|TimesumSecondLayerHigh}
    The Timesumcondition range for the Second layer. Default is 20 | 200.

    Processor/%name%/{TimeRangeLow|TimeRangeHigh}
    The time range in which we will take the first hits on the wireends and the mcp signal to calculate the timesum. This should be a timerange in which mostly single detectorhits are to be expected. Default is 0 | 20000.

Class cass::pp165
Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.
Class cass::pp166

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{XInput}
The value that should be put onto the x-axis of the histogram. Default is 0. For all options see ACQIRIS::detectorHits

Processor/%name%/{YInput}
The value that should be put onto the x-axis of the histogram. Default is 1. For all options see ACQIRIS::detectorHits

Processor/%name%/{ConditionInput}
The value that should be checked for the range before filling the histogram. Default is 2. For all options see ACQIRIS::detectorHits

Processor/%name%/{ConditionLow|ConditionHigh}
the condition range that should be applied to the condition input

Class cass::pp167

Processor/%name%/{Detector}
Name of the delayline detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Layer}
The anode layer. Default is U. Options are:

  • for HexDetector
    • U: U-Layer
    • V: V-Layer
    • W: W-Layer
  • for Quad Detector

    • X: X-Layer
    • Y: Y-Layer

    Processor/%name%/{Wireend}
    The anode layer Wireend. Default is 1. Options are:

  • 1: first wireend
  • 2: second wireend
Class cass::pp2

Processor/%name%/{InputName}
the processor name that contains the result to operate on. Needs to be implemented, because default is "Unknown", which is invalid.

Processor/%name%/{Value}
Either the constant value for the operation or a 0D Processor containing the value for the operation. Default is 1

Processor/%name%/{Operation}
Default is "+". Possible values are:

  • "+": Use add as operation
  • "-": Use minus as operation
  • "/": Use divide as operation
  • "*": Use multiply as operation
  • "AND": Use logical AND as operation
  • "OR": Use logical OR as operation
  • ">": Use greater as operation
  • ">=": Use greater or equal as operation
  • "<": Use less than as operation
  • "<=": Use less or equal as operation
  • "==": Use equal to as operation
  • "!=": Use not equal to as operation

Processor/%name%/{ValuePos}
Chooses where in the operation the Value or the value taken from the 0D Processor will be. Default is "first". Possible values are:

  • first: Value will be first operand
  • second: Value will be second operand
Class cass::pp200

Processor/%name%/{ImageName}
The name of the Processor that contains the image to calculate $\cos^2\theta$ from. Default is 104.

Processor/%name%/{ImageXCenter|ImageYCenter}
values for the center of the image. Default is 0,0

Processor/p%name%/{SymmetryAngle}
value for the symmetry angle. Default is 0.

Processor/%name%/{MaxIncludedRadius|MinIncludedRadius}
values for the interesting radius range. Default is 0,0

Class cass::pp2000

Processor/%name%/{FileName}
The name of the output root file. Default is "output.root"

Processor/%name%/Processor/{size}
How many Processors should be written to the root file.

Processor/%name%/Processor/%id%/{Name}
Name of the Processor that should be written into the root file. Default is "unknown"

Processor/%name%/Processor/%id%/{GroupName}
Name of the group in the h5 file into which the Processor should be written into. Default is "/". Note that the eventid will be prepended to the Name given here.

Processor/%name%/Processor/%id%/{ValName}
Name that the data should have in the root file. Default is the name of the Processor.

Processor/%name%/ProcessorSummary/size
How many Processors should be written to the root file.

Processor/%name%/ProcessorSummary/%id%/{Name}
Name of the Processor that should be written into the root file. Default is "unknown"

Processor/%name%/ProcessorSummary/%id%/{GroupName}
Name of the group in the root file into which the Processor should be written into. Default is "/"

Processor/%name%/ProcessorSummary/%id%/{ValName}
Name that the data should have in the root file. Default is the name of the Processor.

Class cass::pp2001

Processor/%name%/{Detectors}
comma separated list of Delaylinedetectors who's hits should be added to the tree.

Processor/%name%/{Particles}
comma separated list of Particles who's hits should be added to the tree. The corrosponding detector does not need to be added above since this processor will find out what detector a particle belongs to automatically.

Processor/%name%/{Processors}
comma separated list of 0d Processors who's values should be added to the tree.

Processor/%name%/{MachineData}
Flag whether to add the Beamline and Epics data to the tree. Default is false.

Processor/%name%/{EventStatus}
Flag whether to add the EventStatus array data to the tree. Default is false.

Class cass::pp201

Processor/%name%/{ImageName}
The name of the Processor that contains the image that the angluar distribution should be retrieved from.

Processor/%name%/{ImageXCenter|ImageYCenter}
values for the center of the image. Default is 500,500

Processor/%name%/{MaxIncludedRadius|MinIncludedRadius}
values for the interesting radius range. Default is 10,0

Processor/%name%/{NbrAngularPoints}
The number of Bins in the resulting histogram

Class cass::pp202

Processor/%name%/{ImageName}
The name of the Processor that contains the image that the angluar distribution should be retrieved from.

Processor/%name%/{ImageXCenter|ImageYCenter}
values for the center of the image. Default is 500,500

Processor/%name%/{NbrAngularPoints}
The number of Bins along the phi axis in the resulting histogram. Default is 360.

Processor/%name%/{NbrRadialPoints}
The number of Bins along the r axis in the resulting histogram. Default is 500.

Class cass::pp203

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{SectionSizeX|SectionSizeY}
Size of the subsection of the image. Default is 1024|512.

Processor/%name%/{BoxSizeX|BoxSizeY}
size in x and y of the box that is used for determining the median background. Default is 10|10.

Class cass::pp204

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{SectionSizeX|SectionSizeY}
Size of the subsection of the image. Default is 1024|512.

Processor/%name%/{BoxSizeX|BoxSizeY}
size in x and y of the box that is used for determining the median background. Default is 10|10.

Processor/%name%/{Threshold}

Processor/%name%/{MinSignalToNoiseRatio}

Processor/%name%/{MinNbrBackgrndPixels}

Processor/%name%/{BraggPeakRadius}

Class cass::pp205

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{TableName}
name of processor that contains the table like histogram that the pixels of interest are taken from

Processor/%name%/{BoxSizeX|BoxSizeY}
size in x and y of the box that should be drawn around the found peak

Processor/%name%/{DrawPixelValue}
The value of the border pixels

Processor/%name%/{DrawInnerPixel}
flag to tell whether the inner pixel values should be overwritten

Processor/%name%/{InnerPixelValue}
The value of the inner pixels.

Processor/%name%/{Radius}

Processor/%name%/{IndexColumn}

Processor/%name%/{DrawCircle}

Processor/%name%/{DrawBox}

Class cass::pp206

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{SectionSizeX|SectionSizeY}
Size of the subsection of the image. Default is 1024|512.

Processor/%name%/{BoxSizeX|BoxSizeY}
size in x and y of the box that is used for determining the median background. Default is 10|10.

Processor/%name%/{Threshold}

Processor/%name%/{Multiplier}

Class cass::pp208

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{SectionSizeX|SectionSizeY}
Size of the subsection of the image. Default is 1024|512.

Processor/%name%/{BraggPeakDiameter}
Minimum Diameter of a Bragg Peak. Used for determining the optimal box size and nbr of pixels in the Bragg Peak. Default is 2.

Processor/%name%/{MinRatio}
The minimum ratio of pixel that are outliers of the distribution in the box to the pixels that are part of the distribution in the box. 3 mean that there have to be at least 3 times as meany pixels that are part of the distribution than outliers of the distribution. Default is 3.

Processor/%name%/{Threshold}
Threshold of pixel in adu to be exeeded. Can also be the name of a Processor that contains the Threshold value.

Processor/%name%/{MinSignalToNoiseRatio}
Signal to noise ratio of a pixel. Value needs to be exceeded in order for the pixel to be part of a bragg peak. Default is 4.

Processor/%name%/{MinNbrPixels}
Minimum Nbr of Pixels to be part of a Bragg Peak. Default is determined by BraggPeakRadius. $ nbr = (2 \times BraggPeakRadius)^2 $

Processor/%name%/{BoxSizeX|BoxSizeY}
col (x) and rows (y) of the box that is used for determining the background. The box is going from -BoxSizeX ... BoxSizeX in x and same in y. Default is determined by the BraggPeakRadius. $ size = \sqrt{\pi} \times BraggPeakRadius $

Processor/%name%/{GeometryFilename}
The geom file to use. Default is "wrong_file" in which case the resolution will be calculated completely wrong

Processor/%name%/{ConvertCheetahToCASSLayout}
Set this true if the geom file is for a cheetah layout of the data, but the image in ImageName is the image in CASS layout.

Processor/%name%/{Wavelength_A}
The wavelength in Angstroem. Can also be the name of a Processor that contains the Wavelength. Default is 1.

Processor/%name%/{DetectorDistance_m}
The detector distance in m. Can also be the name of a Processor that contains the detector distance. Default is 60e-2.

Processor/%name%/{PixelSize_m}
The pixel size in m. Default is 109.92-6

Class cass::pp209

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "Unknown".

Processor/%name%/{Threshold}
name of the processor that contains the pixelwise thresholds. Must be the same dimension as the image.

Processor/%name%/{Factor}
Factor to multiply the pixelwise threshold with, so that one can use a noise map as a threshold. Default is 1.

Class cass::pp220

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{FirstDetector}
Name of the first detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{SecondDetector}
Name of the first detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Class cass::pp240

Processor/%name%/{sizeX}
Width of testimage (default = 1024)

Processor/%name%/{sizeY}
Height of testimage (default = 1024)

Processor/%name%/{FixedValue}
Use a fixed value instead of the product of the column and row index. Default is false

Processor/%name%/{Value}
In case FixedValue is true, this is the value that the image will be filled with. Default is 0

Processor/%name%/Mask/{size}
The number of mask elements that are part of the complete mask. Default is 0.

Processor/%name%/Mask/%index%/{Type}
Name of the mask element. Default is "Unknown", which let the code ignore that element. Possible values are:

Member cass::pp240::circle (result_t &data, CASSSettings &s)

Processor/%name%/Mask/%index%/{CenterX|CenterY}
The center of the circle. Default is 500|500.

Processor/%name%/Mask/%index%/{Radius}
The radius of the circle. Default is 2.

Processor/%name%/Mask/%index%/{Value}
The value that will be set to all the pixels within the mask. Default is 1

Member cass::pp240::ellipse (result_t &data, CASSSettings &s)

Processor/%name%/Mask/%index%/{CenterX|CenterY}
The central point of the ellipse. Default is 500|500.

Processor/%name%/Mask/%index%/{SemiAxisX|SemiAxisY}
The semi axis along x and y of the ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 5|4.

Processor/%name%/Mask/%index%/{Value}
The value that will be set to all the pixels within the mask. Default is 1

Member cass::pp240::ring (result_t &data, CASSSettings &s)

Processor/%name%/Mask/%index%/{InnerCenterX|InnerCenterY}
The central point of the inner ellipse. Default is 500|500.

Processor/%name%/Mask/%index%/{InnerSemiAxisX|InnerSemiAxisY}
The semi axis along x and y of the inner ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 5|4.

Processor/%name%/Mask/%index%/{OuterCenterX|OuterCenterY}
The central point of the outer ellipse. Default is 500|500.

Processor/%name%/Mask/%index%/{OuterSemiAxisX|OuterSemiAxisY}
The semi axis along x and y of the outer ellipse. By definition the longer one defines the major axis and the smaller on the minor axis. Default is 20|20.

Processor/%name%/Mask/%index%/{Value}
The value that will be set to all the pixels within the mask. Default is 1

Member cass::pp240::square (result_t &data, CASSSettings &s)

Processor/%name%/Mask/%index%/{LowerLeftX|LowerLeftY}
The lower left pixel of the square element. The indizes given are included in the square. Default is 0|0.

Processor/%name%/Mask/%index%/{UpperRightX|UpperRightY}
The upper right pixel of the square element. The indizes given are included in the square. Default is 1023|1023.

Processor/%name%/Mask/%index%/{Value}
The value that will be set to all the pixels within the mask. Default is 1

Member cass::pp240::triangle (result_t &data, CASSSettings &s)

Processor/%name%/Mask/%index%/{PointA_X|PointA_Y}
The triangles first point. Default is 500|500.

Processor/%name%/Mask/%index%/{PointB_X|PointB_Y}
The triangles first point. Default is 500|500.

Processor/%name%/Mask/%index%/{PointC_X|PointC_Y}
The triangles first point. Default is 500|500.

Processor/%name%/Mask/%index%/{Value}
The value that will be set to all the pixels within the mask. Default is 1

Class cass::pp241

Processor/%name%/{ImageName}
Name of Processor containing the distorted pnCCD image. Default is "".

Processor/%name%/{ThresholdQuadrantA}
Threshold for the rows of quadrant A. If the averaged value is below this value the whole row of this quadrant is changed. Default is 0.

Processor/%name%/{ThresholdQuadrantB}
Threshold for the rows of quadrant B. If the averaged value is below this value the whole row of this quadrant is changed. Default is 0.

Processor/%name%/{ThresholdQuadrantC}
Threshold for the rows of quadrant A. If the averaged value is below this value the whole row of this quadrant is changed. Default is 0.

Processor/%name%/{ThresholdQuadrantD}
Threshold for the rows of quadrant D. If the averaged value is below this value the whole row of this quadrant is changed. Default is 0.

Processor/%name%/{WeightAdjecentRow}
How much will the row that is adjecent to the current row be weightd when calculating the average offset at the edge of the detector. Default is 0.75.

Processor/%name%/{WeightSecondNextRow}
How much will the row that is the next over to the current row be weightd when calculating the average offset at the edge of the detector. Default is 0.5.

Processor/%name%/{MinimumRow}
Define from which row the correction should be applied. Default is 0.

Processor/%name%/{MaximumRow}
Define to which row the correction should be applied. Default is 1024.

Class cass::pp242

Processor/%name%/{Detector}
Name of the Detector who's values should be masked

Processor/%name%/{Value}
Value that should be assigned to pixels that should be masked Default is 0.

Class cass::pp243

Processor/%name%/{ImageName}
Name of the Histogram that should be masked

Processor/%name%/{MaskName}
The name of the Mask.

Processor/%name%/{Value}
Value that should be assigned to pixels that should be masked Default is 0.

Class cass::pp244

Processor/%name%/{ImageName}
Name of the Image whos pixels should be histogrammed

Processor/%name%/{XNbrBins|XLow|XUp|XTitle}
properties of the 1D histogram generated for each Pixel.

Processor/%name%/{Weight}
The value that will be added to the histogram. Default is 1

Processor/%name%/{MaskVal}
The value that the masked pixels have in the image. Masked pixels will not be added to the histogram. Default is 0

Processor/%name%/{IsPnCCD}
Combine the columns of the pnCCD to lower the memory used. Default is false. In case of pnCCD the channels of the quadrants will be displayed in rows 0 to 2047 and the rows, which indicate the cte will be dispyed in rows 2048 to 2559

Class cass::pp250

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the 1d histogram

Processor/%name%/{Detector}
Name of the first detector that we work on. Default is "blubb"

Processor/%name%/{Particle}
Name of the particle whos properties we want to extract Default is "NeP"

Processor/%name%/{Property}
Name of the particles first property we want to extract Default is 0. Available Properties see ACQIRIS::particleHits

Class cass::pp251

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the detector that the particles belong to. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Particle}
Name of the particle whos properties we want to extract Default is "NeP"

Processor/%name%/{FirstProperty}
Name of the particles first property we want to extract Default is 0. Available Properties see ACQIRIS::particleHits

Processor/%name%/{SecondProperty}
Name of the particles second property we want to extract Default is 1 Available Properties see ACQIRIS::particleHits

Class cass::pp252

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the 1d histogram

Processor/%name%/{Detector}
Name of the first detector that we work on. Default is "blubb" See cass::ACQIRIS::HelperAcqirisDetectors as starting point for more information on how to set up the different types of Acqiris type detectors.

Processor/%name%/{Particle}
Name of the particle whos properties we want to extract Default is "NeP"

Class cass::pp300

Processor/%name%/{ImageName}
processor name containing the histogram in which hits should be detected.

Processor/%name%/{xstart}
ROI for calculations. First pixel = 0 (default).

Processor/%name%/{ystart}
ROI for calculations. First pixel = 0 (default).

Processor/%name%/{xend}
ROI for calculations. Last pixel = -1 (default).

Processor/%name%/{yend}
ROI for calculations. Last pixel = -1 (default).

Processor/%name%/{TrainingSetSize}
How many images should be included in training phase. default = 200.

Processor/%name%/{saveTraining}
optional. If true (default), save Training matrices to files with automaic names in currend directory.

Processor/%name%/{readTrainingFile}
optional filename to read training matrices from. If setting doesn't exist, training is not read but calculated on "loadSettings".

Class cass::pp301

Processor/%name%/{InputName}
the processor name that contain the first histogram. Default is 0.

Processor/%name%/{MedianSize}
how many last values should be included in median calculation. default is 100.

Class cass::pp302

Processor/%name%/{BinaryFile}
Filename of binary float[sizeX*sizeY] file which contains data. Default is "".

Processor/%name%/{SizeX}
nr of Pixels for x axis. Default is 0.

Processor/%name%/{SizeY}
nr of Pixels for y axis. Default is 0.

Class cass::pp310
Processor/%name%/{ImageName}
processor name containing the histogram whos autocorrelation should be calculated. The radius should be along the y-axis and the phi should be along the x-axis.
Class cass::pp311

Processor/%name%/{CenterX|CenterY}

Processor/%name%/{MaximumRadius}

Processor/%name%/{ImageName}
processor name containing the histogram whos autocorrelation should be calculated.

Class cass::pp312
Processor/%name%/{InputName}
processor name containing the histogram whos fft should be calculated.
Class cass::pp313

Processor/%name%/{InputName}
histogram name, that should be convoluted

Processor/%name%/{Kernel}
Comma separated list of values for the Kernel that should be convoluted to the histogram

Class cass::pp330

Processor/%name%/{RawImage}
the raw image of the pixel detector

Processor/%name%/{OutputFilename}
the name of the file where the calibration will be written to. Default is "NotSet", in which case a filename will be automatically generated from the time and name of the Processor and a link to the autogenerated file name will be created which has the same name but without the time.

Processor/%name%/{WriteCal}
Flag to tell whether the calibration should be written. Default is true.

Processor/%name%/{Train}
Flag to tell whether training should be done. Default is true

Processor/%name%/{NbrTrainingImages}
The Number of images used for the training. Default is 200

Processor/%name%/{SNR}
The signal to noise value that indicates whether a pixel is an outlier of the distribution of pixels in the trainingset and should not be considered. Default is 4.

Processor/%name%/{SNRNoiseAutoBoundaries}
The signal to noise ratio for determining the boundary values of bad pixels from the noise map. If this value is negative the manual set values will be taken from the values below. Otherwise the mean value and the standart deviation of all noise values will be calculated and boundaries are set to $ bound_{upper} = mean + (SNRNoiseAutoBoundaries * stdv) $ $ bound_{lower} = mean - (SNRNoiseAutoBoundaries * stdv) $ Default is 4.

Processor/%name%/{SNRNoiseAutoBoundariesStat}
In case of using auto generation of the boundaries this signal to \ noise ratio determines which values will be taken when calculating the mean and stdv of the distribution. Default is 4.

Processor/%name%/{NoiseLowerBoundary|NoiseUpperBoundary}
In case the SNRNoiseAutoBoundaries is negative these values will be taken to determine the bad pixels from the noise map. Default is 0|3.

Processor/%name%/{SNROffsetAutoBoundaries}
The signal to noise ratio for determining the boundary values of bad pixels from the offset map. If this value is negative the manual set values will be taken from the values below. Otherwise the mean value and the standart deviation of all noise values will be calculated and boundaries are set to $ bound_{upper} = mean + (SNROffsetAutoBoundaries * stdv) $ $ bound_{lower} = mean - (SNROffsetAutoBoundaries * stdv) $ Default is -1.

Processor/%name%/{SNROffsetAutoBoundariesStat}
In case of using auto generation of the boundaries this signal to \ noise ratio determines which values will be taken when calculating the mean and stdv of the distribution. Default is 4.

Processor/%name%/{OffsetLowerBoundary|OffsetUpperBoundary}
In case the SNROffsetAutoBoundaries is negative these values will be taken to determine the bad pixels from the offset map. Default is -1e20|1e20.

Processor/%name%/{MinNbrPixels}
The minimum amount of pixels of the trainingset that are required for the individual pixel. The value is given in percent of the total amount of pixels available. If the amount is lower than this value, the pixel will be marked as bad. Default is 90

Processor/%name%/{InputFilename}
The input filname of the calibration file. If it is "NotSet" it assumes a filename of "\%name\%.lnk" and tries to find the link target. If it can't find it, it will skip loading of the calibration file. This also happens if another filename is given, but the file can't be opened or the size of the images in the file and the Rawimages differ. Program execution won't be stopped only an error is written into the log file. Default is "NotSet"

Processor/%name%/{ResetBadPixels}
When set to true, it will reset a bad pixel to good if the pixel is within the checks for beeing good (with in the Noise range and enough good values). Default is false, which keeps it marked as bad.

Processor/%name%/{UpdateCalibration}
Flag to tell whether after the training has completed that the calibration should be updated with more images. Default is true.

Processor/%name%/{UpdateCalibrationType}
The type of update used. Default value is "cummulative". Possible values are:

  • "cummulative": A cummulative update
  • "moving": A exponential moving update

Processor/%name%/{NbrOfImages}
In case of using the moving update type, this tells how many images should be considered in the exponential moving average and standart deviation estimation.

Processor/%name%/{UpdateBadPixPeriod}
After how many received images should the bad pixel map be updated If negative, no updates will be made. Default is -1.

Processor/%name%/{WritePeriod}
When automagically updating the dark, this gives the time in seconds between two writings of the darkcalibration file. Note that a manual call to the training will force writing even though the time between two writes has not ellapsed. Default is 0, which causes no auto writing

Class cass::pp331

Processor/%name%/{Image}
the image of the pixel detector

Processor/%name%/{Filename}
the name of the file where the calibration will be written to. Default is out.cal

Processor/%name%/{WriteCal}
Flag to tell whether the calibration should be written. Default is true.

Processor/%name%/{ADURangeLow|ADURangeHigh}
The adu range that indicates that one photon has hit the pixel. Default is 0|0

Processor/%name%/{MinimumNbrPhotons}
The minimum number of photons that a pixel should have seen before the gain is calulated for this pixel. Default is 200

Processor/%name%/{DefaultGainValue}
The gain value that will be assinged to the pixels that haven't seen enough photons. Default is 1.

Processor/%name%/{NbrOfFrames}
The number of frames after which the gain map will be calculated. Default is -1, which sais that it will never be calulated during running and only when the program ends.

Processor/%name%/{IsPnCCDNoCTE}
If the detector is a pnCCD and one doesn't want to correct for the CTE this option will calcultate the gain for a column of a quadrant of the detector. Default is false

Class cass::pp332

Processor/%name%/{Image}
the image of the pixel detector

Processor/%name%/{Filename}
the name of the file where the calibration will be written to. Default is out.cal

Processor/%name%/{WriteCal}
Flag to tell whether the calibration should be written. Default is true.

Processor/%name%/{ADURangeLow|ADURangeUp}
The adu range that indicates that one photon has hit the pixel. Default is 0|0

Processor/%name%/{MaximumConsecutiveFrames}
The maximum number of frames that a pixel should have an adu value in the range before the pixel is mased as hot. Default is 5

Processor/%name%/{MaxADUValue}
If a pixel ever exceeds this value it will be masked as bad. Default is 1e6

Processor/%name%/{NbrOfFrames}
The number of frames after which the gain map will be calculated. Default is -1, which sais that it will never be calulated during running and only when the program ends.

Class cass::pp333

Processor/%name%/{Image}
the image of the pixel detector

Processor/%name%/{Width}
The width of the subpart of the detector for which the common mode level needs to be calculated.

Processor/%name%/{CalculationType}
The type of calculation used to calculate the common mode level. Default is "mean". Possible values are:

  • "mean": Iterative retrieval of the mean value of distribution of pixels. In each iteration the outliers of the distribution are remove from the distribution.
  • "median": Calculates the mean of the distribution of pixels.

Processor/%name%/{SNR}
In case of using the mean calculator the signal to noise ratio is indicating which values to remove from the distribution before recalculating the mean. Default is 4

Class cass::pp334

Processor/%name%/{Image}
the image of the pixel detector

Processor/%name%/{Width}
when using the histogram option this is the width of the 0 photons peak that the CsPAD typically has. Default is 30

Processor/%name%/{MaxDistance}
How much should the histogram value differ at the most from the unbonded pixel value, before the value of the unbonded pixel is taken. Default is 5

Processor/%name%/{EnableChecks}
Switch that allows to enable checks by outputting the histograms, and the found maxima. Default is false.

Class cass::pp4
Processor/%name%/{InputName}
the processor name that contains the result to invert
Class cass::pp40

Processor/%name%/{InputName}
processor name with result that should be thresholded. Default is 0.

Processor/%name%/{Threshold}
Either an result or a constant value with which the input result will be thresholded.

Processor/%name%/{UserVal}
The value that will be set when the input value is below the threshold. Default is 0.

Class cass::pp400

Processor/%name%/{TofLow|TofUp}
The time of flight range within the histogram to convert to energy. Default is 0|1.

Processor/%name%/{t0}
corrects the time of flight Default is 0.

Processor/%name%/{e0}
Retard voltage Default is 0.

Processor/%name%/{alpha}
Coefficient for converting to energy. Default is 0.

Processor/%name%/{NbrBins}
number of bins in converted histogram. Default is 0.

Processor/%name%/{tb1}
The lower limit in x for calculating the baseline. Default is 0.

Processor/%name%/{tb2}
The upper limit in x for calculating the baseline. Default is 0.

Processor/%name%/{TofName}
input 1D histogram that contains the time of flight wavetrace.

Class cass::pp404

Processor/%name%/{TofLow|TofLow}
The time of flight range within the histogram to convert to mass. to charge ratio Default is 0|1.

Processor/%name%/{t0}
a time of flight of ion that we choosed. Default is 0.

Processor/%name%/{t1}
another time of flight of ion that we choosed. Default is 0.

Processor/%name%/{MtC0}
mass to charge ratio of t0. Default is 0.

Processor/%name%/{MtC1}
mass to charge ratio of t1. Default is 0.

Processor/%name%/{tb1}
The lower limit for calculating baseline. Default is 0.

Processor/%name%/{tb2}
The upper limit for calculating baseline. Default is 0.

Processor/%name%/{NbrBins}
number of bins in converted histogram. Default is 0.

Class cass::pp406

Processor/%name%/{TofLow|TofUp}
The time of flight range within the histogram to convert to energy. Default is 0|1.

Processor/%name%/{t0}
corrects the time of flight. Default is 0.

Processor/%name%/{e0}
Retardation voltage. Default is 0.

Processor/%name%/{alpha}
Coefficient for converting to energy. Default is 0.

Processor/%name%/{NbrBins}
number of bins in converted histogram. Default is 0.

Processor/%name%/{tb1}
The lower limit for calculating baseline. Default is 0.

Processor/%name%/{tb2}
The upper limit for calculating baseline. Default is 0.

Processor/%name%/{TofName}
input 1D histogram that is the time of flight wavetrace.

Processor/%name%/{HistZeroD}
input 0D histogram for enegy correction.

Class cass::pp407

Processor/%name%/{TofLow|TofUp}
The time of flight range within the histogram to convert to energy. Default is 0|1.

Processor/%name%/{t0}
corrects the time of flight. Default is 0.

Processor/%name%/{e0}
Retardation voltage. Default is 0.

Processor/%name%/{alpha}
Coefficient for converting to energy. Default is 0.

Processor/%name%/{NbrBins}
number of bins in converted histogram. Default is 0.

Processor/%name%/{tb1}
The lower limit for calculating baseline. Default is 0.

Processor/%name%/{tb2}
The upper limit for calculating baseline. Default is 0.

Processor/%name%/{TofName}
input 1D histogram that is the time of flight wavetrace.

Processor/%name%/{HistZeroD}
input 0D histogram for enegy correction.

Class cass::pp408

Processor/%name%/{TofLow|TofUp}
The time of flight range within the histogram to convert to energy. Default is 0|1.

Processor/%name%/{t0}
corrects the time of flight. Default is 0.

Processor/%name%/{e0}
Retardation voltage. Default is 0.

Processor/%name%/{alpha}
Coefficient for converting to energy. Default is 0.

Processor/%name%/{NbrBins}
number of bins in converted histogram. Default is 0.

Processor/%name%/{tb1}
The lower limit for calculating baseline. Default is 0.

Processor/%name%/{tb2}
The upper limit for calculating baseline. Default is 0.

Processor/%name%/{TofName}
input 1D histogram that is the time of flight wavetrace.

Processor/%name%/{HistZeroD}
input 0D histogram for enegy correction.

Class cass::pp41

Processor/%name%/{InputName}
processor name with result that should be thresholded. Default is Unknown.

Processor/%name%/{ThresholdName}
Processor that will be used to threshold the Input Default is Unknown.

Processor/%name%/{UserVal}
The value that will be set when the value of the corresponding bin is within the boundaries. Default is 0

Processor/%name%/{LowerLimit|UpperLimit}
The boundaries within which the value of the ThresholdName has to be in order to set the value of the result to UserVal. Default is 0.5|1.5. Both Limits are exclusive.

Class cass::pp410

Processor/%name%/{InputName}
input 1D histogram that we calculate covariance map.

Processor/%name%/{AveInputName}
averaged histogram of "InputName"

Class cass::pp412

Processor/%name%/{TofName}
input 1D histogram that is the time of flight wavetrace.

Processor/%name%/{AveTofName}
input 1D averaged histogram that is the time of flight wavetrace.

Processor/%name%/{IntensityName}
input 1D histogram that is intensity.

Processor/%name%/{AveIntensityName}
input 0D averaged histogram that is intensity.

Class cass::pp50

Processor/%name%/{InputName}
Name of the processor containing the 2D result that will be projected

Processor/%name%/{Low|Up}
Upper and lower bound of the area to project. The endpoints are defined like $ [Low,Up[ $. Default is -1e6|1e6

Processor/%name%/{Axis}
The axis we want to project to. Default is "xAxis". Possible choises are:

  • "xAxis": projects the selected range in y to the x-Axis
  • "yAxis": projects the selected range in x to the y-Axis
Class cass::pp500

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{IndexColumn}
The index of the column in the table that provides which point of the input result will be put into the new column Default is "0".

Class cass::pp5000

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the 1d histogram

Processor/%name%/{Detector}
Name of the first detector that we work on. Default is "blubb"

Processor/%name%/{Particle}
Name of the particle whose momentum we want to convert to electron energy in eV

Class cass::pp5001

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d histogram

Processor/%name%/{Detector}
Name of the first detector that we work on. Default is "blubb"

Class cass::pp51

Processor/%name%/{InputName}
processor name with 1D-result that we create the intgral from. Default is Unknown.

Processor/%name%/{XLow|XUp}
Upper and lower bound of the area to integrate. The endpoints are defined like $ [XLow,Xup[ $. Default is -1e6 ... 1e6

Processor/%name%/{BaselineXLow|BaselineXUp}
Upper and lower bound of the area that determines the baseline for the integration. If these values are not set, then a baseline of 0 is taken. The endpoints are defined like $ [XLow,Xup[ $. Default is -1e6 ... 1e6

Class cass::pp55

Processor/%name%/{ImageName}
the processor name that contain the first histogram. Default is "".

Processor/%name%/{Operation}
the operation that one wants to perform on the 2d histogram. Default is "90DegCCW". Possible values are:

  • "90DegCCW" or "270DegCW": rotate the 2d hist by 90 deg counter clock wise bzw. 270 deg clock wise
  • "270DegCCW" or "90DegCW": rotate the 2d hist by 270 deg counter clock wise bzw. 90 deg clock wise
  • "180Deg": rotate the 2d hist by 180 deg
  • "Transpose": transpose x and y axis of the 2d hist
  • "FlipVertical": flip the 2d hist vertically
  • "FlipHorizontal": flip the 2d hist horizontally
Class cass::pp56
Processor/%name%/{InputName}
processor name containing the result that will be stored
Class cass::pp57

Processor/%name%/{InputName}
Name of the processor containing the 2D result that will be projected

Processor/%name%/{Low|Up}
Upper and lower bound of the area to project. Default is -1e6 ... 1e6

Processor/%name%/{Axis}
The axis we want to project to. Default is "xAxis". Possible choises are:

  • "xAxis": projects the selected range in y to the x-Axis
  • "yAxis": projects the selected range in x to the y-Axis

Processor/%name%/{ExclusionValue}
The value that will be excluded when doing the projection. The result will be normilzed by the amount of bins that have been summed. Default is 0.

Class cass::pp60

Processor/%name%/{XName}
processor name containing the values to histogram

Processor/%name%/{XNbrBins|XLow|XUp|XTitle}
properties of the resulting 1D histogram

Processor/%name%/{Weight}
The weight, Can either be a constant value or a processor name containing the weights. The processor needs to be either of the same shape as the input, in which case the individual entires are the weights of the corresponding bins in the input, or contain a 0D value, in which case this will be used as weight for all the input values. Please see details for details about this option. Default 1

Processor/%name%/{RememberCounts}
This flag allows to enable the option of remembering the number of times a given bin has been filled. See detailed description for more info about this option. Default is false

Class cass::pp61

Processor/%name%/{AveragingType}
The type of averaging that should be performed. Default is "Normal"

  • "Normal": a normal average will be used
  • "Square"; a square averaging will be performed

Processor/%name%/{NbrOfAverages}
how many images should be averaged. When value is 0 its a cummulative average. Default is 1.

Processor/%name%/{InputName}
processor name containing the result that we average.

Class cass::pp62
Processor/%name%/{InputName}
processor name containing the result that we sum up.
Class cass::pp63

Processor/%name%/{InputName}

Processor/%name%/{MinTime|MaxTime}
Minimum and Maximum Time to plot in the result. Default is 0 ... 300 (WARNING: for the moment this setting is not active)

Processor/%name%/{NbrSamples}
Number of values that are used per second to calculate the average. Default is 5

Class cass::pp64

Processor/%name%/{InputName}
Name of the processor that conatins the result whos values will be appended to this.

Processor/%name%/{Size}
Number of values that are stored Default is 10000

Class cass::pp65

Processor/%name%/{XName|YName}
processor names containing the values to histogram. Both need to be of the same shape.

Processor/%name%/{XNbrBins|XLow|XUp|XTitle|YNbrBins|YLow|YUp|YTitle}
properties of the 2d histogram

Processor/%name%/{Weight}
The weight, Can either be a constant value or a processor name containing the weights. The processor needs to be either of the same shape as the input, in which case the individual entires are the weights of the corresponding bins in the input, or contain a 0D value, in which case this will be used as weight for all the input values. Please see details for details about this option. Default 1

Processor/%name%/{RememberCounts}
This flag allows to enable the option of remembering the number of times a given bin has been filled. See detailed description for more info about this option. Default is false

Class cass::pp66
Processor/%name%/{XName|YName}
processor names containing the 1D results for the x an y values.
Class cass::pp68

Processor/%name%/{YNbrBins|YLow|YUp}
properties of the y axis of the 2D result

Processor/%name%/{XName}
processr containing the 1D result.

Processor/%name%/{YName}
processor containing the 0D values to define the bin on the y-axis

Class cass::pp69

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the 1D result.

Processor/%name%/{XName|YName}
processor names containing the 0D values for the scatter plot

Class cass::pp70

Processor/%name%/{InputName}
name of processor that contains the result you want a subset from.

Processor/%name%/{XLow|XUp}
For 1d and 2d result the lower and upper range on the x-axis that one wants to include in the subset result. These endpoints are defined like $ [XLow,XUp[ $ Default is 0|1

Processor/%name%/{YLow|YUp}
In case you want to subset a 2d result these are the lower and upper range on the y-axis that one wants to include in the subset result. These endpoints are defined like $ [YLow,YUp[ $ Default is 0|1

Class cass::pp71

Processor/%name%/{RetrieveType}
Type of function used to retrieve the requested value in the result. Default is "max". Possible values are:

  • "max": return the maximum value in the result
  • "min": return the minimum value in the result

Processor/%name%/{InputName}
Name of the processor that contains the result to find the requested value in.

Class cass::pp72

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{ColumnIndex}
The index of the column in the table that one wants to have extracted. Please refer to the Processor description of the Processor that contains the table to find out what column indizes are available. Default is "0".

Class cass::pp73

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{ColumnIndex}
The index of the column in the table that one wants to use the condition on. Please refer to the Processor description of the Processor that contains the table to find out what column indizes are available. Default is "0".

Processor/%name%/{UpperBound|LowerBound}
Upper- and Lower Bound of the boundaries that the column value will be checked for.

Class cass::pp74

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{RowIndex}
The index of the row in the table that contains the requested value. Default is "0"

Processor/%name%/{ColumnIndex}
The index of the column in the table that contains the requested value. Please refer to the Processor description of the Processor that contains the table to find out what column indizes are available. Default is "0".

Class cass::pp75
Processor/%name%/{InputName}
name of processor that contains the result to clear
Class cass::pp77
Processor/%name%/{List}
Path and name of the file containing the list of id that should be checked. Default is "".
Class cass::pp79

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{XColumnIndex|YColumnIndex}
The index of the column in the table that one wants to have extracted and put on the x- and y-axis. Please refer to the Processor description of the Processor that contains the table to find out what column indizes are available. Default is "0".

Processor/%name%/{WeightColumnIndex}
Optional index of the column that will be used for the weights when histogramming the x and y values. If negative number is given the absolute value of it will be used as weight. Default is -1

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d result

Class cass::pp81

Processor/%name%/{InputName}
Name of the Processor that contains the result where the requested bin is retrieved from.

Processor/%name%/{RetrieveType}
The type of bin to retrieve. Default is "max". Options are:

  • max: the bin containing the maximum value
  • min: the bin containing the minimum value
Class cass::pp82

Processor/%name%/{InputName}
Processor containing the result for which the requested statistical value is calculated.

Processor/%name%/{Statistics}
Type of statistic that one wants to retrieve. Default is "sum". Possible values are:

  • sum: Sum of values of all bins
  • mean: Mean value of values of all bins
  • stdv: Standart deviation of values of all bins
  • variance: Variance of values of all bins
  • median: Median value of all bins
Class cass::pp85

Processor/%name%/{InputName}
Name of Processor that contains the result that the FWHM should be extracted for.

Processor/%name%/{XLow|XUp}
Lower and upper endpoints of the range that the FWHM will be calculated for. The endpoints define the range as $ [XLow,XUp[ $ Default is 0|1.

Processor/%name%/{Fraction}
At which fraction of the height the width should be taken. Default is 0.5

Class cass::pp86

Processor/%name%/{InputName}
Name of the processor that contains the 1D result that we look for the step in.

Processor/%name%/{XLow|XUp}
Lower and upper endpoints of the range that we look for the step in. The endpoints define the range as $ [XLow,XUp[ $ Default is 0|1.

Processor/%name%/{BaselineLow|BaselineUp}
Lower and upper endpoints of the range that we use to calculate the Baseline. The endpoints define the range as $ [BaselineLow,BaselineUp[ $ Default is 0|1.

Processor/%name%/{Fraction}
The Fraction between the baseline and the highest value that should be taken when searching for the right point. Default is 0.5

Class cass::pp87

Processor/%name%/{InputName}
Name of the processor that conatins the 1D resault that we look for the step in.

Processor/%name%/{XLow|XUp}
Lower and upper limit of the range that we look for the step. The endpoints define the range as $ [XLow,XUp[ $ Default is 0|1.

Class cass::pp88

Processor/%name%/{InputName}
Name of the processor that conatains the result from which the requested axis parameter is retrieved.

Processor/%name%/{AxisParameter}
The parameter of the axis one is interested in. Default is "XNbrBins". Possible values are:

  • "XNbrBins": The number of Bins in X
  • "XLow": The lower bound of the x-axis
  • "XUp": The upper bound of the x-axis
  • "YNbrBins": The number of Bins in Y
  • "YLow": The lower bound of the y-axis
  • "YUp": The upper bound of the y-axis
Class cass::pp89

Processor/%name%/{InputName}
Name of the processor that contains the 1D result to filter

Processor/%name%/{FilterType}
The filter type to use. Default is "LowPass". Possible values are:

  • "LowPass": a low pass filter
  • "HighPass": a high pass filter

Processor/%name%/{Cutoff}
The cutoff of the filter.

Processor/%name%/{SampleRate}
The sampling rate of the filter

Class cass::pp9

Processor/%name%/{InputName}
the processor name that contain the result for checking the value

Processor/%name%/{UpperLimit|LowerLimit}
Upper and Lower limit of the range to check. Default is 0,0. The following check will be done $ LowerLimit < value < UpperLimit $ Thus, both enpoints are exclusive.

Class cass::pp90

Processor/%name%/{ImageName}
the processor name that contains the histogram containing the cspad image in cass layout. Default is "".

Processor/%name%/{GeometryFilename}
The geom file to use. Default is "cspad.geom".

Processor/%name%/{ConvertCheetahToCASSLayout}
Set this true if the geom file is for a cheetah layout of the data, but the image in ImageName is the image in CASS layout.

Processor/%name%/{Wavelength_A}
The wavelength in Angstroem. Can also be the name of a PP that contains the Wavelength. Default is 1.

Processor/%name%/{DetectorDistance_m}
The detector distance in m. Can also be the name of a PP that contains the detector distance. Default is 60e-2.

Processor/%name%/{PixelSize_m}
The pixel size in m. Default is 110e-6

Processor/%name%/{XNbrBins|XLow|XUp}
properties of the resulting 1D histogram

Processor/%name%/{BadPixelValue}
value of the bad pixel in the image. Default is 0

Processor/%name%/{Output}
One can choose the type of radial average that one wants to have. Default is "Q". Possible values are:

  • "Q": the q-averge in the defintion of q that SAXS people are using. See pp90::Q for details.
  • "Resolution": the radial average in resultion values as defined by the crystallographers. See pp90::R for details.
  • "Radius": the radial average in radii, where the Pixelsize_m parameter is used to determine the radius. If one wants to have the radius in pixel units, one just has to set the PixelSize_m parameter to 1.
Class cass::pp91

Processor/%name%/{InputName}
Name of the Processor that contains the 1D result where the local extreme points will be retrieved from

Processor/%name%/{Range}
The range to check for the local extreme points. Default is 10

Processor/%name%/{ExtremePointType}
The type of extreme points that should be extracted from input. Default is "minima". Possible values are:

  • "minima": extracts the local minima from the 1D result
  • "maxima": extracts the local maxima from the 1D result
Member cass::Processor::setupCondition (bool defaultConditionType=true)
Processor/%name%/{ConditionName}
0D Processor name that we check before filling image. if this setting is not defined, this processor is unconditional. Therefore its always true.
Member cass::Processor::setupGeneral ()

Processor/%name%/{Hide}
Flag that will hide this processor in cassview's combobox. Default is false

Processor/%name%/{Write}
Flag that will tell a dumper to write this processor into the file. Default is true

Processor/%name%/{WriteSummary}
Flag that will tell a dumper to write this processor into the summary. Useful for histograms that are only interesting per run. Default is true

Processor/%name%/{Comment}
A comment with a short description of what this processor is doing. Will be added to the file, when its written. Default is "".

Class cass::RatePlotter

ProcessingStatistics/{ShowInfo}
If true, it will display the requested information. If false, no output is generated. Default is true.

ProcessingStatistics/{Output}
Filename to which the info will be written. If no parameter is given, output will be directed to cout.

ProcessingStatistics/{UpdateInterval}
The updating interval in s. Default is 1.

ProcessingStatistics/{ShowTime}
Show the current time before plotting any other information. Default is false.

ProcessingStatistics/{TimeFormatString}
The format string in which the time will be plotted. Default is "dd-MMM-yy_HH:mm:ss".

ProcessingStatistics/{ShowInputRate}
If true, it will show the input rate. Default is true.

ProcessingStatistics/{ShowInputLoad}
If true, it will show the input load. Default is true.

ProcessingStatistics/{ShowAnalysisRate}
If true, it will show the analysis rate. Default is true.

ProcessingStatistics/{ShowProgress}
If true, it will show the progress of the process. Default is true.

ProcessingStatistics/{ShowNbrProcessedEvents}
If true, it will show the number of events processed. Default is false.

ProcessingStatistics/{ShowNbrSkippedEvents}
If true, it will show the number of events skipped. Default is false.

ProcessingStatistics/{NewLine}
If true, it will show the input rate. Default is true.

ProcessingStatistics/ValueProcessors/{size}
the number of value like processors to be plotted.

ProcessingStatistics/ValueProcessors/%id%/{Name}
Name of the value like processor. If Unknown, then it won't be added to the list. Default is Unknown.

ProcessingStatistics/ValueProcessors/%id%/{FieldWidth}
Width of the value field. Used in setw(). Default is 10.

ProcessingStatistics/ValueProcessors/%id%/{Precision}
Precsion after the decimal point for floating. Used in setprecision(). Default is 7.

ProcessingStatistics/ValueProcessors/%id%/{Unit}
The unit to be displayed after the value. Default is "".

Class cass::SACLAConverter

SACLAConverter/{RetrieveAcceleratorData}
Flag that tells whether the accelerator data should be retrieved. Default is true. When set to true the following data is available in the Machine Data:

  • "Acc_electronEnergy_eV"
  • "Acc_KParams"
  • "Acc_PhotonEnergy"

SACLAConverter/OctalPixelDetectors/{size}
The number of octal MPCCD detectors one wants to retrieve. Be sure that for each detector there is a unique id in the list below.

SACLAConverter/OctalPixelDetectors/%index%/{DetectorName}
The base name of the octal MPCCD. Unlike the API this name will be used to determine the names of the individual tiles of the MPCCD. Default is "Invalid" which will caus to skip this index.

SACLAConverter/OctalPixelDetectors/%index%/{CASSID}
The id of the detector that CASS will use internally. Default is "0".

SACLAConverter/OctalPixelDetectors/%index%/{NormalizeToAbsGain}
Using this option one can control whether the pixel values of the individual tiles will be normalized to the gain value of the first tile. When true, the pixel values of tiles 2 to 8 will modified using: $ pixval_{tile} = \frac{gain_{tile}}{gain_{tile1}}*pixval_{tile}$ Default is true.

SACLAConverter/DatabaseValues/{size}
The number of values one wants to retrieve from the database. Be sure that for each detector there is a unique id in the list below.

SACLAConverter/DatabaseValues/%index%/{ValueName}
The name of the database value to retrieve. Default is "Invalid" which will cause to skip that index.

SACLAConverter/DatabaseValues/%index%/{CASSName}
The name of the value that the database value should have within the cassevent. Default is the same name as ValueName

Class cass::SACLAOfflineInput
SACLAOfflineInput/{NbrThreads}
Will tell CASS in how many chunks the tag list will be splitted. Each chunk will be processed individually by a separate thread. Default is 1.
Class cass::SACLAOnlineInput

SACLAOnlineInput/{MaxGuessedEvents}
The number of consecutive events that should be guessed. Once this number of events has been reached. The latest tag number will be retrieved for the next event. Default is 60.

SACLAOnlineInput/{BeamlineNumber}
The Beamline at which the experiment is running. Default is 3

SACLAOnlineInput/OctalPixelDetectors/{size}
The number of octal pixeldetectors that one wants to retrieve. Ensure that each parameter has a unique id in the list.

SACLAOnlineInput/OctalPixelDetectors/%index%/{CASSID}
The id of the detector that CASS will use internally. Default is "-1" which will cause to skip this index.

SACLAOnlineInput/OctalPixelDetectors/%index%/{NextTagNumberAdvancedBy}
It is needed to guess the next tag number therefore one has to tell how much the tag number advanced from one shot to the next. The tag number is increased with 60 Hz. Therefore at 30 Hz this number should be 2. Default is 2.

SACLAOnlineInput/OctalPixelDetectors/%index%/Tiles/{size}
The number of tiles contained within the octal pixeldetectors Ensure that each parameter has a unique id in the list.

SACLAOnlineInput/OctalPixelDetectors/%index%/Tiles/%index%/{TileName}
Name of the tile in the SACLA DAQ. Default is "Invalid".

SACLAOnlineInput/OctalPixelDetectors/%index%/Tiles/%index%{NbrCalibrationRows}
Number of additional rows that are not part of the image but used for calibrating the image. Default is 6.

SACLAOnlineInput/OctalPixelDetectors/%index%/Tiles/%index%{NormalizeTo}
Using this option one can control whether the pixel values of this tile will be normalized to the gain value of which other tile. The pixel values of this tile will be modified using: $ pixval_{tile} = \frac{gain_{tile}}{gain_{NormalizeTo}}*pixval_{tile}$ Default is 0 in which case the tile will not be normalized.

SACLAOnlineInput/DatabaseValues/{size}
The number of values one wants to retrieve from the database. Be sure that for each detector there is a unique id in the list below. At least one pixel detector is needed in order to be able to retrieve data using the SACLADataAccessUserAPI, since the runnumber is needed to retrieve the needed hightag number.

SACLAOnlineInput/DatabaseValues/%index%/{ValueName}
The name of the database value to retrieve. Default is "Invalid" which will cause to skip that index.

SACLAOnlineInput/DatabaseValues/%index%/{CASSName}
The name that the value should have within the CASSEvent. Default is "Invalid" in which case the name of the value will be chosen.

Class cass::TCPInput

TCPInput/{Server}
The name or ip address of the machine that the server is running on. Default is "localhost"

TCPInput/{Port}
The port that the TCP Server is listening for connections on. Default is "9090"

TCPInput/{DataType}
The type of data that is streamed from the tcp server. Default is "agat". Possible values are:

  • "agat": The type of data that is streamed from a normal version of AGAT3.
  • "shm": Type of data that is streamed from RACOON shm2tcp server. is to be used with the new ccd analysis chain.

TCPInput/{SocketDataTimeout_ms}
Time in ms to wait until the data should be available. If time was exeeded it will check if the connection on the socket to the server was lost. Default is 2000 ms.

TCPInput/{SocketConnectionTimout_ms}
Time in ms to wait until the socket is connected to the server. Default is 1000 ms.

TCPInput/{WaitUntilReconnectionTry_s}
Time in s to wait until another attempt is made to reconnect the socket to the server. Default is 5.

Class cass::TestInput
TestInput/{key}
See Data-Generators List for a list of all possible values.
Class cass::TxtReader

TxtReader/%filename%/{Deliminator}
The deliminator that is used to separate the values. Default is '\t', which is a tab.

TxtReader/%filename%/{EventIdHeader}
The name of the Header under which the Event Id is stored. Default is "".

TxtReader/%filename%/{LinesToSkip}
How many lines do we have to skip before the line appears that contains the headers. Default is 3

Class cass::WaveformGenerator

WaveformGenerator/{InstrumentId}

WaveformGenerator/{NbrOfSamples}

WaveformGenerator/{SampleInterval}

WaveformGenerator/Channel/{size}

WaveformGenerator/Channel/%id%/{Offset}

WaveformGenerator/Channel/%id%/{FullScale}

Class cass::XFELHDF5FileInput

XFELHDF5FileInput/{MaxPulseId}
The maximum pulse id that will be used to iterate through. Default is 65.

XFELHDF5FileInput/{PreCacheData}
Flag that allows precaching the whole files by reading the contents to memory. Need to ensure that you've got enough memory available first otherwise the program will crash. Default is true.

XFELHDF5FileInput/AGIPD/{DataCASSID}
ID that the agipd data will have in the cassevent. Default is 30

XFELHDF5FileInput/AGIPD/{MaskCASSID}
ID that the agipd mask will have in the cassevent. Default is 31

XFELHDF5FileInput/AGIPD/{GainCASSID}
ID that the agipd gain information will have in the cassevent. Default is 32

XFELHDF5FileInput/AGIPD/Tiles/%index%/{Id}
ID of the tile. Default is -1 which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{HDF5FileName}
HDF5 file that contains the data of the tile. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{DataHDF5Key}
Key to the data of the tile in the HDF5 file. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{MaskHDF5Key}
Key to the mask of the tile in the HDF5 file. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{GainHDF5Key}
Key to the gain data of the tile in the HDF5 file. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{TrainIdHDF5Key}
Key to the train Id of the tile in the HDF5 file. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{PulseIdHDF5Key}
Key to the pulse Id of the tile in the HDF5 file. Default is Invalid which will skip this entry

XFELHDF5FileInput/AGIPD/Tiles/%index%/{CellIdHDF5Key}
Key to the cell Id of the tile in the HDF5 file. Default is Invalid which will skip this entry

Class cass::XFELOnlineInput

XFELOnlineInput/{ServerAddress}
The name or ip address of the machine that the server is running on. Default is "tcp://localhost:1234"

XFELOnlineInput/{NbrPulsesInTrain}
The number of pulses within the train. Default is 64

XFELOnlineInput/{Source}
The data source within the transferred kb_data. Default is SPB_DET_AGIPD1M-1/DET/detector-1

XFELOnlineInput/{CASSID}
The id of the image data within the cassevent. Default is 30.

XFELOnlineInput/{PathToImage}
path to the image data within the transferred data. Default is "image.data"

Class cass::ZMQInput
ZMQInput/{Server}
The name or ip address of the machine that the server is running on. Default is "localhost"