Processors

A processor is one step of the dataflow. Run-level processors (process_*) are called once per period and run, partition-level processors (p_process_*) once per period for the partitions that contain it. All of them take the ProcessingConfig as processing_config, the LegendData as l200, and the keyword arguments from their kwargs entry in the processing config. They distribute their work over the worker pool with parallel: a detector or file that fails is recorded as a failure in the report, and the processor continues with the others.

Each partition processor returns true when it skipped a detector whose partition starts in an earlier period (with only_first_period); run_processing then waits for the same processor to finish for the previous period.

The processors are documented by topic:

HPGe calibration: peak splitting, DSP, quality cuts, decay time, filter optimization and energy calibration;
Pulse shape discrimination: A/E, LQ and PSD efficiencies;
SiPMs, events and stability: SiPM optimization and calibration, event building, skims and stability plots.

Report status

Every processor writes a Markdown report per run (or per period for a partition processor) with one row per detector, file or partition. A row has the status Success, Warning or Failure: Failure when the work for that item threw an error, Warning when the processor found a value it flags but could still use, such as a decay time outside 350–700 µs.

master_status combines the rows into the Processor Status at the top of the report. A row with a usability column counts according to the usability of its detector, a row without one counts as on:

Row status	`on`	`ac`	`off`
Success	–	–	–
Warning	failure	warning	–
Failure	failure	failure	warning

The processor status is Failure if any row counts as a failure, otherwise Warning if any row counts as a warning, otherwise Success. A report without rows is a Failure.

The Reports page counts each report as ok, warn or fail from its Processor Status (see JuLeAna.read_report); a report without that table counts as fail if any row failed, warn if any row has a warning, and ok otherwise. For the current run, a report that does not exist is counted as miss.

Adding a processor

Each processor is a function in its own file in src/processors/, included by src/JuLeAna.jl and registered in JuLeAna.PROCESSORS under the name used in the processing config. To add one:

Write the function in a new file src/processors/process_xxx.jl (or p_process_xxx.jl for a partition processor), with the signature process_xxx(processing_config, l200, period, run; reprocess::Bool = false, kwargs...) or p_process_xxx(processing_config, l200, period; reprocess::Bool = false, only_first_period::Bool = true, kwargs...). Add explicit using imports to src/JuLeAna.jl for any new names it uses.
Add include("processors/process_xxx.jl") to src/JuLeAna.jl.
End the file with register_processor!(process_xxx).
Add an entry process_xxx to the processors (or p_processors) section of the processing config.
Add the function to the processor page of its topic.

When the dataflow starts, every enabled processor of the config must be registered and accept all of its configured kwargs (see check_processor_kwargs); otherwise it stops with an error naming the processor.