pydrizzle.outputimage.OutputImage

Class OutputImage

This class manages the creation of the array objects which will be used by Drizzle. The three arrays, SCI/WHT/CTX, will be setup either as extensions in a single multi-extension FITS file, or as separate FITS files.

Instance Methods

[hide private]

__init__(self, plist, build=True, wcs=None, single=False, blot=False)
The object 'plist' must contain at least the following members: plist['output'] - name of output FITS image (for SCI) plist['outnx'] - size of X axis for output array plist['outny'] - size of Y axis for output array If 'single=yes', then 'plist' also needs to contain: plist['outsingle'] plist['outsweight'] plist['outscontext'] If 'blot=yes', then 'plist' also needs: plist['data'] plist['outblot'] plist['blotnx'],plist['blotny']

source code

set_bunit(self, bunit)
Method used to update the value of the bunit attribute.

source code

set_units(self, units)
Method used to record what units were specified by the user for the output product.

source code

writeFITS(self, template, sciarr, whtarr, ctxarr=None, versions=None, extlist=('SCI', 'WHT', 'CTX'), overwrite=True)
Generate PyFITS objects for each output extension using the file given by 'template' for populating headers. source code

addPhotKeywords(self, hdr, phdr)
Insure that this header contains all the necessary photometry keywords, moving them into the extension header if necessary.

source code

addDrizKeywords(self, hdr, versions)
Add drizzle parameter keywords to header.

source code

init(self, plist, build=True, wcs=None, single=False, blot=False)
(Constructor)

source code


The object 'plist' must contain at least the following members:
    plist['output']  - name of output FITS image (for SCI)
    plist['outnx']    - size of X axis for output array
    plist['outny']    - size of Y axis for output array
If 'single=yes', then 'plist' also needs to contain:
    plist['outsingle']
    plist['outsweight']
    plist['outscontext']
If 'blot=yes', then 'plist' also needs:
    plist['data']
    plist['outblot']
    plist['blotnx'],plist['blotny']

If 'build' is set to 'no', then each extension/array must be
in separate FITS objects.  This would also require:
  plist['outdata']    - name of output SCI FITS image
  plist['outweight']  - name of output WHT FITS image
  plist['outcontext'] - name of output CTX FITS image

Optionally, the overall exposure time information can be passed as:
    plist['texptime'] - total exptime for output
    plist['expstart'] - start time of combined exposure
    plist['expend']   - end time of combined exposure

writeFITS(self, template, sciarr, whtarr, ctxarr=None, versions=None, extlist=`('SCI',` `'WHT',` `'CTX')`, overwrite=True)

source code

Generate PyFITS objects for each output extension using the file given by 'template' for populating headers.

The arrays will have the size specified by 'shape'.

addPhotKeywords(self, hdr, phdr)

source code

Insure that this header contains all the necessary photometry keywords, moving them into the extension header if necessary. This only moves keywords from the PRIMARY header if the keywords do not already exist in the SCI header.

Class OutputImage

__init__(self, plist, build=True, wcs=None, single=False, blot=False) (Constructor)

writeFITS(self, template, sciarr, whtarr, ctxarr=None, versions=None, extlist=('SCI', 'WHT', 'CTX'), overwrite=True)

addPhotKeywords(self, hdr, phdr)

init(self, plist, build=True, wcs=None, single=False, blot=False)
(Constructor)

writeFITS(self, template, sciarr, whtarr, ctxarr=None, versions=None, extlist=`('SCI',` `'WHT',` `'CTX')`, overwrite=True)