PlottingManager

class pyMaCh3._pyMaCh3.plotting.PlottingManager

Bases: pybind11_object

Methods Summary

`get_draw_grid`(self)	Get wheter or not the user has specified the 'draw grid' (-g) option
`get_draw_options`(self)	Get any additional root drawing options specified by the user
`get_file_label`(self, input_file_id)	Get the specified label of a particular input file
`get_file_labels`(self)	Get the list of all file labels
`get_file_name`(self, input_file_id)	Get the path to a particular file
`get_file_names`(self)	Get the list of all file names
`get_n_files`(self)	Get the number of specified files
`get_output_name`(self[, suffix])	Get the output name specified by the user, can specify an additional suffix to append to the file name but before the file extension
`get_plot_ratios`(self)	Get whether or not the user specified the 'plot ratios' (-r) option
`get_split_by_sample`(self)	Get whether or not the user has set the 'split by sample' (-s) option
`initialise`(self)	initalise this PlottingManager
`input`(self)	Get the InputManager associated with this PlottingManager
`parse_inputs`(self, arguments)	Parse command line variables
`set_exec`(self, exec_name)	Set the name of the current executable, which will be used when getting executable specific options from the plotting config file
`style`(self)	Get the StyleManager associated with this PlottingManager
`usage`(self)	Print a usage message for the current executable

Methods Documentation

get_draw_grid(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → bool: Get wheter or not the user has specified the ‘draw grid’ (-g) option

get_draw_options(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → str: Get any additional root drawing options specified by the user

get_file_label(self: pyMaCh3._pyMaCh3.plotting.PlottingManager, input_file_id: int) → str: Get the specified label of a particular input file

get_file_labels(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → list[str]: Get the list of all file labels

get_file_name(self: pyMaCh3._pyMaCh3.plotting.PlottingManager, input_file_id: int) → str: Get the path to a particular file

get_file_names(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → list[str]: Get the list of all file names

get_n_files(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → int: Get the number of specified files

get_output_name(self: pyMaCh3._pyMaCh3.plotting.PlottingManager, suffix: str = '') → str: Get the output name specified by the user, can specify an additional suffix to append to the file name but before the file extension

get_plot_ratios(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → bool: Get whether or not the user specified the ‘plot ratios’ (-r) option

get_split_by_sample(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → bool: Get whether or not the user has set the ‘split by sample’ (-s) option

initialise(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → None: initalise this PlottingManager

input(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → MaCh3Plotting::InputManager: Get the InputManager associated with this PlottingManager

parse_inputs(self: pyMaCh3._pyMaCh3.plotting.PlottingManager, arguments: list[str]) → None: Parse command line variables

set_exec(self: pyMaCh3._pyMaCh3.plotting.PlottingManager, exec_name: str) → None: Set the name of the current executable, which will be used when getting executable specific options from the plotting config file

style(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → MaCh3Plotting::StyleManager: Get the StyleManager associated with this PlottingManager

usage(self: pyMaCh3._pyMaCh3.plotting.PlottingManager) → None: Print a usage message for the current executable