Skip to content

Commit

Permalink
Update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremykubica committed Oct 12, 2023
1 parent 938d834 commit 7175355
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/kbmod/work_unit.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ def __init__(self, im_stack=None, config=None):
def from_fits(cls, filename):
"""Create a WorkUnit from a single FITS file.
A WorkUnit is written as a FITS file with the following extensions:
0 - Primary header with overall metadata
1 or "metadata" - The data provenance metadata
2 or "kbmod_config" - The search parameters
3+ - Image extensions for the science layer ("SCI_i"),
variance layer ("VAR_i"), mask layer ("MSK_i"), and
PSF ("PSF_i") of each image.
The FITS file will have at least the following extensions:
0. ``PRIMARY`` extension
1. ``METADATA`` extension containing provenance
2. ``KBMOD_CONFIG`` extension containing search parameters
3. (+) any additional image extensions are named ``SCI_i``, ``VAR_i``, ``MSK_i``
and ``PSF_i`` for the science, variance, mask and PSF of each image respectively,
where ``i`` runs from 0 to number of images in the `WorkUnit`.
Parameters
----------
Expand Down

0 comments on commit 7175355

Please sign in to comment.