astropy / astropy/specutils

Document workflows for intensity calculations

Open
#672 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
204
Forks
134
Avg merge
12h 55m
Merged PRs (30d)
1

Description

Both issue #243 and #244 suggest ways of calculating the mean and standard deviations within a spectrum, respectively:

> Oh and I guess the snippet above is now (v0.4) np.mean(extract_region(spectrum, reg).flux) or astropy.stats.sigma_clip(extract_region(spectrum, reg).flux, cenfunc=np.mean) if you want sigma-clipping

and

> For completeness, in v0.4 that would be np.std(extract_region(spectrum, reg).flux)

These do not rise to the level of needing dedicated analysis functions but (as suggested in the linked issues) should be documented.

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation area for spectrum analysis and review issues #243 and #244 alongside the examples in this issue. Document workflows for calculating the mean and standard deviation of extracted flux, including the shown sigma-clipping option; done means users can find and follow these examples without dedicated analysis functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.