Skip to content

Interfaces refactoring#369

Draft
israelmcmc wants to merge 142 commits intocositools:developfrom
israelmcmc:interfaces
Draft

Interfaces refactoring#369
israelmcmc wants to merge 142 commits intocositools:developfrom
israelmcmc:interfaces

Conversation

@israelmcmc
Copy link
Collaborator

@israelmcmc israelmcmc commented Jun 30, 2025 •
edited
Loading

Work in progress...

This is a major refactoring of cosipy to make it more modular, using interfaces (protocols) to decouple the inputs/outputs of different classes from their implementation.

There are currently three examples that serve as an entry point to see the interfaces usage:

Presentations:

20250630-CosipyInterfacesUpdate-Israel.pdf (at version 214f2ae)

Installation notes and troubleshooting:

TODO list:

  • Binned analysis toy example
  • GRB spectral fit (using dwel time map / local coordinates)
  • Crab spectral fit (using scatt map / galactic coordinate)
  • Unbinned analysis toy example
  • Extended source response
  • Propagate to source injector
  • Propagate to TS map
  • Propagate to imaging deconvolution
  • Merge with Jeremy's and other recent PRs
  • Update all notebooks
  • Fix all tests

israelmcmc added 30 commits April 12, 2025 11:22
@israelmcmc
Cell magics are run ina subprocess and the errors are captured, there…
1a50424 
…fore failing tutorials were showing as passing.

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Remove only magic cell. I think magic lines are not problematic
6559f84 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Add test for magic cells. Also serves as a negative control
55d9d7e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Change test name
0e408cc 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fail successfully = Green!
83d04af 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix file checksum in ts map tutorial
beafef0 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Catch nb failure exception to allow notebook to still be saved and cl…
122d4ad 
…ean log file handler

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Initial take at new interfaces needed by COSILike
9f7b717 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
COSILike implementation using interfaces. WiP
3101a1e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Some more changes
2eb9a2f 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Toy example working
d6521ca 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Remove NullBackground. A None is enough
f960da5 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Make all interfaces explicit protocols
1841881 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Example separate base bkg from 3ml interface
0f55653 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix indent
0ba0ebf 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Add explanations to toy example
a4ec731 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Rename toy example interfaces
99e84e7 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix import warnings
f24c19d 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Null background no longer exists
d358b73 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix type hints for kwargs
6fc062e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Divide 3ML model response from 3ML source response. The former can us…
35dc2f3 
…e multiple instances of the latter, once per source

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Save progress. Working on: Moving PSR calculation from COSILIKE > get…
d5d1dec 
…_scatt_map > SC file refactoring

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Refactor SpacecraftFile. Unit tests WiP
b4a962a 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
All SpacecraftFile tests passing
62d4541 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
All rsp to arf&rmf converter tests are passing
e70cae7 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Rename SC file open. Eventually this function should be able to eithe…
c276bfb 
…r open the official FITS file, or parse the .ori file. It's better to keep it generic for now.

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Separate .ori parsing from future formats
dea56c1 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix bug on SpacecraftFile select_interval for edge cases
2e3b28c 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Using pandas instead of np.loadtxt since it's way faster
795bd48 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
All elements are ready for a basic GRB fit. Still testing.
eefb6f3 
Signed-off-by: Israel Martinez <imc@umd.edu>
israelmcmc and others added 25 commits October 26, 2025 19:03
@israelmcmc
WIP. Most distributions ready for the ideal response.
1994b0c 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Revert. The number of detected events is handled the effective area. …
be356d1 
…Separately.

Signed-off-by: Israel Martinez <imc@umd.edu>
@hiyoneda
Added the method apply_gti to SpacecraftHistory
baf805b
@israelmcmc
Relative coordinates
99c230e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Faster conversion by avoiding intermediate perpendicular vector step.…
a061b98 
… Suggestion by Pascal

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
ideal response random event working!
a5780ff 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
ideal response pdf working!
09cbaf2 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Polarized and unpolarized version
b16324f 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Merge pull request #7 from hiyoneda/spacecrafthistory_with_gti
fd5495a 
Added the method apply_gti to SpacecraftHistory
@israelmcmc
Revert "Added the method apply_gti to SpacecraftHistory"
b44f36b
@israelmcmc
Merge pull request #8 from israelmcmc/revert-7-spacecrafthistory_with…
c5d8e82 
…_gti

Revert "Added the method apply_gti to SpacecraftHistory"
@israelmcmc
Merge pull request #6 from hiyoneda/gti_interface
f0e1519 
Updating TimeSelector
@israelmcmc
Protect unbinned likelihood from ill defined expectation
db9d000 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Add missing event type
8f4918e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Working example of ideal irf
5d63189 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
convenience function to get array of all values
d8f1547 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Ideal response analysis. All working.
fc913af 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Match FWHM 3deg
0dcbddb 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Clean example a little bit
15ddd5e 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
get nevents
40d0de0 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Add tests for SCHistory attitude and location interpolation
dce3ee7 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Bring back improvements to SpacecraftHistory interpolations (back whe…
907f3ee 
…n it was called SpacecraftFile) by jdbuhler in PR cositools#378 (using SLERP)

Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Merge branch 'develop' into interfaces_dev_merge
6c7c53e 
# Conflicts:
#	cosipy/data_io/UnBinnedData.py
#	cosipy/event_selection/good_time_interval.py
#	cosipy/image_deconvolution/coordsys_conversion_matrix.py
#	cosipy/polarization/polarization_angle.py
#	cosipy/polarization_fitting/polarization_asad.py
#	cosipy/response/PointSourceResponse.py
#	cosipy/spacecraftfile/SpacecraftFile.py
#	cosipy/spacecraftfile/__init__.py
#	cosipy/test_data/image_deconvolution/unit_test_file.ipynb
#	cosipy/threeml/COSILike.py
#	cosipy/ts_map/fast_ts_fit.py
#	docs/tutorials/response/DetectorResponse.ipynb
#	docs/tutorials/response/PSR_with_Earth_occultation_example.ipynb
#	docs/tutorials/response/SpacecraftFile.ipynb
#	docs/tutorials/spectral_fits/extended_source_fit/diffuse_511_spectral_fit.ipynb
#	tests/image_deconvolution/test_coordsys_conversion_matrix.py
#	tests/image_deconvolution/test_exposure_table.py
#	tests/polarization/test_polarization_asad.py
#	tests/spacecraftfile/test_spacecraftfile.py
#	tests/ts_map/test_fast_ts_map.py
@israelmcmc
Make interpolation work with multiple inputs
363b256 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Make crab binned fit work with latest develop
317ab82 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc israelmcmc force-pushed the interfaces branch 2 times, most recently from 87d3286 to 317ab82 Compare January 28, 2026 14:55
@israelmcmc
Merge branch 'develop' into interfaces_devmerge
7e9e987 
# Conflicts:
#	cosipy/data_io/BinnedData.py
#	cosipy/data_io/UnBinnedData.py
#	cosipy/image_deconvolution/exposure_table.py
#	cosipy/source_injector/source_injector.py
#	cosipy/test_data/image_deconvolution/unit_test_file.ipynb
#	cosipy/threeml/COSILike.py
#	docs/tutorials/source_injector/Extended_source_injector.ipynb
#	docs/tutorials/source_injector/Point_source_injector.ipynb
#	docs/tutorials/spectral_fits/continuum_fit/crab/SpectralFit_Crab.ipynb
#	docs/tutorials/spectral_fits/extended_source_fit/diffuse_511_spectral_fit.ipynb
#	tests/image_deconvolution/test_exposure_table.py
@israelmcmc
Merge develop nd fix some unit test (not everyone yet)
4dbfbee 
Signed-off-by: Israel Martinez <imc@umd.edu>
@israelmcmc
Fix bug from develop-interfaces merge. GCRS only has "distance" in sp…
e019541 
…herical coordinates.

Signed-off-by: Israel Martinez <imc@umd.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Feature / Enhancement New functionality or improvement refactoring Code refactoring and API changes.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Interfaces refactoring

4 participants

@israelmcmc @hiyoneda @GallegoSav @nlopez-code