ComparisonPlot Class Reference

Inheritance diagram for ComparisonPlot:

Public Member Functions
	__init__ (self, title, comparison_result=None, png_filename=None, pdf_filename=None, contact=None, description=None, check=None, is_expert=None, plot_path=None, comparison_text=None, height=None, width=None, warnings=None)

Public Attributes
	title = title
	tile used to display this plot
	comparison_result = comparison_result
	text string for the comparison outcome
	comparison_text = comparison_text
	verbose text describing the outcome of the comparison
	png_filename = png_filename
	the filename of the png file plotted with the comparison graphs
	pdf_filename = pdf_filename
	the filename of the pdf file plotted with the comparison graphs
	plot_path = plot_path
	path were the png and pdf files are located (relative to the html directory; has to end with trailing '/'!)
	warnings = warnings
	Warnings ("no contact" person etc.)
	is_expert = is_expert
	true if this is marked as an expert-only plot
	description = description
	telling description for this plot
	check = check
	What should be checked for in this plot ?
	contact = contact
	Who is the contact person for this plot ?
	width = width
	width of the plot in pixels
	height = height
	height of the plot in pixels
	issue = issue
	linked issues

Detailed Description

One individual plot including its comparison outcome.

Definition at line 390 of file json_objects.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			title,
			comparison_result = None,
			png_filename = None,
			pdf_filename = None,
			contact = None,
			description = None,
			check = None,
			is_expert = None,
			plot_path = None,
			comparison_text = None,
			height = None,
			width = None,
			warnings = None )

Create a new ComparisonPlot object and fill all members

Definition at line 396 of file json_objects.py.

    ):
        """
        Create a new ComparisonPlot object and fill all members
        """
 
        # todo: move more into the base class
        super().__init__(
            is_expert=is_expert,
            description=description,
            check=check,
            contact=contact,
            height=height,
            width=width,
        )
        
        self.title = title
 
        
        self.comparison_result = comparison_result
 
        
        self.comparison_text = comparison_text
 
        
        self.png_filename = png_filename
 
        
        self.pdf_filename = pdf_filename
 
        
        self.plot_path = plot_path
 
        if warnings is None:
            warnings = []
        
        self.warnings = warnings
 
 

Member Data Documentation

check

check = check

inherited

What should be checked for in this plot ?

Definition at line 187 of file json_objects.py.

comparison_result

comparison_result = comparison_result

text string for the comparison outcome

Definition at line 429 of file json_objects.py.

comparison_text

comparison_text = comparison_text

verbose text describing the outcome of the comparison

Definition at line 432 of file json_objects.py.

contact

contact = contact

inherited

Who is the contact person for this plot ?

Definition at line 189 of file json_objects.py.

description

description = description

inherited

telling description for this plot

Definition at line 185 of file json_objects.py.

height

height = height

inherited

height of the plot in pixels

Definition at line 193 of file json_objects.py.

is_expert

is_expert = is_expert

inherited

true if this is marked as an expert-only plot

Definition at line 183 of file json_objects.py.

issue

issue = issue

inherited

linked issues

Definition at line 197 of file json_objects.py.

pdf_filename

pdf_filename = pdf_filename

the filename of the pdf file plotted with the comparison graphs

Definition at line 438 of file json_objects.py.

plot_path

plot_path = plot_path

path were the png and pdf files are located (relative to the html directory; has to end with trailing '/'!)

Definition at line 442 of file json_objects.py.

png_filename

png_filename = png_filename

the filename of the png file plotted with the comparison graphs

Definition at line 435 of file json_objects.py.

title

title = title

tile used to display this plot

Definition at line 426 of file json_objects.py.

warnings

warnings = warnings

Warnings ("no contact" person etc.)

Definition at line 447 of file json_objects.py.

width

width = width

inherited

width of the plot in pixels

Definition at line 191 of file json_objects.py.

---

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

• validation/scripts/json_objects.py