JeffersonLab / iguana

Preservation of common physics data analysis algorithms. Currently focused on HIPO data.
https://jeffersonlab.github.io/iguana/
GNU Lesser General Public License v3.0
2 stars 7 forks source link

Algorithim scope #224

Open dglazier opened 3 months ago

dglazier commented 3 months ago

What is planned for algorithms which have different behaviour in different detector regions. For example we now have MomentumCorrection and FTEnergyCorrection, which are both momentum corrections, but apply in different places. Similarly we should get CD corrections. When using actions we are assumed to know which correction to apply. Is this the planned behaviour, or will we plan to also supply the region to the action and let it find the correction ? At the moment I am planning to add this behaviour to clas12root anyway so the user does not have to choose. Probably when using Run it does this automatically. If it is planned to keep things as they are, which is fine with me, we might want to have a standardised naming scheme, i.e. FDMomentumCorrection and FTMomentumCorrection.

c-dilks commented 3 months ago

I think a naming scheme would be good, and it should be introduced soon, since renaming things is a breaking change (unless we somehow map old names to new names internally...). An alternative is changing their namespaces, e.g. clas12::FD::MomentumCorrections.

At the very least, the algorithms' documentation needs to be clear about the algorithm domains.

What other categorizations beyond {FT,FD,CD} would be useful?