Create classes for type of correlation

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

Create classes for type of correlation #11

Closed camposandro closed 3 months ago

camposandro commented 4 months ago

Creates classes for each specific type of catalog correlation ("angular", "projected" and "redshifted"). Considering each can be used on auto and cross-correlation with or without galaxy weights, this refactoring is necessary. The goal is to have more modularity to be able to call the Fortran routines with their specific set of arguments.

[ ] 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 4 months ago

Before [83224aa5]	After [25dc54f3]	Ratio	Benchmark (Parameter)
376	3.48k	9.26	benchmarks.mem_list
2.61±0.5s	2.50±0.7s	0.96	benchmarks.time_computation

Click here to view all benchmarks.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 63.21839% with 32 lines in your changes missing coverage. Please review.

Files	Coverage Δ
src/corrgi/correlation/angular_correlation.py	`100.00% <100.00%> (ø)`
src/corrgi/corrgi.py	`92.30% <100.00%> (+0.64%)`	:arrow_up:
src/corrgi/dask.py	`77.77% <80.00%> (-7.68%)`	:arrow_down:
src/corrgi/correlation/correlation.py	`88.23% <88.23%> (ø)`
src/corrgi/correlation/projected_correlation.py	`0.00% <0.00%> (ø)`
src/corrgi/correlation/redshift_correlation.py	`0.00% <0.00%> (ø)`

... and 1 file with indirect coverage changes