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

update misleading documentation for function #49

Open
hematthi opened this issue May 22, 2022 · 0 comments
Open

update misleading documentation for function #49

hematthi opened this issue May 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hematthi
Copy link
Collaborator

"""Create Dict containing filename and default metadata from file."""
function read_exposure_meter(f::FITS)
hdr1 = read_header(f[1])
exptime = hdr1["EXPTIME"]
λ_range = 38:97
fiber = 5
#expmeter_data = read(f["EXPMETER"],t_range,λ_range,fiber)
expmeter_data = read(f["EXPMETER"]) # ,:,λ_range,fiber)
t_len = size(expmeter_data,1)
t_range = 2:(min(round(Int64,exptime)-1,t_len))
if t_len < floor(Int64,exptime)
@warn("*** Exposure meter contains fewer readings than floor(EXPTIME) in " * string(f.filename) )
end
view(expmeter_data, t_range,λ_range,fiber)
end

It is not clear what this function is returning... the docstring suggests a dict, but my guess is that it should return an array type (I don't think view works on a dict?)

@hematthi hematthi added the documentation Improvements or additions to documentation label May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant