NminusOne
- class coffea.analysis_tools.NminusOne(names, nev, masks, delayed_mode)[source]
Bases:
objectObject to be returned by PackedSelection.nminusone()
Methods Summary
plot_vars(vars[, axes, bins, start, stop, ...])Plot the histograms of variables for each step of the N-1 selection
print()Prints the statistics of the N-1 selection
result()Returns the results of the N-1 selection as a namedtuple
to_npz(file[, compressed, compute])Saves the results of the N-1 selection to a .npz file
Returns the N-1 selection yields as a
hist.HistobjectMethods Documentation
- plot_vars(vars, axes=None, bins=None, start=None, stop=None, edges=None, transform=None)[source]
Plot the histograms of variables for each step of the N-1 selection
- Parameters:
vars (dict) – A dictionary in the form
{name: array}wherenameis the name of the variable, andarrayis the corresponding array of values. The arrays must be the same length as each mask of the N-1 selection.axes (list of hist.axis objects, optional) – The axes objects to histogram the variables on. This will override all the following arguments that define axes. Must be the same length as
vars.bins (iterable of integers or Nones, optional) – The number of bins for each variable histogram. If not specified, it defaults to 20. Must be the same length as
vars.start (iterable of floats or integers or Nones, optional) – The lower edge of the first bin for each variable histogram. If not specified, it defaults to the minimum value of the variable array. Must be the same length as
vars.stop (iterable of floats or integers or Nones, optional) – The upper edge of the last bin for each variable histogram. If not specified, it defaults to the maximum value of the variable array. Must be the same length as
vars.edges (list of iterables of floats or integers, optional) – The bin edges for each variable histogram. This overrides
bins,start, andstopif specified. Must be the same length asvars.transform (iterable of hist.axis.transform objects or Nones, optional) – The transforms to apply to each variable histogram axis. If not specified, it defaults to None. Must be the same length as
vars.
- Returns:
hists (list of hist.Hist or hist.dask.Hist objects) – A list of 2D histograms of the variables for each step of the N-1 selection. The first axis is the variable, the second axis is the N-1 selection step.
labels (list of strings) – The bin labels of y axis of the histogram.
- result()[source]
Returns the results of the N-1 selection as a namedtuple
- Returns:
result – A namedtuple with the following attributes:
- nevlist of integers or dask_awkward.lib.core.Scalar objects
The number of events in each step of the N-1 selection as a list of integers or delayed integers
- maskslist of boolean numpy.ndarray or dask_awkward.lib.core.Array objects
The boolean mask vectors of which events pass the N-1 selection each time as a list of materialized or delayed boolean arrays
- Return type:
NminusOneResult
- to_npz(file, compressed=False, compute=False)[source]
Saves the results of the N-1 selection to a .npz file
- Parameters:
file (str or file) – Either the filename (string) or an open file (file-like object) where the data will be saved. If file is a string or a Path, the
.npzextension will be appended to the filename if it is not already there.compressed (bool, optional) – If True, the data will be compressed in the
.npzfile. Default is False.compute (bool, optional) – Whether to immediately start writing or to return an object that the user can choose when to start writing by calling compute(). Default is False.
- Returns:
out – If
compute=True, returns None. Otherwise, returns an object that can be used to start writing the data by calling compute().- Return type:
NminusOneToNpz or None