Implement cross correlation API

lincc-frameworks-mask-incubator / corrgi

Fast 2-point correlation estimation with LSDB and gundam

BSD 3-Clause "New" or "Revised" License

2 stars 1 forks source link

Implement cross correlation API #15

Closed camposandro closed 1 month ago

camposandro commented 2 months ago

Implements the cross-correlation API. It includes a test case that computes the counts for the projected cross-correlation for two catalogs with weights (pcf_gals_weight, pcf_gals1_weight), as well as an end-to-end test that computes the estimate with the Davis-Peebles estimator. Closes #27.

[X] My PR includes a link to the issue that I am addressing

Code Quality

[X] I have read the Contribution Guide
[X] My code follows the code style of this project
[X] My code builds (or compiles) cleanly without any errors or warnings
[X] My code contains relevant comments and necessary documentation

github-actions[bot] commented 2 months ago

Before [39e15e99]	After [f992e3e8]	Ratio	Benchmark (Parameter)
2.90±1s	3.02±1s	1.04	benchmarks.time_computation
1.96k	864	0.44	benchmarks.mem_list

Click here to view all benchmarks.

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 93.02326% with 3 lines in your changes missing coverage. Please review.

Files	Coverage Δ
src/corrgi/corrgi.py	`100.00% <100.00%> (+8.33%)`	:arrow_up:
src/corrgi/estimators/estimator_factory.py	`90.90% <100.00%> (+0.90%)`	:arrow_up:
src/corrgi/estimators/davis_peebles_estimator.py	`92.85% <92.85%> (ø)`
src/corrgi/estimators/estimator.py	`96.00% <95.00%> (-0.78%)`	:arrow_down:
src/corrgi/estimators/natural_estimator.py	`93.75% <50.00%> (-6.25%)`	:arrow_down:

... and 1 file with indirect coverage changes

camposandro commented 1 month ago

Davis-Peebles is the only estimator in Gundam for cross-correlation (the natural estimator is not available). https://github.com/lincc-frameworks-mask-incubator/corrgi/pull/25 will allow us to implement Davis-Peebles and test e2e the cross-correlation pipeline - unblocking this PR.