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

jbt.get_backgrounds docstring is out of date #26

Open
aggle opened this issue Jan 2, 2024 · 0 comments
Open

jbt.get_backgrounds docstring is out of date #26

aggle opened this issue Jan 2, 2024 · 0 comments

Comments

@aggle
Copy link

aggle commented Jan 2, 2024

The docstring for jbt.get_backgrounds() doesn't agree with the arguments of the function.

Docstring:

Parameters
    ----------
    ra: float
        Right ascension in decimal degrees
    dec: float
        Declination in decimal degrees
    wavelength: float
        Wavelength at which the bathtub curve is calculated, in micron
    thresh: float
        the background threshold, relative to the minimum.  Default=1.1, which corresponds to <5% above the minimum background noise.
        Note that the actual noise difference will be even smaller, as there are often other significant sources of noise than just the
        background (source shot noise, detector noise, etc.).
    plot_background: bool
        whether to plot the background spectrum (and its components) for this day.
    thisday: int
        calendar day to use for plot_spec.  If not given, will use the average of visible calendar days.
    plot_days: bool
        whether to show the plot of background at wavelength_input versus calendar days
    showsubbkgs: bool
        whether to show the components of the background in the bathtub plot.
    write_bathtub: bool
        whether to print the background levels that are plotted in plot_days to an output file
    outfile:     output filename

Arguments:

ra, 
dec, 
wavelength, 
thresh=1.1, 
plot_background=True, 
plot_bathtub=True, 
thisday=None,
showsubbkgs=False, 
write_background=True, 
write_bathtub=True, 
background_file='background.txt',
bathtub_file='background_versus_day.txt'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant