Commit 954a88fc authored by Simon Spannagel's avatar Simon Spannagel
Browse files

PropagatedCharge: new carrier state UNKNOWN as initial state

parent 48da99b1

doc/usermanual/chapters/objects.tex

+1 −0
Original line number Diff line number Diff line
@@ -47,6 +47,7 @@ Timing information giving the total time to arrive at the final location, from t 
The state of the charge carrier at the end of the propagation can be retrieved via the \parameter{getState()} method. The following values are available:



\begin{description}

\item[\parameter{CarrierState::UNKNOWN}] The final state of the charge carrier is unknown, it might not have been provided by the propagation algorithm, for example.

\item[\parameter{CarrierState::MOTION}] The charge carrier was still in motion when the propagation routine finished, for example when the configured integration time was reached.

\item[\parameter{CarrierState::RECOMBINED}] The charge carrier has recombined with the silicon lattice at the given position.

\item[\parameter{CarrierState::TRAPPED}] The charge carrier has been trapped by a lattice defect at the given position.

src/objects/PropagatedCharge.hpp

+8 −7
Original line number Diff line number Diff line
@@ -24,7 +24,8 @@ namespace allpix { 
     * @brief State of the charge carrier

     */

    enum class CarrierState {

        MOTION = 0, ///< The propagated charge carrier is in motion

        UNKNOWN = 0, ///< State of the propagated charge carrier is unknown

        MOTION,      ///< The propagated charge carrier is in motion

        RECOMBINED,  ///< The propagated charge carrier has recombined with the lattice

        TRAPPED,     ///< The propagated charge carrier is trapped temporarily

        HALTED, ///< The carrier has come to a halt because it, for example, has reached the sensor surface or an implant
@@ -55,7 +56,7 @@ namespace allpix { 
                         unsigned int charge,

                         double local_time,

                         double global_time,

                         CarrierState state = CarrierState::MOTION,

                         CarrierState state = CarrierState::UNKNOWN,

                         const DepositedCharge* deposited_charge = nullptr);



        /**
@@ -75,7 +76,7 @@ namespace allpix { 
                         std::map<Pixel::Index, Pulse> pulses,

                         double local_time,

                         double global_time,

                         CarrierState state = CarrierState::MOTION,

                         CarrierState state = CarrierState::UNKNOWN,

                         const DepositedCharge* deposited_charge = nullptr);



        /**
@@ -126,7 +127,7 @@ namespace allpix { 


        std::map<Pixel::Index, Pulse> pulses_;



        CarrierState state_{CarrierState::MOTION};

        CarrierState state_{CarrierState::UNKNOWN};

    };



    /**