LumiMask

class coffea.lumi_tools.LumiMask(jsonfile)[source]

Bases: object

Holds a luminosity mask index, and provides vectorized lookup, retaining only valid (run,lumisection) pairs.

Parameters:

jsonfile (str) – Path the the ‘golden json’ file or other valid lumiSection database in json format.

This class parses a CMS lumi json into an efficient valid lumiSection lookup table.

Methods Summary

__call__(runs, lumis)

Check pairs of runs and lumis for validity, and produce a mask retaining the valid pairs.

Methods Documentation

__call__(runs, lumis)[source]

Check pairs of runs and lumis for validity, and produce a mask retaining the valid pairs.

Parameters:

  • runs (numpy.ndarray or awkward.highlevel.Array or dask_awkward.Array) – Vectorized list of run numbers

  • lumis (numpy.ndarray or awkward.highlevel.Array or dask_awkward.Array) – Vectorized list of lumiSection numbers

Returns:

mask_out – An array of dtype bool where valid (run, lumi) tuples will have their corresponding entry set True.

Return type:

numpy.ndarray