MetaOptionParser Class Reference

Public Member Functions
def	__init__ (self, Optional[Iterable] meta_option_list=None)
bool	has_option (self, str option_name)
float	pvalue_warn (self)
float	pvalue_error (self)
float	float_value (self, key, Optional[float] default=None)
int	int_value (self, key, Optional[int] default=None)
def	parse_key_value (self, str key)

Detailed Description

Class to simplify the parsing of plot options
supplied by the MetaOption named object attached
to root plots.

A typical meta options list might look like this:
["pvalue-warn=0.9", "pvalue-error=0.4"]

Definition at line 15 of file metaoptions.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		Optional[Iterable]	meta_option_list = None
	)

Initialize MetaOptionParser
@param meta_option_list: list of meta options read from ROOT object
    or None

Definition at line 25 of file metaoptions.py.

    def __init__(self, meta_option_list: Optional[Iterable] = None):
        """
        Initialize MetaOptionParser
        @param meta_option_list: list of meta options read from ROOT object
            or None
        """
        if meta_option_list is None:
            meta_option_list = []
        meta_option_list = list(meta_option_list)
        
        self.mo: List[str] = meta_option_list
 

Member Function Documentation

float_value()

float float_value	(		self,
			key,
		Optional[float]	default = None
	)

Extract the float value from a meta option list
@param key: the key to identify the value from the list
@param default: default value
@return: The float value or the default value if this key did not exist
         or the float value could not be parsed.

Definition at line 61 of file metaoptions.py.

has_option()

bool has_option	(		self,
		str	option_name
	)

Checks whether an option is contained in the
meta options
@param option_name: name of the option to check for
@return: True if the option is contained in the meta option list
         False otherwise

Definition at line 37 of file metaoptions.py.

int_value()

int int_value	(		self,
			key,
		Optional[int]	default = None
	)

Extract the int value from a meta option list
@param key: the key to identify the value from the list
@param default: default value
@return: The int value or None if this key did not exist
         or the float value could not be parsed.

Definition at line 77 of file metaoptions.py.

parse_key_value()

def parse_key_value	(		self,
		str	key
	)

Searches the meta options list for a key value entry and parses it
@param key: The key to look for
@retun: The value which was associated to the key or None if the
        key was not found.

Definition at line 93 of file metaoptions.py.

pvalue_error()

float pvalue_error

(

self

)

@return: The custom error level for the pvalue setting of plot
         comparison. None if no custom value was set for the plot.

Definition at line 54 of file metaoptions.py.

pvalue_warn()

float pvalue_warn

(

self

)

@return: The custom warning level for the pvalue setting of plot
         comparison. None if no custom value was set for the plot.

Definition at line 47 of file metaoptions.py.

---

The documentation for this class was generated from the following file:

• validation/scripts/metaoptions.py