@@ -14,8 +14,9 @@ This module requires an installation `Geant4_GDML`. This option can be enabled b
*`file_name` : Name of the data file to create, relative to the output directory of the framework. The file extension .gdml will be appended if not present. Defaults to `Output.gdml`
### Usage
Creating a GDML output file with the name myOutputfile.gdml
Creating a GDML output file with the name `myOutputfile.gdml`:
@@ -19,32 +19,37 @@ For each model, a set of specific size parameters need to be given, of which som
##### Box:
A rectangular box which can be massive or have an hole in the middle along the z-axis.
* The `size` of the box is an XYZ vector which defines the total size of the box.
* (Optional) The `inner_size` of the box is an XYZ vector which defines the size of the volume that will be removed at the center of the original box volume. Defaults to 0mm 0mm 0mm (no volume removed).
* (Optional) The `thickness` of the box is a value which defines the thickness of the walls of a box. This has a similar effect as the parameter `inner_size`, and such they can't be used together. Defaults to 0mm.
##### Cylinder:
A cylindrical tube which can be massive or have an hole in the middle along the z-axis.
* The `outer_radius` of the cylinder is the total radius of the cylinder (in the XY-plane).
* The `length` of the cylinder is the total length of the cylinder (in the Z-direction).
* (Optional) The `inner_radius` of the cylinder is the radius of the inner cylinder. Defaults to 0mm.
* (Optional) The `starting_angle` of the cylinder is the angle at which circumference of the cylinder will start. 0 degrees refers to the point along the positive x-axis and the angle moves counter clockwise. Defaults to 0deg.
* (Optional) The `arc_length` of the cylinder is the arc-length of the circumference that will be drawn, starting from the given `starting_angle`. Defaults to 360deg which is the full circumference.
Note that the if the `arc_length` is set to 360 degrees, the \apsq framework will always draw the full circumference, regardless of the value of `starting_angle`.
##### Sphere:
A full or partly made sphere with an inner- and outer radius.
* The `outer_radius` of the sphere is the total radius of the sphere in all directions.
* (Optional) The `inner_radius` of the sphere is the radius of the inner sphere. Defaults to 0mm.
* (Optional) The `starting_angle_phi` of the sphere is the azimuthal angle at which circumference of the sphere will start in the XY-plane. 0 degrees refers to the point along the positive x-axis and the angle moves counter clockwise. Defaults to 0deg.
* (Optional) The `arc_length_phi` of the sphere is the arc-length of the circumference that will be drawn, starting from the given `starting_angle_phi` in the XY-plane. Defaults to 360deg which is the full circumference.
* (Optional) The `starting_angle_theta` of the sphere is the polar angle at which the `arc_length_theta` will start. 0 degrees refers to the point along the positive z-axis. Defaults to 0deg.
* (Optional) The `arc_length_theta` of the sphere is the arc-length of the polar angle which will be rotated around the z-axis to build the sphere, starting from the given `starting_angle_theta`. Defaults to 100deg which creates the full circle.
*
Note that `arc_length_phi` works the same as the `arc_length` from the cylinder, but the `arc_length_theta` works different.
The \apsq framework will only draw the full circle if `starting_angle_theta` = 0deg, and `arc_length_theta` = 180deg.
In all other situations, the sphere will start at `starting_angle_theta` and continue the `arc_length_theta` until `arc_length_theta` + `starting_angle_theta` = 180deg. After this it will stop.
The necessary module errors and warnings have been included to make sure the user will know will and won't be build.
Note: If the VisualizationGeant4 module is used in conjunction with and `arc_length_theta` different from 180deg, the Visualization GUI will show an error "Inconsistency in bounding boxes for solid". The origin of this error is unknown but the error can be ignored.
##### GDML:
@@ -60,6 +65,7 @@ cmake -DDGEANT4_USE_GDML=ON ..
#### Visualization Options
For each of the above mentioned models, a color and opacity can be added to the passive material.
* The `color` of the passive material is given in an R G B vector, where each color value is between 0 and 1. Defaults to `color = 0 0 1` (blue).
* The `opacity` of the passive material is given as a number between 0 and 1, where 0 is completely transparent, and 1 is completely opaque.
@@ -29,7 +29,7 @@ It should be noted that generating per-pixel pulses will generate several pulse
*`timestep`: Time step for the pulse to be generated from charge carrier arrival times. Only used if no pulse information is available for the propagated charge object. Default value is 0.01ns.
*`max_depth_distance` : Maximum distance in depth, i.e. normal to the sensor surface at the implant side, for a propagated charge to be taken into account. Only used if no pulse information is available for the propagated charge object. Defaults to `5um`.
*`collect_from_implant`: Only consider charge carriers within the implant region of the respective detector instead of the full surface of the sensor. Only used if no pulse information is available for the propagated charge object. Should only be used with non-linear electric fields and defaults to `false`.
*
### Usage
The default configuration is equal to the following:
