ComparisonPlotFile Class Reference

Inheritance diagram for ComparisonPlotFile:

Public Member Functions
def	__init__ (self, package, title, rootfile, compared_revisions=None, plots=None, has_reference=False, ntuples=None, html_content=None, description=None)

Public Attributes
	compared_revision
	label of the revision which were used in this comparison
	ntuples
	the ntuples which were compared
	html_content
	user's html content
	has_reference
	true if a reference file is available for this plot file
	comparison_error
	the number of failed comparisons in this file
	comparison_error_shifter
	the number of failed comparisons of shifter plots in this file
	comparison_warning
	the number of comparisons which resulted in a warning
	comparison_warning_shifter
	the number of comparisons of shifter plots in this file which resulted in a warning
	n_shifter_ntuples
	Number of shifter ntuples.
	show_shifter
	Show to shifter, i.e.

Detailed Description

Contains information about a file containing plots and the comparison which
have been performed for the content of this file

Definition at line 310 of file json_objects.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			package,
			title,
			rootfile,
			compared_revisions = None,
			plots = None,
			has_reference = False,
			ntuples = None,
			html_content = None,
			description = None
	)

Create a new ComparisonPlotFile object and fill all members

Reimplemented from PlotFile.

Definition at line 317 of file json_objects.py.

    ):
        """
        Create a new ComparisonPlotFile object and fill all members
        """
 
        if not plots:
            plots = []
        if not ntuples:
            ntuples = []
        if not html_content:
            html_content = []
 
        super().__init__(
            package, title, rootfile, plots, description=description
        )
        
        self.compared_revision = compared_revisions
        
        self.ntuples = ntuples
        
        self.html_content = html_content
 
        
        self.has_reference = has_reference
 
        
        self.comparison_error = len(
            [plt for plt in self.plots if plt.comparison_result == "error"]
        )
        
        self.comparison_error_shifter = len(
            [
                plt
                for plt in self.plots
                if (not plt.is_expert) and plt.comparison_result == "error"
            ]
        )
        
        self.comparison_warning = len(
            [plt for plt in self.plots if plt.comparison_result == "warning"]
        )
        
        self.comparison_warning_shifter = len(
            [
                plt
                for plt in self.plots
                if (not plt.is_expert) and plt.comparison_result == "warning"
            ]
        )
 
        
        self.n_shifter_ntuples = sum(
            [not tuple.is_expert for tuple in self.ntuples]
        )
 
        
        self.show_shifter = bool(
            self.n_shifter_plots or self.n_shifter_ntuples or self.html_content
        )
 
 

Member Data Documentation

compared_revision

compared_revision

label of the revision which were used in this comparison

Definition at line 344 of file json_objects.py.

comparison_error

comparison_error

the number of failed comparisons in this file

Definition at line 354 of file json_objects.py.

comparison_error_shifter

comparison_error_shifter

the number of failed comparisons of shifter plots in this file

Definition at line 358 of file json_objects.py.

comparison_warning

comparison_warning

the number of comparisons which resulted in a warning

Definition at line 366 of file json_objects.py.

comparison_warning_shifter

comparison_warning_shifter

the number of comparisons of shifter plots in this file which resulted in a warning

Definition at line 371 of file json_objects.py.

has_reference

has_reference

true if a reference file is available for this plot file

Definition at line 351 of file json_objects.py.

html_content

html_content

user's html content

Definition at line 348 of file json_objects.py.

n_shifter_ntuples

n_shifter_ntuples

Number of shifter ntuples.

Definition at line 380 of file json_objects.py.

ntuples

ntuples

the ntuples which were compared

Definition at line 346 of file json_objects.py.

show_shifter

show_shifter

Show to shifter, i.e.

is there at least one non-expert plot?

Definition at line 385 of file json_objects.py.

---

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

• validation/scripts/json_objects.py