source – Options for the incident particle source

class penelopetools.api.input.penepma2010.source.Source(beam_energy=20000.0, position=None, polar_angle=180.0, azimuthal_angle=0.0, aperture=0.0, beam_diameter=1e-06, takeoffangle=40)

Bases: penelopetools.api.input.penelope.source.Source

Option to specify the parameters of the source beam. The PENEPMA2010 source options adds to the PENELOPE Source by specifying the diameter of the beam and the take-off angle for the photon detectors.

Parameters:

• beam_energy – energy of the source beam (eV)
• position (Position) – location of the source beam in space
• polar_angle – polar angle of the source beam axis direction (deg)
• azimuthal_angle – azimuthal angle of the source beam axis direction (deg)
• aperture – angular aperture of the source beam (deg)
• beam_diameter – diameter of the beam. The position of the beam will changed within the diameter following a Gaussian distribution (cm)
• takeoffangle – take-off angle of the photon detectors (deg)

ATTR_BEAM_DIAMETER = 'beamDiameter_cm'

ATTR_TOA = 'takeOffAngle_deg'

KEYWORD_SDIAM = <penelopetools.api.input.penelope.util.Keyword object at 0x6841c90>

beam_diameter

Diameter of the source (cm). The diameter of the source must be greater than 0. The value is stored in a magnitude.Magnitude.

classmethod from_inputfile(lines)

Creates a Source from lines of a IN file.

Parameters:lines – lines

classmethod from_xml(root)

Creates a Source from a XML element.

Parameters:element – XML element

get_parameters(prefix)

takeoffangle

Take-off angle of the photon detectors (deg). The value must be between 0 and 90 deg. The value is stored in a magnitude.Magnitude.

to_html(header_level=1)

to_inputfile()

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

to_xml()

Returns a XML representation of this option.