python.parameters.parameter.Parameter Class Reference

Class to store information about a single Powheg parameter. More...

Inheritance diagram for python.parameters.parameter.Parameter:

Collaboration diagram for python.parameters.parameter.Parameter:

Public Member Functions
def	__init__ (self, keyword=None, name=None, value=None, description=None, frozen=False, hidden=False, needs_processing=False)
	Initialise a parameter object. More...
def	__str__ (self)
	String representation. More...
def	ensure_default (self)
	Ensure that default value exists. More...
def	freeze (self)
	Freeze this parameter so that it cannot be changed. More...
def	keyword (self)
	Retrieve the Powheg keyword. More...
def	name (self)
	Retrieve the user-visible name. More...
def	needs_processing (self)
	Indicator that this parameter needs further processing. More...
def	value (self)
	Retrieve the current value of this parameter. More...
def	default_value (self)
	Retrieve the default value of this parameter (if it exists). More...
def	description (self)
	Retrieve the human-readable description string. More...
def	is_frozen (self)
	Boolean indicating whether this parameter can be changed. More...
def	is_hidden (self)
	Boolean indicating whether this parameter is visible to the user. More...
def	is_visible (self)
	Boolean indicating whether this parameter should be hidden from the user. More...
def	value (self, value)
	Set the value of this parameter (if it is not frozen). More...

Private Member Functions
def	__single_element (self, to_check)
	Return the first element if input is a list, or the input otherwise. More...

Private Attributes
	__keyword
	__name
	__description
	__value
	__default_value
	__frozen
	__hidden
	__needs_processing

Detailed Description

Class to store information about a single Powheg parameter.

Author

James Robinson james.nosp@m..rob.nosp@m.inson.nosp@m.@cer.nosp@m.n.ch

Definition at line 6 of file parameter.py.

Constructor & Destructor Documentation

__init__()

def python.parameters.parameter.Parameter.__init__	(		self,
			keyword = None,
			name = None,
			value = None,
			description = None,
			frozen = False,
			hidden = False,
			needs_processing = False
	)

Initialise a parameter object.

Parameters

keyword	Powheg keyword.
name	User-visible name.
value	Current value.
description	Human-readable description string.
frozen	True if this parameter cannot be changed.
hidden	True if this parameter should be hidden from the user.
needs_processing	True if this parameter needs further processing.

Definition at line 12 of file parameter.py.

    def __init__(self, keyword=None, name=None, value=None, description=None, frozen=False, hidden=False, needs_processing=False):
        """! Initialise a parameter object.
 
        @param keyword           Powheg keyword.
        @param name              User-visible name.
        @param value             Current value.
        @param description       Human-readable description string.
        @param frozen            True if this parameter cannot be changed.
        @param hidden            True if this parameter should be hidden from the user.
        @param needs_processing  True if this parameter needs further processing.
        """
        self.__keyword = keyword
        self.__name = name
        self.__description = description
        self.__value = value
        self.__default_value = None
        self.__frozen = frozen
        self.__hidden = hidden
        self.__needs_processing = needs_processing
 

Member Function Documentation

__single_element()

def python.parameters.parameter.Parameter.__single_element (   self,   to_check  )

private

Return the first element if input is a list, or the input otherwise.

Parameters

to_check

An iterable or non-iterable parameter

Definition at line 43 of file parameter.py.

    def __single_element(self, to_check):
        """! Return the first element if input is a list, or the input otherwise.
 
        @param to_check An iterable or non-iterable parameter
        """
        if isinstance(to_check, collections.abc.Iterable) and not isinstance(to_check, str) and len(to_check) > 0:
            return to_check[0]
        return to_check
 

__str__()

def python.parameters.parameter.Parameter.__str__

(

self

)

String representation.

Definition at line 32 of file parameter.py.

    def __str__(self):
        """! String representation."""
        current_value = [self.value, "'{}'".format(self.value)][any(x in self.name for x in ("lhrwgt", "rwl_file"))]  # some parameters need to be in quotes
        pwg_cmd = "{} {}".format(self.keyword, self.__single_element(current_value))                                  # construct command for PowhegBox
        return "{:<40}! [ATLAS default: {}] {}".format(pwg_cmd, self.default_value, self.description)
 

default_value()

def python.parameters.parameter.Parameter.default_value

(

self

)

Retrieve the default value of this parameter (if it exists).

Definition at line 77 of file parameter.py.

    def default_value(self):
        """! Retrieve the default value of this parameter (if it exists)."""
        if self.__default_value is None:
            return self.value
        return self.__default_value
 

description()

def python.parameters.parameter.Parameter.description

(

self

)

Retrieve the human-readable description string.

Definition at line 84 of file parameter.py.

    def description(self):
        """! Retrieve the human-readable description string."""
        return self.__description
 

ensure_default()

def python.parameters.parameter.Parameter.ensure_default

(

self

)

Ensure that default value exists.

Definition at line 38 of file parameter.py.

    def ensure_default(self):
        """! Ensure that default value exists."""
        if self.__default_value is None:
            self.__default_value = self.value
 

freeze()

def python.parameters.parameter.Parameter.freeze

(

self

)

Freeze this parameter so that it cannot be changed.

Definition at line 52 of file parameter.py.

    def freeze(self):
        """! Freeze this parameter so that it cannot be changed."""
        self.__frozen = True
 

is_frozen()

def python.parameters.parameter.Parameter.is_frozen

(

self

)

Boolean indicating whether this parameter can be changed.

Definition at line 89 of file parameter.py.

    def is_frozen(self):
        """! Boolean indicating whether this parameter can be changed."""
        return self.__frozen
 

is_hidden()

def python.parameters.parameter.Parameter.is_hidden

(

self

)

Boolean indicating whether this parameter is visible to the user.

Definition at line 94 of file parameter.py.

    def is_hidden(self):
        """! Boolean indicating whether this parameter is visible to the user."""
        return self.__hidden
 

is_visible()

def python.parameters.parameter.Parameter.is_visible

(

self

)

Boolean indicating whether this parameter should be hidden from the user.

Definition at line 99 of file parameter.py.

    def is_visible(self):
        """! Boolean indicating whether this parameter should be hidden from the user."""
        return not (self.__frozen or self.__hidden)
 

keyword()

def python.parameters.parameter.Parameter.keyword

(

self

)

Retrieve the Powheg keyword.

Definition at line 57 of file parameter.py.

    def keyword(self):
        """! Retrieve the Powheg keyword."""
        return self.__keyword
 

name()

def python.parameters.parameter.Parameter.name

(

self

)

Retrieve the user-visible name.

Definition at line 62 of file parameter.py.

    def name(self):
        """! Retrieve the user-visible name."""
        return self.__name
 

needs_processing()

def python.parameters.parameter.Parameter.needs_processing

(

self

)

Indicator that this parameter needs further processing.

Definition at line 67 of file parameter.py.

    def needs_processing(self):
        """! Indicator that this parameter needs further processing."""
        return self.__needs_processing
 

value() [1/2]

def python.parameters.parameter.Parameter.value

(

self

)

Retrieve the current value of this parameter.

Definition at line 72 of file parameter.py.

    def value(self):
        """! Retrieve the current value of this parameter."""
        return self.__value
 

value() [2/2]

def python.parameters.parameter.Parameter.value	(		self,
			value
	)

Set the value of this parameter (if it is not frozen).

Definition at line 104 of file parameter.py.

    def value(self, value):
        """! Set the value of this parameter (if it is not frozen)."""
        if self.__frozen:
            raise AttributeError("Parameter {} cannot be changed in jobOptions.".format(self.name))
        else:
            self.__value = value

Member Data Documentation

__default_value

python.parameters.parameter.Parameter.__default_value

private

Definition at line 27 of file parameter.py.

__description

python.parameters.parameter.Parameter.__description

private

Definition at line 25 of file parameter.py.

__frozen

python.parameters.parameter.Parameter.__frozen

private

Definition at line 28 of file parameter.py.

__hidden

python.parameters.parameter.Parameter.__hidden

private

Definition at line 29 of file parameter.py.

__keyword

python.parameters.parameter.Parameter.__keyword

private

Definition at line 23 of file parameter.py.

__name

python.parameters.parameter.Parameter.__name

private

Definition at line 24 of file parameter.py.

__needs_processing

python.parameters.parameter.Parameter.__needs_processing

private

Definition at line 30 of file parameter.py.

__value

python.parameters.parameter.Parameter.__value

private

Definition at line 26 of file parameter.py.

---

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

• parameter.py