Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section is aimed at explaining the way the analysis of area detector works. It is intended for more expert use cases, since working with the producer and the producer template is enough for most experiments.

Table of Contents

Intro to DetObjectFunc

Area detector analysis in smalldata_tools is handled using sublclasses of DetObjectFunc. In order to be itnegrated integrated in the workflow, the function must subclass that object.

...

  • Instantiate the detectors
  • Setup the analysis functions with all its kwargs
  • use det.addFunc(...) to add a function to the pipeline. Multiple functions can be added.
    It can happen that certain function modify the detector data directly and will lead to unexpected behavior or errors. Please consult with us if you want to use multiple functions on the same detector.
  • DetObjectFunc also has a addFunc method, so that function can be daisy-chained. This is also contingent to the output of the first function being a compatible input to the second one, which is not always the case. For example, one can chain a ROI function to a projection to get the projection of the ROI only. Again, please consult with us for this.
  • Run the psana event loop, calling the the relevant smalldata_tools methods and functions to process the detector according to the pipeline.

Make my own analysis function

TO DO