haniwers.v1.cli.options.threshold#

Threshold settings option group.

Module Contents#

Classes#

ThresholdOptions

Threshold settings option group.

API#

class haniwers.v1.cli.options.threshold.ThresholdOptions#

Threshold settings option group.

Contains options for configuring detector thresholds and threshold operations.

thresholds#

‘Option(…)’

Threshold configuration.

Specifies detector thresholds for one or more channels. Format: semicolon- separated channel:value pairs.

Examples:

  • ‘1:290’ - Set channel 1 to 290

  • ‘1:290;2:320;3:298’ - Set all three channels

  • ‘2:310’ - Set only channel 2

Valid range: 1-1023 for threshold, channels 1-3.

Type: str Default: Required (no default)

suppress_threshold#

‘Option(…)’

Suppression threshold for non-target channels.

During threshold scanning, sets the detection threshold for non-target channels to suppress their signals while measuring a specific channel. OSECHI detector threshold values range from 1 (lowest, most sensitive) to 1023 (highest, least sensitive). Default is 1000, which effectively suppresses noise on non-target channels.

Type: int Default: 1000 Minimum: 1 Maximum: 1023

max_retry#

‘Option(…)’

Maximum retry attempts option.

When communication with detector fails, retry this many times before giving up. Use higher values for unreliable connections.

Type: int Default: 3 retries Minimum: 1 retry

history#

‘Option(…)’

Threshold history audit log.

CSV file that records all threshold setting operations with timestamps. Useful for auditing and debugging. Automatically saved in the workspace.

Type: Path Default: ‘threshold_history.csv’