New Coalignment API (#293)

* a better approach to dev

* added decorator and incorporated suggestions

* updated the docstring

* added tests for majority of all funcs

* adds how to guide

few fixes in refs

fixing the refs

* temporary de-referencing funcs and methods

* fix doc tree

* added refs again

importing funcs

testing import

i think final

final nail

explicit imports

* Apply suggestions from code review

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>

* code review and fixing minor mistakes

* changed doc to ref

* Update ref

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>

* better linking

lint

* updated the api, now returns the map with updated metadata

* updated the how_to_guide

* docstring fix

* first try at replacing old coalign

* removing old coalignment completely, refs fixed, old example removed

* fix the issue of method not being registered

* fix the pixel pair issue

* Apply suggestions from code review & testing bot

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>

* fix the order of the reference and target maps

* calm down pre-commit

* fixed the method & added examples and tests

* adding the eis file

* Apply suggestions from code review

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>

* made changes based on suggestions

* pre-commit

* Update docs/how_to_guide/using_the_coalignment_interface.rst

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* rename all please

* renamed coalignment to coalign, made example plot better, removed namedtuple and decorators from higher level initialization

* here too

* minor fix

* marked remote test

* testing by including the source

* fixed the rst

* updated the handling of cdelt values

* fixed the plot bloc

* added the figure test case1/2 and clean up

* fixed the warning list

* fix refs and clean

* adding fixture

* trying to suppress warnings

* major changes; confirm affine, fixed test case, removed a guide

* added a note

* slightly changed the map observation and fig hash

* fixed refs

* trying to fix fig hash

* fixed online test, added few more tests, updated coalignment.rst

* trying automodule

* docstring fix

* fix the online fail by suppressing Astropy Warning

* one last try

* might need a better way

* for 6.1.2

no comments

* final try

silly terminal

* added the comprehensive changelog

* fixed the changelog

* Apply suggestions from code review

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* fix the test fails and internalized funcs

* added the url for eis raster

* forgot

* clean up old raster and few lint fixes

* added a check for astropy version

* Nabil review

* Apply suggestions from code review

Co-authored-by: Albert Y. Shih <ayshih@gmail.com>

* Addressed comments from Albert

* fix import

* Added second method

* doc

* bugfix

* in-progress refactor of order of args

* don't allow rotations or scaling for now

* actually fetch image

* fix example

* update figure hashes

* adjust imports

* Tweaks to logging

* Tweaks from Nabil

* Overhaul of where stuff lives to get dict to store stuff in docs

* Minor move around whitespace

* improve the figure test

* Redid some tests and added plate scale warning

* Full disc tests

* Update examples/aligning_aia_with_eis_maps.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/tests/test_match_template.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/tests/test_match_template.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* Update sunkit_image/coalignment/interface.py

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>

* precommit

* Fix tests and improve pad_input handling

* Fixed scale check

* correct changelog PR

* extra figure and minor edits to gallery example

* minor reorganizaiton of coalignment API docs

* reorganize how-to guide

* docstring cleanup

* tighten up test tolerance

* Apply suggestions from code review

Co-authored-by: Stuart Mumford <stuart@cadair.com>

* [Fix] Emdashes are important for writing english -- vital even

* Update figure env

* Fix formatting

* Rename section to Sunspot Tracking And Recognition

---------

Co-authored-by: Jayraj Dulange <117574289+Deus1704@users.noreply.github.com>
Co-authored-by: Deus1704 <jayraj.jayraj@iitgn.ac.in>
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
Co-authored-by: Albert Y. Shih <ayshih@gmail.com>
Co-authored-by: Stuart Mumford <stuart@cadair.com>

Author: 5 people

.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: cimg/python:3.12
+      - image: cimg/python:3.13
     environment: TOXENV=<< parameters.jobname >>
     steps:
       - run: *no-backports
@@ -56,7 +56,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: cimg/python:3.12
+      - image: cimg/python:3.13
     environment:
       TOXENV: << parameters.jobname >>
       GIT_SSH_COMMAND: ssh -i ~/.ssh/id_rsa_6464b6a8248237ca368fd4690777d921
@@ -97,13 +97,13 @@ workflows:
           matrix:
             parameters:
               jobname:
-                - "py312-figure"
+                - "py313-figure"
       - deploy-reference-images:
           name: baseline-<< matrix.jobname >>
           matrix:
             parameters:
               jobname:
-                - "py312-figure"
+                - "py313-figure"
           requires:
             - << matrix.jobname >>
           filters:

_typos.toml

@@ -7,3 +7,6 @@ default.extend-ignore-identifiers-re = [
     "iy",
     "BA",
 ]
+
+[default.extend-words]
+eis = "eis"

changelog/290.breaking.rst

@@ -5,4 +5,4 @@ Increased the minimum required versions:
 - sunpy 7.0.0 (from 6.0.0)
 - NumPy 1.26.0 (from 1.23.5)
 - Astropy 6.1.0 (from 5.3.0)
-- SciPy 1.11.0 (from 1.10.1)
+- SciPy 1.12.0 (from 1.10.1)

changelog/293.breaking.rst

@@ -0,0 +1,2 @@
+The previous coalignment API has been deleted and replaced with a new set of imports and functions.
+Please see this example: :ref:`sphx_glr_generated_gallery_aligning_aia_with_eis_maps.py`.

docs/code_ref/asda.rst

@@ -1 +1,7 @@
+ASDA (`sunkit_image.asda`)
+**************************
+
+This package contains an implementation of the `Automated Swirl Detection
+Algorithm (ASDA) <https://ui.adsabs.harvard.edu/abs/2019ApJ...872...22L/abstract>`__.
+
 .. automodapi:: sunkit_image.asda

docs/code_ref/coalignment.rst

@@ -1 +1,16 @@
+Coalignment (`sunkit_image.coalignment`)
+****************************************
+
+Routines to perform coalignment of solar images.
+
 .. automodapi:: sunkit_image.coalignment
+
+.. automodapi:: sunkit_image.coalignment.interface
+    :no-inheritance-diagram:
+    :skip: coalign_map
+
+.. automodapi:: sunkit_image.coalignment.register
+
+.. automodapi:: sunkit_image.coalignment.match_template
+
+.. automodapi:: sunkit_image.coalignment.phase_cross_correlation

docs/code_ref/enhance.rst

@@ -1 +1,6 @@
+Enhancement (`sunkit_image.enhance`)
+************************************
+
+This package contains enhancement routines for solar physics data.
+
 .. automodapi:: sunkit_image.enhance

docs/code_ref/granule.rst

@@ -1 +1,6 @@
+Granule Detection (`sunkit_image.granule`)
+******************************************
+
+This package contains functions that will segment images for granule detection.
+
 .. automodapi:: sunkit_image.granule

docs/code_ref/radial.rst

@@ -1 +1,7 @@
+Radial Enhancement (`sunkit_image.radial`)
+******************************************
+
+This package contains functions that can be used to enhance the regions above a
+given radius.
+
 .. automodapi:: sunkit_image.radial

docs/code_ref/stara.rst

@@ -1 +1,7 @@
+Sunspot Tracking And Recognition (`sunkit_image.stara`)
+*******************************************************
+
+This package contains an implementation of the `Sunspot Tracking And Recognition
+Algorithm (STARA) <https://doi.org/10.1007/s11207-009-9420-z>`__.
+
 .. automodapi:: sunkit_image.stara