3.10.1.11.1.1. opengate.geometry.materials

3.10.1.11.1.1.1. Classes

ElementBuilder	A description of a G4Element that can be build.
MaterialBuilder	A description of a material, that will can be built on demand.
MaterialDatabase	Manage a unique list of Geant4 materials and elements.

3.10.1.11.1.1.2. Functions

read_voxel_materials(filename[, def_mat])
HU_read_materials_table(file_mat)
HU_read_density_table(file_density)
HU_linear_interpolate_densities(hu, densities)
HU_find_max_density_difference(hu_min, hu_max, d_min, ...)
HounsfieldUnit_to_material(simulation, ...)	Same function than in GateHounsfieldToMaterialsBuilder class.
dump_material_like_Gate(mat)
assert_same_material(m1, m2)
read_next_line(f)
read_tag(s, tag)
read_tag_with_unit(s, tag)
create_density_img(img_volume, material_database)	Parameters
create_mass_img(ct_itk, hu_density_file[, overrides])	Parameters

3.10.1.11.1.1.3. Module Contents

opengate.geometry.materials.read_voxel_materials(filename, def_mat='G4_AIR')

opengate.geometry.materials.HU_read_materials_table(file_mat)

opengate.geometry.materials.HU_read_density_table(file_density)

opengate.geometry.materials.HU_linear_interpolate_densities(hu, densities)

opengate.geometry.materials.HU_find_max_density_difference(hu_min, hu_max, d_min, d_max, densities)

opengate.geometry.materials.HounsfieldUnit_to_material(simulation, density_tolerance, file_mat, file_density)

Same function than in GateHounsfieldToMaterialsBuilder class. Probably far from optimal, put we keep the compatibility

opengate.geometry.materials.dump_material_like_Gate(mat)

opengate.geometry.materials.assert_same_material(m1, m2)

opengate.geometry.materials.read_next_line(f)

opengate.geometry.materials.read_tag(s, tag)

opengate.geometry.materials.read_tag_with_unit(s, tag)

opengate.geometry.materials.create_density_img(img_volume, material_database)

3.10.1.11.1.1. Parameters

img_volumeImageVolume

opengate ImageVolume class instance

material_databasedict

dictionary with keys: material name, values: G4 material obj

3.10.1.11.1.1. Returns

rhoitk.Image

image of the same size and resolution of the ct. The voxel value is the density of the voxel. Density is returned in G4 1/kg.

opengate.geometry.materials.create_mass_img(ct_itk, hu_density_file, overrides=dict())

3.10.1.11.1.1. Parameters

ct_itk :itk.Image

ct image

hu_density_filestr

filepath of the HU to density table

overridesdict, optional

Dict where keys are HU to be overwritten and values are density values. The default is dict().

3.10.1.11.1.1. Returns

massitk.Image

image of the same size and resolution of the ct. The voxel value is the mass of the voxel. Mass is returned in grams.

class opengate.geometry.materials.ElementBuilder(material_database)

A description of a G4Element that can be build.

type = 'element'

name = None

symbol = None

Zeff = None

Aeff = None

material_database

__repr__()

read(line)

build()

class opengate.geometry.materials.MaterialBuilder(material_database)

A description of a material, that will can be built on demand. A material is described by a list of components that can be elements or sub-materials.

type = 'material'

name = None

symbol = None

density = None

n = None

state = None

components

material_database

__repr__()

read(f, line)

read_one_element(line)

read_one_submat(line)

build()

add_element_to_material(mat, elem)

add_submat_to_material(mat, elem)

class opengate.geometry.materials.MaterialDatabase

Manage a unique list of Geant4 materials and elements. The materials/elements are read in a DB txt file or in NIST. They are only build on demand, during the geometry Construct

filenames = []

material_builders

material_builders_by_filename

element_builders

element_builders_by_filename

new_materials_nb_atoms

new_materials_weights

g4_materials

g4_elements

current_section = None

current_filename = None

g4_NistManager = None

nist_material_names = None

nist_element_names = None

__getstate__()

__setstate__(state)

read_from_file(filename)

read_one_item(f, line)

init_NIST()

add_material_nb_atoms(*args)

Usage example: “Lead”, [“Pb”], [1], 11.4 * gcm3 “BGO”, [“Bi”, “Ge”, “O”], [4, 3, 12], 7.13 * gcm3)

add_material_weights(*args)

Usage example : add_material_weights(name, elems_symbol_nz, weights_nz, 3 * gcm3)

initialize()

init_user_mat()

FindOrBuildMaterial(material_name)

FindOrBuildElement(element_name)

get_database_material_names(db=None)