Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Make RGB" docs are incomplete and over-specific #7355

Open
keflavich opened this issue Apr 6, 2018 · 2 comments
Open

"Make RGB" docs are incomplete and over-specific #7355

keflavich opened this issue Apr 6, 2018 · 2 comments

Comments

@keflavich
Copy link
Contributor

keflavich commented Apr 6, 2018

I had a student come to me asking how to make RGB figures with astropy, and she found this page:
http://docs.astropy.org/en/stable/visualization/lupton_rgb.html

which is fine, but (a) didn't work out of the box (something wrong with image dimensions...) and (b) is doing more than she wanted.

We should have a document showing how to make an RGB image with scalings selected from astropy's visualization tools, for example like this script:
https://github.com/keflavich/SgrB2_ALMA_2015.1.00550.S/blob/master/analysis/threecolorfigure.py
but without all the reprojection and other stuff. Some indication that an RGB image is just a 3D image where the 3rd dimension consists of 3 planes would also be helpful.

We could probably also use some tutorials showing the mix of reprojection and RGB image making.

@keflavich keflavich added the Docs label Apr 6, 2018
@keflavich keflavich added this to the Future milestone Apr 6, 2018
@bsipocz
Copy link
Member

bsipocz commented Feb 28, 2019

This is still an issue, and came up again. Digging into the source code we quite a lot of classes in that module that are still not exposed to the API docs, and it's not trivial to see how to make RGB images with the other scaling (e.g. log) already available in astropy.

@biprateep
Copy link

biprateep commented Jul 12, 2020

Hi @bsipocz I am willing to take up this issue. Is there anything specific you would like to add/modify?
An immediate thing that I see is that there is no way to use the AsinhZScaleMapping even though the class is defined.

and coming back to providing alternate scalings like log, we can have a general plot_rgb function which does a log and other scalings. We can have a particular mode for plot_rgb function that will boil down to the traditional Lupton RGB plotting algorithm.

Also it will be nice to add some of the improvements and flexibility that Phil Marshal has incorporated in his plotting routine available here: https://github.com/drphilmarshall/HumVI

let me know of your views.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants