3.1.2.11. opengate.physics

3.1.2.11.1. Module Contents

3.1.2.11.1.1. Classes

UserLimitsPhysics	Class to be registered to physics list.
Region	FIXME: Documentation of the Region class.
OpticalSurface	Class used to create an Optical Surface between two volumes

3.1.2.11.1.2. Functions

translate_particle_name_gate_to_geant4(name)	Convenience function to translate from names
get_enum_values(enum_class)
load_optical_surface_properties_from_xml(...)	This function extracts the information related to multiple surfaces
load_optical_properties_from_xml(...)	This function parses an xml file containing optical material properties.
create_g4_optical_properties_table(...)	Creates and fills a G4MaterialPropertiesTable with values from a dictionary created by a parsing function,

3.1.2.11.1.3. Attributes

cut_particle_names

opengate.physics.cut_particle_names

opengate.physics.translate_particle_name_gate_to_geant4(name)

Convenience function to translate from names used in Gate to those in G4, if necessary. Concerns e.g. ‘electron’ -> ‘e-’

class opengate.physics.UserLimitsPhysics

Bases: opengate_core.G4VPhysicsConstructor

Class to be registered to physics list.

It is essentially a refined version of StepLimiterPhysics which considers the user’s particles choice of particles to which the step limiter should be added.

close()

ConstructParticle()

Needs to be defined because C++ base class declares this as purely virtual member.

ConstructProcess()

Overrides method from G4VPhysicsConstructor that is called when the physics list is constructed.

class opengate.physics.Region(*args, **kwargs)

Bases: opengate.base.GateObject

FIXME: Documentation of the Region class.

user_info_defaults

reset()

close()

release_g4_references()

to_dictionary()

from_dictionary(d)

need_step_limiter()

need_user_special_cut()

associate_volume(volume)

dump_production_cuts()

initialize()

This method wraps around all initialization methods of this class.

It should be called from the physics_engine, after setting the self.physics_engine attribute.

initialize_volume_dictionaries()

initialize_g4_region()

initialize_g4_production_cuts()

initialize_g4_user_limits()

initialize_em_switches()

opengate.physics.get_enum_values(enum_class)

opengate.physics.load_optical_surface_properties_from_xml(surface_properties_file, surface_name)

This function extracts the information related to multiple surfaces from SurfaceProperties.xml

opengate.physics.load_optical_properties_from_xml(optical_properties_file, material_name)

This function parses an xml file containing optical material properties. Fetches property elements and property vector elements.

Returns a dictionary with the properties or None if the material is not found in the file.

opengate.physics.create_g4_optical_properties_table(material_properties_dictionary)

Creates and fills a G4MaterialPropertiesTable with values from a dictionary created by a parsing function, e.g. from an xml file. Returns G4MaterialPropertiesTable.

class opengate.physics.OpticalSurface(*args, **kwargs)

Bases: opengate.base.GateObject

Class used to create an Optical Surface between two volumes

G4OpticalSurface is used to create an optical surface

G4LogicalBorderSurface is used to assign the optical surface between two volumes.

user_info_defaults

release_g4_references()

close()

reset()

__getstate__()

initialize()