From da2d37bb7fe3a20ede1e7afaff3be644980cd9f9 Mon Sep 17 00:00:00 2001 From: David Hammer <dhammer@mailbox.org> Date: Fri, 30 Aug 2024 13:55:39 +0200 Subject: [PATCH] Add extension schemata to docs --- docs/schemas/Assign.md | 4 + docs/schemas/BooleanCombination.md | 31 +++++++ docs/schemas/HitFinderSPI.md | 131 ++++++++++++++++++++++++++++ docs/schemas/IntegratedIntensity.md | 27 ++++++ docs/schemas/IntensityThreshold.md | 41 +++++++++ docs/schemas/LitFrames.md | 4 + docs/schemas/LitPixelCounter.md | 14 +++ docs/schemas/ManualFilter.md | 55 ++++++++++++ docs/schemas/Peakfinder9.md | 131 ++++++++++++++++++++++++++++ docs/schemas/PpuKernel.md | 17 ++++ docs/schemas/RandomFrames.md | 14 +++ docs/schemas/RandomSampler.md | 14 +++ docs/schemas/ReduceAndThreshold.md | 69 +++++++++++++++ docs/schemas/SaturationMonitor.md | 84 ++++++++++++++++++ 14 files changed, 636 insertions(+) create mode 100644 docs/schemas/Assign.md create mode 100644 docs/schemas/BooleanCombination.md create mode 100644 docs/schemas/HitFinderSPI.md create mode 100644 docs/schemas/IntegratedIntensity.md create mode 100644 docs/schemas/IntensityThreshold.md create mode 100644 docs/schemas/LitFrames.md create mode 100644 docs/schemas/LitPixelCounter.md create mode 100644 docs/schemas/ManualFilter.md create mode 100644 docs/schemas/Peakfinder9.md create mode 100644 docs/schemas/PpuKernel.md create mode 100644 docs/schemas/RandomFrames.md create mode 100644 docs/schemas/RandomSampler.md create mode 100644 docs/schemas/ReduceAndThreshold.md create mode 100644 docs/schemas/SaturationMonitor.md diff --git a/docs/schemas/Assign.md b/docs/schemas/Assign.md new file mode 100644 index 00000000..afa7c07a --- /dev/null +++ b/docs/schemas/Assign.md @@ -0,0 +1,4 @@ +# Arbiter kernel: Assign +## <a name='prefix'></a>`prefix` +Access mode +: RECONFIGURABLE diff --git a/docs/schemas/BooleanCombination.md b/docs/schemas/BooleanCombination.md new file mode 100644 index 00000000..80f4d5b3 --- /dev/null +++ b/docs/schemas/BooleanCombination.md @@ -0,0 +1,31 @@ +# Arbiter kernel: BooleanCombination +## `prefix` +This kernel allows combining individual masks from many sources. It is intended for cases where, for example, each correction device via some addon provides its own frame mask. This arbiter kernel would then be able to AND (keep only frames making it through all masks) or OR these individual masks. +### <a name='prefix.key'></a>`prefix.key` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``data.dataFramePattern`` + +### <a name='prefix.operator'></a>`prefix.operator` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Options: +: ``all``, ``any`` + +Default value +: ``all`` diff --git a/docs/schemas/HitFinderSPI.md b/docs/schemas/HitFinderSPI.md new file mode 100644 index 00000000..7a6571df --- /dev/null +++ b/docs/schemas/HitFinderSPI.md @@ -0,0 +1,131 @@ +# Arbiter kernel: HitFinderSPI +## `prefix` +### <a name='prefix.SPI'></a>`prefix.SPI` +Type +: BOOL + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``True`` + +### <a name='prefix.modules'></a>`prefix.modules` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``:16`` + +### <a name='prefix.absoluteThreshold'></a>`prefix.absoluteThreshold` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``240.0`` + +### <a name='prefix.useAdaptiveThreshold'></a>`prefix.useAdaptiveThreshold` +Type +: BOOL + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``True`` + +### <a name='prefix.sigmaLevel'></a>`prefix.sigmaLevel` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``4.0`` + +### <a name='prefix.maxHistoryLength'></a>`prefix.maxHistoryLength` +Type +: INT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``200`` + +### <a name='prefix.SFX'></a>`prefix.SFX` +Type +: BOOL + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``True`` + +### <a name='prefix.minPeaks'></a>`prefix.minPeaks` +Type +: INT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``10`` + +### <a name='prefix.minRadius'></a>`prefix.minRadius` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``50.0`` + +### <a name='prefix.maxRadius'></a>`prefix.maxRadius` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``700.0`` diff --git a/docs/schemas/IntegratedIntensity.md b/docs/schemas/IntegratedIntensity.md new file mode 100644 index 00000000..77299e45 --- /dev/null +++ b/docs/schemas/IntegratedIntensity.md @@ -0,0 +1,27 @@ +# Correction addon: IntegratedIntensity +## `prefix` +### <a name='prefix.valueMin'></a>`prefix.valueMin` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``-10.0`` + +### <a name='prefix.valueMax'></a>`prefix.valueMax` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``20000.0`` diff --git a/docs/schemas/IntensityThreshold.md b/docs/schemas/IntensityThreshold.md new file mode 100644 index 00000000..9a2ac650 --- /dev/null +++ b/docs/schemas/IntensityThreshold.md @@ -0,0 +1,41 @@ +# Arbiter kernel: IntensityThreshold +## `prefix` +This kernel selects the frames by comparing the averagedintensity to the threshold. +### <a name='prefix.modules'></a>`prefix.modules` +Type +: VECTOR_UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``[3, 4, 8, 15]`` + +### <a name='prefix.snr'></a>`prefix.snr` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``3.5`` + +### <a name='prefix.minFrames'></a>`prefix.minFrames` +Type +: INT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``100`` diff --git a/docs/schemas/LitFrames.md b/docs/schemas/LitFrames.md new file mode 100644 index 00000000..216fdacc --- /dev/null +++ b/docs/schemas/LitFrames.md @@ -0,0 +1,4 @@ +# Arbiter kernel: LitFrames +## <a name='prefix'></a>`prefix` +Access mode +: RECONFIGURABLE diff --git a/docs/schemas/LitPixelCounter.md b/docs/schemas/LitPixelCounter.md new file mode 100644 index 00000000..40ee9072 --- /dev/null +++ b/docs/schemas/LitPixelCounter.md @@ -0,0 +1,14 @@ +# Correction addon: LitPixelCounter +## `prefix` +### <a name='prefix.threshold'></a>`prefix.threshold` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``6.0`` diff --git a/docs/schemas/ManualFilter.md b/docs/schemas/ManualFilter.md new file mode 100644 index 00000000..67ee10c5 --- /dev/null +++ b/docs/schemas/ManualFilter.md @@ -0,0 +1,55 @@ +# Arbiter kernel: ManualFilter +## `prefix` +### <a name='prefix.resize'></a>`prefix.resize` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: If number of frames doesn't match the length of the specified filter, what to do? If 'Error', the kernel will just fail (resulting in all true for the arbiter). If True or False, will expand manual filter with the corresponding value (shrinking if manual filter is too big). + +Options: +: ``True``, ``False``, ``Error`` + +Default value +: ``False`` + +### <a name='prefix.spec'></a>`prefix.spec` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: String specifying the manual mask to apply. See 'type' for details. + +Default value +: empty string + +### <a name='prefix.type'></a>`prefix.type` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: How to specify the manual filter. 'range' means parse and pass the spec to np.arange (so should be between 1 and 3 comma-separated integers specifying [start], stop, [step]). 'mask' means comma-separated list of 0 and 1 (zero means don't include, 1 means include). 'indices' means comma-separated list of indices (these will be included, anything else will not be). + +Options: +: ``range``, ``mask``, ``indices`` + +Default value +: ``mask`` diff --git a/docs/schemas/Peakfinder9.md b/docs/schemas/Peakfinder9.md new file mode 100644 index 00000000..84ad90c5 --- /dev/null +++ b/docs/schemas/Peakfinder9.md @@ -0,0 +1,131 @@ +# Correction addon: Peakfinder9 +## `prefix` +### <a name='prefix.windowRadius'></a>`prefix.windowRadius` +Type +: UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``2`` + +### <a name='prefix.maxPeaks'></a>`prefix.maxPeaks` +Type +: UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``500`` + +### <a name='prefix.minPeakValueOverNeighbors'></a>`prefix.minPeakValueOverNeighbors` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``10.0`` + +### <a name='prefix.minSnrMaxPixel'></a>`prefix.minSnrMaxPixel` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``5.0`` + +### <a name='prefix.minSnrPeakPixels'></a>`prefix.minSnrPeakPixels` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``4.0`` + +### <a name='prefix.minSnrWholePeak'></a>`prefix.minSnrWholePeak` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``6.0`` + +### <a name='prefix.minSigma'></a>`prefix.minSigma` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``5.0`` + +### <a name='prefix.blockX'></a>`prefix.blockX` +Type +: UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``1`` + +### <a name='prefix.blockY'></a>`prefix.blockY` +Type +: UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``1`` + +### <a name='prefix.blockZ'></a>`prefix.blockZ` +Type +: UINT32 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``64`` diff --git a/docs/schemas/PpuKernel.md b/docs/schemas/PpuKernel.md new file mode 100644 index 00000000..4c5f7a3c --- /dev/null +++ b/docs/schemas/PpuKernel.md @@ -0,0 +1,17 @@ +# Arbiter kernel: PpuKernel +## `prefix` +### <a name='prefix.ppuDevice'></a>`prefix.ppuDevice` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Name of the PPU trigger device to follow. It must separately be added to the 'sources' configuration. Specifically, add '[ppuDevice].trainTrigger' to the sources such that the relevant property node is matched. + +Default value +: empty string diff --git a/docs/schemas/RandomFrames.md b/docs/schemas/RandomFrames.md new file mode 100644 index 00000000..30ecb578 --- /dev/null +++ b/docs/schemas/RandomFrames.md @@ -0,0 +1,14 @@ +# Correction addon: RandomFrames +## `prefix` +### <a name='prefix.probability'></a>`prefix.probability` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``50.0`` diff --git a/docs/schemas/RandomSampler.md b/docs/schemas/RandomSampler.md new file mode 100644 index 00000000..a3839f7b --- /dev/null +++ b/docs/schemas/RandomSampler.md @@ -0,0 +1,14 @@ +# Arbiter kernel: RandomSampler +## `prefix` +### <a name='prefix.probability'></a>`prefix.probability` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``50.0`` diff --git a/docs/schemas/ReduceAndThreshold.md b/docs/schemas/ReduceAndThreshold.md new file mode 100644 index 00000000..a09a8f6c --- /dev/null +++ b/docs/schemas/ReduceAndThreshold.md @@ -0,0 +1,69 @@ +# Arbiter kernel: ReduceAndThreshold +## `prefix` +This kernel allows custom frame masks based on comparing some reduction along modules over each frame to some threshold. Integrated intensity will be used as a running example in the descriptions of the properties under this node; these settings (used with the example integrated intensity addon) would yield a frame mask of frames with total (across modules) integrated intensity of at least [threshold] ADUs. +### <a name='prefix.key'></a>`prefix.key` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: The key in the input hashes which holds the data values for reduction and comparison. Typically some summary computed per frame by an addon; for example, 'image.integratedIntensity' + +Default value +: empty string + +### <a name='prefix.threshold'></a>`prefix.threshold` +Type +: DOUBLE + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Default value +: ``0.0`` + +### <a name='prefix.reduction'></a>`prefix.reduction` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: The reduction to apply across modules before comparing with the threshold. For example 'sum'. + +Options: +: ``sum``, ``mean``, ``max``, ``min``, ``std`` + +Default value +: ``sum`` + +### <a name='prefix.comparator'></a>`prefix.comparator` +Type +: STRING + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: The comparator to use for comparing the reduced per-frame values to the threshold. For the integrated intensity example, 'ge'. The reduced values will be on the left and the threshold will be on the right, so the example would be compute: mask = sum(integrated intensity) ≥ threshold. + +Options: +: ``lt``, ``le``, ``gt``, ``ge``, ``eq``, ``ne`` + +Default value +: ``ge`` diff --git a/docs/schemas/SaturationMonitor.md b/docs/schemas/SaturationMonitor.md new file mode 100644 index 00000000..d4e3d8f7 --- /dev/null +++ b/docs/schemas/SaturationMonitor.md @@ -0,0 +1,84 @@ +# Correction addon: SaturationMonitor +## `prefix` +### <a name='prefix.alarmThreshold'></a>`prefix.alarmThreshold` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Alarm threshold per pixel. + +Default value +: ``0.0`` + +### <a name='prefix.warnThreshold'></a>`prefix.warnThreshold` +Type +: FLOAT + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Warning threshold per pixel. + +Default value +: ``0.0`` + +### <a name='prefix.alarmMaxCount'></a>`prefix.alarmMaxCount` +Type +: UINT64 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Maximum number of pixel above alarm threshold. + +Default value +: ``0`` + +### <a name='prefix.warnMaxCount'></a>`prefix.warnMaxCount` +Type +: UINT64 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Maximum number of pixel above warn threshold. + +Default value +: ``0`` + +### <a name='prefix.frameAxis'></a>Multi-frame axis (`prefix.frameAxis`) +Type +: UINT64 + +Access mode +: RECONFIGURABLE + +Assignment +: OPTIONAL + +Description +: Axis for frames. Used to take the max over this axis. + +Default value +: ``0`` + +### `prefix.output` +OutputChannel \ No newline at end of file -- GitLab