EventsToSidecarSummary¶
- class EventsToSidecarSummary(sum_op)[source]
Methods
|
|
|
|
Return the summary-specific information. |
|
|
Return a summary dictionary with the information. |
Return a dictionary with the details for individual files and the overall dataset. |
|
Merge summary information from all the files. |
|
|
|
Update the summary for a given tabular input file. |
Attributes
- static EventsToSidecarSummary.dump_summary(filename, summary)¶
- EventsToSidecarSummary.get_details_dict(summary_info)[source]¶
Return the summary-specific information.
- Parameters:
summary_info (TabularSummary) – Summary to return info from
Notes
Abstract method be implemented by each individual context summary.
- EventsToSidecarSummary.get_individual(summary_details, separately=True)¶
- EventsToSidecarSummary.get_summary(individual_summaries='separate')¶
Return a summary dictionary with the information.
- Parameters:
individual_summaries (str) – “separate”, “consolidated”, or “none”
- Returns:
dict - dictionary with “Dataset” and “Individual files” keys.
- Notes: The individual_summaries value is processed as follows
“separate” individual summaries are to be in separate files
“consolidated” means that the individual summaries are in same file as overall summary
“none” means that only the overall summary is produced.
- EventsToSidecarSummary.get_summary_details(include_individual=True)¶
Return a dictionary with the details for individual files and the overall dataset.
- Parameters:
include_individual (bool) – If True, summaries for individual files are included.
- Returns:
dict - a dictionary with ‘Dataset’ and ‘Individual files’ keys.
Notes
The ‘Dataset’ value is either a string or a dictionary with the overall summary.
- The ‘Individual files’ value is dictionary whose keys are file names and values are
their corresponding summaries.
Users are expected to provide merge_all_info and get_details_dict to support this.
- EventsToSidecarSummary.get_text_summary(individual_summaries='separate')¶
- EventsToSidecarSummary.get_text_summary_details(include_individual=True)¶
- EventsToSidecarSummary.merge_all_info()[source]¶
Merge summary information from all the files.
- Returns:
Consolidated summary of information.
- Return type:
TabularSummary
- EventsToSidecarSummary.save(save_dir, file_formats=['.txt'], individual_summaries='separate', task_name='')¶
- EventsToSidecarSummary.update_summary(new_info)[source]¶
Update the summary for a given tabular input file.
- Parameters:
new_info (dict) – A dictionary with the parameters needed to update a summary.
Notes
The summary needs a “name” str and a “df”.
- EventsToSidecarSummary.DISPLAY_INDENT = ' '¶
- EventsToSidecarSummary.INDIVIDUAL_SUMMARIES_PATH = 'individual_summaries'¶