Modules

Description and parameter documentation of all available Allpix Squared modules.

This section describes all currently available modules in detail. This comprises a description of the physics implemented as well as a list of all configuration parameters along with their default values. For inquiries about a specific module or its documentation, the respective module maintainers should be contacted directly. The modules are listed in alphabetical order.


CapacitiveTransfer

Transfer with cross-coupling between pixels

CorryvreckanWriter

Writes pixel hits in the Corryvreckan format

CSADigitizer

Digitizer emulating a Charge Sensitive Amplifier

DatabaseWriter

Writes simulation objects to a PostgreSQL database

DefaultDigitizer

Digitizer that creates a signal proportional to the collected charge

DepositionCosmics

Energy deposition from cosmic rays

DepositionGeant4

Energy deposition with Geant4

DepositionGenerator

Energy deposition with data read from MC Generator Data Files

DepositionLaser

A simplistic deposition generator for charge injection with a laser

DepositionPointCharge

Energy deposition at deterministic positions

DepositionReader

Energy deposition with information read from a file

DetectorHistogrammer

Provisional simulation analysis for a detector

DopingProfileReader

Doping profile loading for a detector

Dummy

A dummy module

ElectricFieldReader

Electric field loading for a detector

GDMLOutputWriter

Writes the geometry to a GDML file

GenericPropagation

Propagates deposited charges via piecewise integration of motion

GeometryBuilderGeant4

Constructs the Geant4 geometry

InducedTransfer

Transfer with induction from nearby charge carriers

LCIOWriter

Writes pixel hits to a LCIO file

MagneticFieldReader

Magnetic field loading for a detector

ProjectionPropagation

Propagates deposited charges via projection to the sensor surface

PulseTransfer

Transfer of pulse information to the electronics

RCEWriter

Writes pixel hits in the RCE format

ROOTObjectReader

Reads stored data from an Allpix Squared ROOT file

ROOTObjectWriter

Writes simulation objects to a ROOT file

SimpleTransfer

Transfers propagated charges to the pixel front-end

TextWriter

Writes simulation objects to a text file

TransientPropagation

Propagation of deposited charges via Shockley-Ramo induction

VisualizationGeant4

Constructs a Geant4 viewer to display the geometry

WeightingPotentialReader

Weighting potential loading for a detector