alphatwirl.heppyresult package¶
Submodules¶
alphatwirl.heppyresult.Analyzer module¶
alphatwirl.heppyresult.Component module¶
alphatwirl.heppyresult.ComponentLoop module¶
alphatwirl.heppyresult.ComponentReaderComposite module¶
alphatwirl.heppyresult.EventBuilder module¶
alphatwirl.heppyresult.EventBuilderConfig module¶
alphatwirl.heppyresult.EventBuilderConfigMaker module¶
alphatwirl.heppyresult.HeppyResult module¶
-
class
alphatwirl.heppyresult.HeppyResult.
HeppyResult
(path, componentNames=None, excludeList=['Chunks', 'failed'], componentHasTheseFiles=['config.pck', 'config.txt'], isComponent=None)[source]¶ Bases:
object
A Heppy result
Parameters: - path (str) – the path to the Heppy result
- componentNames (list, optional) – the list of the names of the components to read. If not given, all components except the ones listed in
excludeList
will be read. - excludeList (list, optional) – a list of the names of the directory in the Heppy result directory which are to be excluded to be considered as components. if not given,
DEFAULT_EXCLUDE_LIST
will be used. - componentHasTheseFiles (list, optional) – the directories with there files are considered as components. if not given,
DEFAULT_COMPONENT_HAS_THESE_FILES
will be used. - isComponent (function, optional) – a function that determines if a directory is a Heppy component. if not give,
IsComponent
will be used.
alphatwirl.heppyresult.ReadComponentConfig module¶
alphatwirl.heppyresult.ReadCounter module¶
alphatwirl.heppyresult.ReadVersionInfo module¶
alphatwirl.heppyresult.TblBranch module¶
alphatwirl.heppyresult.TblBrilCalc module¶
alphatwirl.heppyresult.TblComponentConfig module¶
alphatwirl.heppyresult.TblCounter module¶
-
class
alphatwirl.heppyresult.TblCounter.
TblCounter
(analyzerName, fileName, outPath, levels=None, columnNames=None)[source]¶ Bases:
object
This class reads counter files of HeppyResult.
Parameters: - analyzerName (str) – the name of the Heppy analyzer, e.g., skimAnalyzerCount
- fileName (str) – the name of the counter file, e.g., SkimReport.txt
- outPath (str) – a path to the output file
- levels (list) – a list of the levels to read. If not given, all levels will be read
- columnNames (list) – a list of the column names of the output file. If not given, the levels will be used
alphatwirl.heppyresult.TblCounterLong module¶
-
class
alphatwirl.heppyresult.TblCounterLong.
TblCounterLong
(analyzerName, fileName, outPath, levels=None, columnNames=('component', 'level', 'count'))[source]¶ Bases:
object
An alternative class to TblCounter.
While TblCounter writes results in the wide format, this class writes results in the long format. Eventually, this class will replace TblCounter.
Parameters: - analyzerName (str) – the name of the Heppy analyzer, e.g., skimAnalyzerCount
- fileName (str) – the name of the counter file, e.g., SkimReport.txt
- outPath (str) – a path to the output file
- levels (list) – a list of the levels to read. If not given, all levels will be read
- columnNames (list) – a list of the column names of the output file. the default is (‘component’, ‘level’, ‘count’)