CorrectedMETFactory

class coffea.jetmet_tools.CorrectedMETFactory(name_map)

Bases: object

Factory class for propagating corrections made to jets into a corrected value of MET. This includes organizing different variations associated with uncertainties in MET from unclustered energy.

Once the CorrectedMETFactory is constructed, an array of corrected MET values and variations can be produced with the build method, which requires an array of uncorrected MET and an array of corrected jets.

Parameters:

name_map (dict[str, str]) –

Keys must include at least the following:

• METpt

• METphi

• JetPt

• JetPhi

• ptRaw

• UnClusteredEnergyDeltaX

• UnClusteredEnergyDeltaY

and each of those must be mapped to the corresponding field name of the input arrays in_MET and in_corrected_jets for the build method.

Methods Summary

build(in_MET, in_corrected_jets)	Produce an array of corrected MET values from an array of uncorrected MET values and an array of corrected jets.
uncertainties()	Returns a list of the sources of uncertainty included in the stack.

Methods Documentation

build(in_MET, in_corrected_jets)

Produce an array of corrected MET values from an array of uncorrected MET values and an array of corrected jets.

Parameters:

• in_MET (awkward.Array or dask_awkward.Array) – An array of raw (uncorrected) MET values.

• in_corrected_jets (awkward.Array or dask_awkward.Array) – An array of corrected jets, as produced by CorrectedJetsFactory.

Returns:

Array of corrected MET values with shape matching in_MET.

Return type:

awkward.Array or dask_awkward.Array

uncertainties()

Returns a list of the sources of uncertainty included in the stack.

Returns:

A list of the sources of uncertainty.

Return type:

list[str]