jobproperties – Properties of the simulation job

class penelopetools.api.input.penepma2010.jobproperties.ErrorLimit(energy=1000.0, error_characteristic=1, detector=-1)

Bases: penelopetools.api.input.penelope.option.Option

Stopping mechanism for a simulation based on the error on a photon line. If the error at a given energy of a photon detector is below the specified error, the simulation is stop. The error can either be the error on the characteristic probability density or the error on the fluorescence contribution to the probability density.

Parameters:

• energy – photon line energy (eV)
• error_characteristic – error limit on the characteristic probability density (%)
• error_fluorescence – error limit on the fluorescence contribution to the probability density (%)
• detector –

  photon detector for which the error should be below the limit

  • = -1: the simulation stops when x-ray line error is below the limit of one detector
  • = 0: the simulation stops when x-ray line error is below the limit for all detectors
  • > 0: the simulation stops when x-ray line error is below the limit of detector XLIMPD.

ATTR_DETECTOR = 'detector'

ATTR_ENERGY = 'energy_eV'

ATTR_ERROR_CHARACTERISTIC = 'errorCharacteristic'

ATTR_ERROR_FLUORESCENCE = 'errorFluorescence'

KEYWORD_XLIM = <penelopetools.api.input.penelope.util.Keyword object at 0x684e650>

TAG_NAME = 'errorLimit'

detector

Photon detector for which the error should be below the limit.

• = -1: the simulation stops when x-ray line error is below the limit of one detector
• = 0: the simulation stops when x-ray line error is below the limit for all detectors
• > 0: the simulation stops when x-ray line error is below the limit of detector XLIMPD.

energy

Photon line energy (eV), i.e. energy of interest. The energy must be between 0 and 1e6 eV. The value is stored in a magnitude.Magnitude.

error_characteristic

Error limit on the characteristic probability density (%). The limit is given in percent between 0 and 100%. The value is stored in a magnitude.Magnitude.

classmethod from_inputfile(lines)

Creates a ErrorLimit from lines of a IN file.

Parameters:lines – lines

classmethod from_xml(root)

Creates a ErrorLimit from a XML element.

Parameters:element – XML element

get_parameters(prefix)

to_html(header_level=1)

Returns a HTML representation of this option.

to_inputfile()

Returns the lines of this option to create a IN file.

to_xml()

Returns a XML representation of this option.

class penelopetools.api.input.penepma2010.jobproperties.Simulation(showers=2000000000.0, randomnumberseeds=None, time=100, errorlimit=None)

Bases: penelopetools.api.input.penelope.jobproperties.Simulation

Parameters of the simulation job.

Parameters:

• showers – number of showers to simulate
• randomnumberseeds (RandomNumberSeeds) – seeds for the random number generator
• time – time of the simulation (s)
• errorlimit (ErrorLimit) – error limit

errorlimit

Parameters of the error limit stopping mechanism. The attribute is a ErrorLimit. If the attribute is deleted, an error limit is returned. The latter has error limits of 0%, i.e. no effect on the simulation.

classmethod from_inputfile(lines)

Creates a Simulation from lines of a IN file.

Parameters:lines – lines

classmethod from_xml(root)

Creates a Simulation from a XML element.

Parameters:element – XML element

get_parameters(prefix)

to_html(header_level=1)

Returns a HTML representation of this option.

to_inputfile()

Returns the lines of this option to create a IN file.

to_xml()

Returns a XML representation of this option.