search

HERA-Team / hera_pspec

HERA power spectrum estimation code and data formats
http://hera-pspec.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
4 stars 3 forks source link

Clarify plotting documentation and legend #107

Open jsdillon opened 6 years ago

jsdillon commented 6 years ago

https://github.com/HERA-Team/hera_pspec/blob/5dd299f4bc0f951e487f2f194ebf291687e62318/hera_pspec/plot.py#L20

First, "List of baseline-pair tuples" sounds like something like [(1,2),(3,4)], when what you really mean is [((1,2),(3,4))]. Trying the former gives the rather unhelpful TypeError: 'int' object has no attribute '__getitem__'.

Second it's not clear that by spectral window you mean spectral window index, especially since I created my uvp object by specifying channels in a spw_range. In general, it's a bit unintuitive to figure out what the spws are and what they mean by looking to the attributes of a uvp object.

Third the legend (at least in the design review warmup) is pretty useless: screen shot 2018-05-15 at 4 33 40 pm It seems like at the very least you might want to show the LST too if you're not going to be smart in trying to make the legend show what's actually changing between the plotted spectra.

More generally, it's odd to me that you must specify which blpairs, spw, and pol to plot (that the default is not all of them) but that you apparently cannot specify which LSTs to plot...only whether to plot them all or average.

bhazelton commented 6 years ago

Big plus one from me. I had a really hard time figuring this part out and I never ended up with a useful legend. Even when I set average_times=True I got 6 identical legend entries, but only 1 line showed, so I guess they were all on top of each other.

Also, the docs are kind of unhelpful, I never figured out that it wanted [((1,2),(3,4))], I just used this from the docs: [list(pspec.blpair_array),] which was limiting. And the docs are slightly wrong in that they show using keywords for spw, pol rather than positional arguments.