Emulating detector efficiency in DDPlanarDigi

[mahmoudali2]

BEGINRELEASENOTES

• Defining a new property for the detector efficiency in DDPlanarDigi, which can take values from 0.0 to 1.0, and set by default to 1.0
• Throwing an error if the user put value > 1.0
• Inspired from Extend DDPlanarDigi with an efficiency emulator #17

ENDRELEASENOTES

[jmcarcell]

As discussed in person, here I thought it would be better to have an algorithm to simulate efficiency for any collection, instead of having to add it to each algorithm individually. So I will close this PR in favor of a generic approach to simulating efficiency.

Then @mahmoudali2 noted that because not all the hits are preserved in DDPlanarDigi, the efficiency can not be exactly (even with the changes in this PR) what is configured. There are two options to control this: MaxTries; the bigger, the more likely the hit is to be kept, and ForceHitsOntoSurface, which if set to false (default) will remove every hit for which the surf->insideBounds check from DD4hep fails. So in theory, by setting ForceHitsOntoSurface to true and MaxTries big enough, it should be possible to keep all the hits, which would allow for a previous efficiency cut to be exact.

[jmcarcell]

Closing in favor of key4hep/k4FWCore#322 to emulate efficiencies.