vertex_barrel.xml

<!-- SPDX-License-Identifier: LGPL-3.0-or-later -->
<!-- Copyright (C) 2022 Sylvester Joosten, Whitney Armstrong, Shujie Li -->

<lccdd>
<info name="vertex_barrel.xml"
      title="Silicon Vertex Tracker"
      author="@ShujieL"
      url="https://github.com/ShujieL"
      status="development"
      version="1.0"
><comment/>
</info>
  <define>
    <comment>
      Main parameters
    </comment>

    <constant name="VertexBarrelMod_length"             value="VertexBarrel_length"/>
    <constant name="VertexBarrelMod_rmin"               value="VertexBarrel_rmin"/>

    <constant name="SiVertexSensor_thickness"           value="40*um"/>


    <constant name="VertexBarrelMod1_rmin"              value="VertexBarrelMod_rmin"/>
    <constant name="VertexBarrelMod2_rmin"              value="VertexBarrelMod_rmin + 1.2*cm"/>
    <constant name="VertexBarrelMod3_rmin"              value="12.0*cm"/>

    <comment> ensure we are within the vertex envelope with some margin. </comment>
    <constant name="VertexCheck"                        value="sqrt(VertexBarrel_rmax - VertexBarrelMod3_rmin - .1*cm)"/>

    <documentation>
      - Currently there are 3 sensor layers. Each is composed of 2 half-cylinders modules with only 40um of silicon thickness.
      - Both support shells are 300um thick, implemented as the integrated tracker support/service setup

    </documentation>

    <constant name="VertexBarrelEnvelope_length"    value="VertexTrackingRegion_length"/>
    <constant name="VertexBarrelLayer_length"       value="VertexBarrelMod_length + 1*um"/>

    <constant name="VertexBarrelLayer_thickness"    value="0.2*cm"/>
    <constant name="VertexBarrelMod_thickness"      value="0.1*cm"/>

    <comment> Layer 3 already set as main parameter </comment>

    <constant name="VertexBarrelLayer1_rmin"        value="VertexBarrelMod1_rmin - VertexBarrelLayer_thickness/2.0"/>
    <constant name="VertexBarrelLayer1_rmax"        value="VertexBarrelLayer1_rmin + VertexBarrelLayer_thickness"/>
    <constant name="VertexBarrelLayer2_rmin"        value="VertexBarrelMod2_rmin - VertexBarrelLayer_thickness/2.0"/>
    <constant name="VertexBarrelLayer2_rmax"        value="VertexBarrelLayer2_rmin + VertexBarrelLayer_thickness"/>
    <constant name="VertexBarrelLayer3_rmin"        value="VertexBarrelMod3_rmin - VertexBarrelLayer_thickness/2.0"/>
    <constant name="VertexBarrelLayer3_rmax"        value="VertexBarrelLayer3_rmin + VertexBarrelLayer_thickness"/>

    <comment>
      Extra parameters to approximate a cylinder as a set of skinny staves
      due to ACTS limitations.
      FIXME: this shouldn't be needed anymore, need to update the cylindrical plugin.
    </comment>
    <constant name="VertexBarrelStave_count"       value="128"/>
    <constant name="VertexBarrelStave1_width"      value="2*VertexBarrelMod1_rmin * tan(180*degree/VertexBarrelStave_count)"/>
    <constant name="VertexBarrelStave2_width"      value="2*VertexBarrelMod2_rmin * tan(180*degree/VertexBarrelStave_count)"/>
    <constant name="VertexBarrelStave3_width"      value="2*VertexBarrelMod3_rmin * tan(180*degree/VertexBarrelStave_count)"/>
  </define>

  <detectors>
    <documentation level="5">
        ### Actual detectors
    </documentation>
    <detector
      id="VertexBarrel_0_ID"
      name="VertexBarrel"
      type="epic_VertexBarrel"
      readout="VertexBarrelHits"
      insideTrackingVolume="true">
      <type_flags type="DetType_TRACKER + DetType_BARREL"/>
      <dimensions
        rmin="VertexBarrelLayer1_rmin"
        rmax="VertexBarrelLayer3_rmax"
        length="VertexBarrelEnvelope_length" />
      <comment>Vertex Barrel Modules</comment>
      <module name="Module1" vis="VertexLayerVis">
        <module_component name="ITS3"
                          material="Silicon"
                          sensitive="true"
                          width="VertexBarrelStave1_width"
                          length="VertexBarrelMod_length"
                          thickness="SiVertexSensor_thickness"
                          vis="VertexLayerVis" />
      </module>
      <module name="Module2" vis="VertexLayerVis">
        <module_component name="ITS3"
                          material="Silicon"
                          sensitive="true"
                          width="VertexBarrelStave2_width"
                          length="VertexBarrelMod_length"
                          thickness="SiVertexSensor_thickness"
                          vis="VertexLayerVis" />
      </module>
      <module name="Module3" vis="VertexLayerVis">
        <module_component name="ITS3"
                          material="Silicon"
                          sensitive="true"
                          width="VertexBarrelStave3_width"
                          length="VertexBarrelMod_length"
                          thickness="SiVertexSensor_thickness"
                          vis="VertexLayerVis" />
      </module>
      <comment> Layers composed of many arrayed modules  </comment>
      <layer module="Module1" id="1" vis="VertexLayerVis">
        <barrel_envelope
          inner_r="VertexBarrelLayer1_rmin"
          outer_r="VertexBarrelLayer1_rmax"
          z_length="VertexBarrelLayer_length" />
        <layer_material surface="inner" binning="binPhi,binZ" bins0="VertexBarrelStave_count" bins1="100" />
        <comment>
          phi0     : Starting phi of first module.
          phi_tilt : Phi tilt of a module.
          rc       : Radius of the module center.
          nphi     : Number of modules in phi.
          rphi_dr  : The delta radius of every other module.
          z0       : Z position of first module in phi.
          nz       : Number of modules to place in z.
          dr       : Radial displacement parameter, of every other module.
        </comment>
        <rphi_layout phi_tilt="0.0*degree" nphi="VertexBarrelStave_count" phi0="0.0" rc="VertexBarrelMod1_rmin" dr="0.0 * mm"/>
        <z_layout dr="0.0 * mm" z0="0.0 * mm" nz="1"/>
      </layer>
      <layer module="Module2" id="2" vis="VertexLayerVis">
        <barrel_envelope
          inner_r="VertexBarrelLayer2_rmin"
          outer_r="VertexBarrelLayer2_rmax"
          z_length="VertexBarrelLayer_length" />
        <layer_material surface="inner" binning="binPhi,binZ" bins0="VertexBarrelStave_count" bins1="100" />
        <rphi_layout phi_tilt="0.0*degree" nphi="VertexBarrelStave_count" phi0="0.0" rc="VertexBarrelMod2_rmin" dr="0.0 * mm"/>
        <z_layout dr="0.0 * mm" z0="0.0 * mm" nz="1"/>
      </layer>
      <layer module="Module3" id="4" vis="VertexLayerVis">
        <barrel_envelope
          inner_r="VertexBarrelLayer3_rmin"
          outer_r="VertexBarrelLayer3_rmax"
          z_length="VertexBarrelLayer_length" />
        <layer_material surface="inner" binning="binPhi,binZ" bins0="VertexBarrelStave_count" bins1="100" />
        <rphi_layout phi_tilt="0.0*degree" nphi="VertexBarrelStave_count" phi0="0.0" rc="VertexBarrelMod3_rmin" dr="0.0 * mm"/>
        <z_layout dr="0.0 * mm" z0="0.0 * mm" nz="1"/>
      </layer>
    </detector>
  </detectors>

  <plugins>
    <plugin name="DD4hep_ParametersPlugin">
      <argument value="VertexBarrel"/>
      <argument value="layer_pattern: str=VertexBarrel_layer\d"/>
    </plugin>
  </plugins>

  <readouts>
    <readout name="VertexBarrelHits">
      <segmentation type="CartesianGridXY" grid_size_x="0.020*mm" grid_size_y="0.020*mm" />
      <id>system:8,layer:4,module:12,sensor:2,x:32:-16,y:-16</id>
    </readout>
  </readouts>

</lccdd>