API: Calculator

[teddyrendahl]

Details

API

• combinations is now callable. In certain cases, operators may not want to prefocus with XRT lenses. This function is now callable with an include_prefocus option
• find_combinations is now find_solution. At first conception, it was thought that operators might want multiple solutions to try when requesting a focal plane. In practice, the best returned solution has been the best answer. In the future what this method really needs is keywords to force certain lenses in or out. i.e don't include prefocusing lens 2.

Deprecations

• TransfocatorCombo was an unwieldy object and largely unnecessary. This was completely factored out.

Maintenance

• Prefocusing should be included in the nlens count.
• We no longer care about the limits when requesting combinations. A bit of backstory, when this module was first written it took a long time for the correct solution to be found. A quick speed-up we thought of was to only include combinations that passed the interlock. Afterwards, it was discovered that the EPICS calls were being very inefficiently and now the entire parameter space can be iterated through very quickly. In practice, the calculator will never suggest a lens combination that is unsafe unless the user requests an unsafe location to focus.

[codecov-io]

Codecov Report

Merging #16 into master will increase coverage by 0.67%. The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #16      +/-   ##
==========================================
+ Coverage   87.34%   88.02%   +0.67%     
==========================================
  Files           4        4              
  Lines         166      142      -24     
==========================================
- Hits          145      125      -20     
+ Misses         21       17       -4

Impacted Files	Coverage Δ
transfocate/config.py	0% <ø> (ø)	:arrow_up:
transfocate/calculator.py	100% <100%> (+7.14%)	:arrow_up:
transfocate/transfocator.py	100% <100%> (ø)	:arrow_up:
transfocate/lens.py	82.69% <100%> (-1.31%)	:arrow_down:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 80191a4...0dd0a74. Read the comment docs.