Commit ee1af7c2 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Merge branch 'p-add-warning-write' into 'master' 

ROOTObjectWriter: Add Warnings when Writing Copious Object Types

See merge request allpix-squared/allpix-squared!1058
parents d2d08689 4077cbbe

doc/usermanual/07_objects/01_object_types.md

+10 −0
Original line number Diff line number Diff line
@@ -122,6 +122,11 @@ Main parameters: 
- The [MCParticle](#mcparticle) that created the deposited charge

  ([`getMCParticle()`](https://allpix-squared.docs.cern.ch/reference/classes/classallpix_1_1depositedcharge/#function-getmcparticle))



{{% alert title="Warning" color="warning" %}}

It should be noted that in most cases, storage of DepositedCharge objects is not required. Since individual objects are

generated for every electron and hole in the event, storing them will lead to large output files and possible performance penalties.

{{% /alert %}}



For more details refer to the [code reference](https://allpix-squared.docs.cern.ch/reference/classes/classallpix_1_1depositedcharge/).



## PropagatedCharge
@@ -164,6 +169,11 @@ The following values for the carrier state are possible: 
- `CarrierState::HALTED`:

  The motion of the charge carrier has stopped, for example because it has reached an implant or the sensor surface



{{% alert title="Warning" color="warning" %}}

It should be noted that in most cases, storage of PropagatedCharge objects is not required. Since individual objects are

generated for every electron and hole in the event, storing them will lead to large output files and possible performance penalties.

{{% /alert %}}



For more details refer to the [code reference](https://allpix-squared.docs.cern.ch/reference/classes/classallpix_1_1propagatedcharge/).



## PixelCharge

etc/unittests/test_core/test_06-8_multithreading_buffered.conf

+2 −1
Original line number Diff line number Diff line
@@ -37,5 +37,6 @@ threshold = 600e 


[ROOTObjectWriter]

log_level = DEBUG

exclude = DepositedCharge, PropagatedCharge



#PASS (STATUS) [F:ROOTObjectWriter] Wrote 46070 objects to 8 branches in file
 
#PASS (STATUS) [F:ROOTObjectWriter] Wrote 94 objects to 6 branches in file

examples/eudet_with_rd53a_dut/eudet_with_rd53a_dut.conf

+1 −0
Original line number Diff line number Diff line
@@ -67,6 +67,7 @@ qdc_resolution = 1 


[ROOTObjectWriter]

file_name = "eudet_rd53a_data"

exclude = DepositedCharge, PropagatedCharge



[LCIOWriter]

file_name = "eudet_rd53a.slcio"

examples/example.conf

+1 −0
Original line number Diff line number Diff line
@@ -43,3 +43,4 @@ name = "detector2" 
mode = "gui"



[ROOTObjectWriter]

exclude = DepositedCharge, PropagatedCharge

examples/gdml_passive_material/gdml_passive_material.conf

+1 −0
Original line number Diff line number Diff line
@@ -41,3 +41,4 @@ threshold = 600e 
mode = "gui"



[ROOTObjectWriter]

exclude = DepositedCharge, PropagatedCharge