search

keflavich / image_registration

Image Registration for Astronomy
MIT License
156 stars 53 forks source link

README file would benefit from more detail #38

Open K4kap0 opened 2 years ago

K4kap0 commented 2 years ago

I don't have a lot of experience in this sort of area and probably because of that have had troubles with installing and using the code in this repositority. Perhaps including more detailed usage and installation instructions would be helpful.

keflavich commented 2 years ago

If you have a specific question, please ask. The README is only meant to provide minimalist documentation; you should read the real documentation that is linked from the README for more details.

lukfd commented 2 years ago

@keflavich I would also like to mention that the web page https://image-registration.readthedocs.io/en/latest/#quick-example presents the code

from image_registration import chi2_shift from image_registration.fft_tools import shift xoff, yoff, exoff, eyoff = chi2_shift(image, offset_image, noise, ... return_error=True, upsample_factor='auto') corrected_image2 = shift.shiftnd(offset_image, -yoff, -xoff)

Should it be corrected_image2 = shift.shiftnd(offset_image, (-yoff, -xoff))

Thanks!

keflavich commented 2 years ago

Good catch @lukfd . Actually, that example is correct already: https://github.com/keflavich/image_registration/blob/21f5a5359a41d52199fc175407a011bd411630e3/docs/index.rst#quick-example but it looks like the docs aren't building. I'll look into it.

keflavich commented 2 years ago

Docs are building, so @lukfd your issue should be resolved.