3.10.1.11.1.4. opengate.geometry.volumes

3.10.1.11.1.4.1. Classes

VolumeBase	Store information about a geometry volume:
RepeatableVolume	Store information about a geometry volume:
BooleanVolume	Volume resulting from a boolean operation of the solids contained in two volumes.
BoxVolume	Volume with a box shape.
HexagonVolume	Volume with a hexagon shape.
ConsVolume	Volume with the shape of a cone or conical section.
PolyhedraVolume	Volume with a polyhedral shape.
SphereVolume	Volume with a sphere or spherical shell shape.
TrapVolume	Volume with a generic trapezoidal shape.
TrdVolume	Volume with a symmetric trapezoidal shape.
TubsVolume	Volume with a tube or cylindrical section shape.
TesselatedVolume	Volume based on a mesh volume by reading an STL file.
RepeatParametrisedVolume	Volume created from another volume via translations.
ImageVolume	Store information about a voxelized volume
ParallelWorldVolume
VolumeTreeRoot	Small class to provide a root for the volume tree.

3.10.1.11.1.4.2. Functions

_setter_hook_user_info_rotation(self, rotation_user)	Internal function associated with user_info rotation to check its validity.
_getter_hook_user_info_rotation(self, rotation)
_setter_hook_user_info_translation(self, translation_user)
_getter_hook_user_info_translation(self, translation)
_setter_hook_user_info_mother(self, mother)	Hook to be attached to property setter of user info 'mother' in all volumes.
_setter_hook_voxel_materials(self, voxel_materials)
_setter_hook_ensure_array(self, input)
_make_boolean_volume(volume_1, volume_2, operation[, ...])
intersect_volumes(volume_1, volume_2[, translation, ...])
unite_volumes(volume_1, volume_2[, translation, ...])
subtract_volumes(volume_1, volume_2[, translation, ...])

3.10.1.11.1.4.3. Module Contents

opengate.geometry.volumes._setter_hook_user_info_rotation(self, rotation_user)

Internal function associated with user_info rotation to check its validity.

opengate.geometry.volumes._getter_hook_user_info_rotation(self, rotation)

opengate.geometry.volumes._setter_hook_user_info_translation(self, translation_user)

opengate.geometry.volumes._getter_hook_user_info_translation(self, translation)

opengate.geometry.volumes._setter_hook_user_info_mother(self, mother)

Hook to be attached to property setter of user info ‘mother’ in all volumes.

Checks if new mother is actually different from stored one.

If so, it also tries to inform the volume manager that the volume tree needs an update.

This latter part only applies for volumes which have a volume manager,

i.e. which have been added to a simulation.

opengate.geometry.volumes._setter_hook_voxel_materials(self, voxel_materials)

opengate.geometry.volumes._setter_hook_ensure_array(self, input)

class opengate.geometry.volumes.VolumeBase(*args, template=None, **kwargs)

Bases: opengate.base.DynamicGateObject, anytree.NodeMixin

Store information about a geometry volume: - G4 objects: Solid, LogicalVolume, PhysicalVolume - user parameters: user_info - additional data such as: mother, material etc

user_info_defaults

parent = None

_is_constructed = False

volume_engine = None

g4_world_log_vol = None

g4_logical_volume = None

g4_vis_attributes = None

g4_physical_volumes = []

g4_material = None

close()

Dummy implementation for inherited classes which do not implement this method.

release_g4_references()

Dummy implementation for inherited classes which do not implement this method.

__getstate__()

Method needed for pickling. May be overridden in inheriting classes.

__finalize_init__()

This method should be called once all attributes have been defined, usually at the end of the __init__ method. It defines the set of known_attribues that will be used to detect errors when the user tries to use a new attribute or misspells an attribute, e.g. box.mohter instead of box.mother.

_update_node()

Internal method which retrieves the volume object from the volume manager based on the mother’s name stored as user info ‘mother’

_request_volume_tree_update()

property volume_manager

property volume_type

property world_volume

property volume_depth_in_tree

property ancestor_volumes

property children_volumes

property number_of_repetitions

get_g4_physical_volume(index)

property translation_list

Utility property which always returns a list of translations, even if the volume is not repeated and has thus only one translation vector.

property rotation_list

Utility property which always returns a list of rotations, even if the volume is not repeated and has thus only one rotation vector.

property g4_region

property g4_physical_volume

property g4_translation

property g4_rotation

property g4_transform

property mother_g4_logical_volume

property mother_volume

construct()

construct_material()

construct_logical_volume()

construct_physical_volume()

_make_physical_volume(volume_name, g4_transform, copy_index=0)

create_changers()

set_production_cut(particle_name, value)

set_max_step_size(max_step_size)

set_max_track_length(max_track_length)

set_min_ekine(min_ekine)

set_max_time(max_time)

set_min_range(min_range)

class opengate.geometry.volumes.RepeatableVolume(*args, template=None, **kwargs)

Bases: VolumeBase

Store information about a geometry volume: - G4 objects: Solid, LogicalVolume, PhysicalVolume - user parameters: user_info - additional data such as: mother, material etc

get_repetition_name_from_index(index)

get_repetition_index_from_name(name)

construct_physical_volume()

add_dynamic_parametrisation(repetition_index=0, **params)

class opengate.geometry.volumes.BooleanVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.BooleanSolid

Volume resulting from a boolean operation of the solids contained in two volumes.

opengate.geometry.volumes._make_boolean_volume(volume_1, volume_2, operation, translation=None, rotation=None, new_name=None)

opengate.geometry.volumes.intersect_volumes(volume_1, volume_2, translation=None, rotation=None, new_name=None)

opengate.geometry.volumes.unite_volumes(volume_1, volume_2, translation=None, rotation=None, new_name=None)

opengate.geometry.volumes.subtract_volumes(volume_1, volume_2, translation=None, rotation=None, new_name=None)

class opengate.geometry.volumes.BoxVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.BoxSolid

Volume with a box shape.

class opengate.geometry.volumes.HexagonVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.HexagonSolid

Volume with a hexagon shape.

class opengate.geometry.volumes.ConsVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.ConsSolid

Volume with the shape of a cone or conical section.

class opengate.geometry.volumes.PolyhedraVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.PolyhedraSolid

Volume with a polyhedral shape.

class opengate.geometry.volumes.SphereVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.SphereSolid

Volume with a sphere or spherical shell shape.

class opengate.geometry.volumes.TrapVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.TrapSolid

Volume with a generic trapezoidal shape.

class opengate.geometry.volumes.TrdVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.TrdSolid

Volume with a symmetric trapezoidal shape.

class opengate.geometry.volumes.TubsVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.TubsSolid

Volume with a tube or cylindrical section shape.

class opengate.geometry.volumes.TesselatedVolume(*args, template=None, **kwargs)

Bases: RepeatableVolume, opengate.geometry.solids.TesselatedSolid

Volume based on a mesh volume by reading an STL file.

class opengate.geometry.volumes.RepeatParametrisedVolume(repeated_volume, *args, **kwargs)

Bases: VolumeBase

Volume created from another volume via translations.

user_info_defaults

repeated_volume

g4_repeat_parametrisation = None

close()

Dummy implementation for inherited classes which do not implement this method.

release_g4_references()

Dummy implementation for inherited classes which do not implement this method.

__getstate__()

Method needed for pickling. May be overridden in inheriting classes.

construct()

construct_physical_volume()

create_repeat_parametrisation()

class opengate.geometry.volumes.ImageVolume(*args, **kwargs)

Bases: VolumeBase, opengate.geometry.solids.ImageSolid

Store information about a voxelized volume

user_info_defaults

material_to_label_lut = None

itk_image = None

label_image = None

g4_physical_x = None

g4_physical_y = None

g4_physical_z = None

g4_logical_x = None

g4_logical_y = None

g4_logical_z = None

g4_voxel_param = None

__getstate__()

Method needed for pickling. May be overridden in inheriting classes.

close()

Dummy implementation for inherited classes which do not implement this method.

release_g4_references()

Dummy implementation for inherited classes which do not implement this method.

property size_pix

property spacing

property native_translation

property native_rotation

construct()

construct_physical_volume()

construct_logical_volume()

create_material_to_label_lut(material=None, voxel_materials=None)

read_input_image(path=None)

create_label_image(itk_image=None)

create_image_parametrisation(label_image=None)

update_label_image(label_image)

Needed for dynamic image parametrisation.

save_label_image(path=None)

create_density_image()

create_changers()

class opengate.geometry.volumes.ParallelWorldVolume(name, volume_manager)

Bases: anytree.NodeMixin

name

volume_manager

parent

parallel_world_engine = None

g4_world_phys_vol = None

g4_world_log_vol = None

release_g4_references()

close()

__getstate__()

construct()

_update_node()

class opengate.geometry.volumes.VolumeTreeRoot(volume_manager)

Bases: anytree.NodeMixin

Small class to provide a root for the volume tree.

volume_manager

name = 'volume_tree_root'

parent = None

__getstate__()