Versions Compared

Key

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

...

  • Custom bin definition: Using a run-based logic, one can define how to bin the data here. If no bins are given for a run, then the unique position of the corresponding scan motor will be used. The former is typically used for time or energy fly-scans and the latter is recommended for regular motor scans, such as phi or laser lens scans.
  • Filter definition: Default filter name is filter1. Any other filter name will lead to the creation of separate cube files ending with _filtername. This can be useful in case where an external field is applied on certain shots for example.
  • Laser on/off: If True will create _on and _off cubed file.
  • Detectors: Area detectors dictionaries to be cubed are defined here. Each detector is defined through a dictionary that can have the following keys:
    • thresADU (float): pixel intensity threshold (float)
    • common_mode (int/None): common mode selection (int/None). Is None in most cases (take default common mode for that detector). This is generally set by your data analysis PoC and should rarely be changed.
    • image (bool): whether to return the image (True) or the calib (False, individual tiles)
    • full (bool): not-implemented (ignore for now)
    • det_proc (dict): a  dictionary containing the name and arguments for post-processing analysis to be applied to the binned detector data. See 3.1 Post-processing functions for details on the different functions available.
  • All the variable to add to the cubed file are then added to varList. The syntax for each non-area detector variable should follow the h5 tree structure in the smalldata h5 file. Area detectors dictionaries must be added to this list as well.
  • Histograms: At the end of the cube, a summary is posted to the elog. A list of variables can be customized here. The IPMs and timing tool are generally considered default. If a variable is also in the filter list, the filter boundaries will be shown in the histogram too. The pixel histograms for the area detector defined are also included in the summary. These plots can help you choose relevant filters and thresholds. Adding event codes to this list might be a good idea in cases where event code-based filters are used.

...