Details
-
Type:
Story
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Epic Link:
-
Team:SQuaRE
Description
SDSS has a handy webpage with descriptions of all of their bitmask flags:
http://www.sdss.org/dr12/algorithms/bitmasks/#ListofBitmasks
It would be exceptionally useful for LSST to produce a similar webpage. I could see it being auto-built from our current flags documetation, which would also help us identify places where our current docstrings are lacking (which many of them are).
Attachments
Issue Links
- relates to
-
DM-28280 Documenting Butler DatasetTypes
- To Do
-
DM-13139 flag non-finite measurement uncertainties
- To Do
-
DM-37544 Write technote on future PipelineTask / Pipeline changes
- To Do
-
DM-38513 Add narrative docs for catalog flags
- To Do
-
DM-33034 Create initial doc builder for pipeline definitions
- In Review
-
DM-6887 Document the semantics of measurement algorithm flags
- Won't Fix
-
DM-2297 Associate documentation with new Mask planes
- To Do
-
DM-4201 Documentation and technical debt in meas_base/PixelFlags.cc
- To Do
-
DM-9050 Add flags for sources used in astrometric and photometric calibration
- Done
- mentioned in
-
Page Loading...
Since I originally filed this: I was specifically looking for a web page that documents the _flag fields that get set in our catalogs. We should be able to extract that from a "typical" run on some data (say, ci_hsc). More broadly, it would be very useful if that web page had descriptions of all of the fields our "typical" catalogs contain.
It seems silly to me that a user has to go and read in a table and look at its schema to understand what sorts of fields the LSST software could produce.