API reference

binning

Binning([boundaries, lows, ups, retvalue, …])
Echo([nextFunc, valid])
Round([width, aboundary, min, …]) Equal width binning
RoundLog([width, aboundary, min, …]) Binning with equal width in log scale

loop

Collector(resultsCombinationMethod[, …]) This class collects results, i.e., this class combines results of readers and deliver them.
CollectorComposite(**kwargs) A composite of collectors.
CollectorDelegate(collector)
EventLoop(**kwargs) An event loop
DatasetIntoEventBuildersSplitter(…[, …])
EventDatasetReader(eventLoopRunner, reader, …) This class manages objects involved in reading events in data sets.
EventLoopRunner() This class runs instances of EventLoop and keeps the results.
MPEventLoopRunner(communicationChannel) This class (concurrently) runs instances of EventLoop.
ReaderComposite([readers]) A composite of event readers”
NullCollector
ReaderComposite([readers]) A composite of event readers”
splitfuncs.create_files_start_length_list(files)

roottree

Branch(name, array, countarray) This class encloses an array.array object, which is typically used to set the address of a branch of a ROOT TTree.
Events(tree[, maxEvents, start]) An iterative object for events.

selection

build_selection(**kargs)
modules.All([name, selections]) select events that meet all conditions
modules.Any([name, selections]) select events that meet any of the conditions
modules.Not(selection[, name]) select events that do NOT pass the selection
modules.AllwCount([name, selections, collector]) select events that meet all conditions
modules.AnywCount([name, selections, collector]) select events that meet any of the conditions
modules.NotwCount(selection[, name, collector]) select events that do NOT pass the selection
modules.Count.Count([selections])
modules.LambdaStr.LambdaStr(lambda_str[, name]) select events to which a lambda returns True.

summary

BackrefMultipleArrayReader(arrays, idxs_conf)
Count([val, weight, contents])
param val:If None, initialize with 0. i.e., not counted. Otherwise,
KeyValueComposer([keyAttrNames, binnings, …]) This class composes keys and values for the event
NextKeyComposer(binnings)
Reader(keyValComposer, summarizer[, …])
Scan([val, weight, contents])
Sum([val, weight, contents])
Summarizer(Summary)
WeightCalculatorOne

progressbar

BProgressMonitor(**kwargs) A progress monitor of tasks.
NullProgressMonitor(**kwargs)
ProgressBar(**kwargs)
ProgressMonitor(**kwargs)
ProgressPrint(**kwargs)
ProgressReport(**kwargs) A progress report
ProgressReportPickup(**kwargs)
ProgressReporter(**kwargs) A progress reporter

concurrently

CommunicationChannel(dropbox) A communication channel with workers in other processes.
CommunicationChannel0([progressbar]) A communication channel for the single process mode
HTCondorJobSubmitter(**kwargs)
MultiprocessingDropbox(**kwargs) A drop box for task packages.
SubprocessRunner([pipe])
TaskPackage(task, args, kwargs)
TaskPackageDropbox(workingArea, dispatcher) A drop box for task packages.
Worker
WorkingArea(**kwargs) Args: topdir (str): a path to a directory in which a new directory will be created python_modules (list): names of python modules to be shipped to worker nodes