search

galsci / mapsims

Map based simulations software for CMB Experiments
BSD 2-Clause "Simplified" License
3 stars 1 forks source link

Document in docstring what possible tubes could be #64

Closed msyriac closed 4 years ago

msyriac commented 4 years ago

In a docstring like this:

Parameters
----------

tube : str
    Specify a specific tube.

we should provide more info on how to discover what the possible string values are. We've done this in the past, and I forget how to do it for these v2 tubes. Could we update "tube: str" docstrings to include that information?

msyriac commented 4 years ago

Reopening, to add one more request: what about exposing what the order of the frequency bands in a dichroic array is as well?

msyriac commented 4 years ago

i.e. if I get a map that has 2 components corresponding to the two arrays in the tube, which one is 90 GHz and which one is 150 GHz?

zonca commented 4 years ago

yes, what about an attribute named band_id in the Channel object? then mention it in the docstring of methods that return dichroic maps

msyriac commented 4 years ago

That could work, yes!