Package multidrizzle :: Class Multidrizzle

Class Multidrizzle


The MultiDrizzle object manages the processing of the images.  All
input parameters, including the input, have default values, so only
those parameters which need to be changed should be specified. The
processing requires the following steps to be performed in order:
  - input all parameters and convert all input images to
    multi-extension FITS (MEF) files

    >>> md = multidrizzle.MultiDrizzle (input, output=None,
                                        editpars=no,**input_dict)

    where editpars turns on/off the GUI parameter editor
          input_dict contains all parameters which have non-default values

  - (optionally) edit all input parameter values with Traits-based GUI

    >>> md.editpars()

  - build parameters necessary for combining the images

    >>> md.build()

  - process the images through the steps which were turned on

    >>> md.run( static = None,          skysub = None,
                driz_separate = None,   median = None,
                blot = None,            driz_cr = None,
                driz_combine = None,    timing = None):

    where each parameter controls whether a processing step gets performed.

A full list of the parameters can be obtained from the MultiDrizzle
help file.

Instance Methods

[hide private]

__init__(self, input='*flt.fits', output=None, editpars=False, shiftfile=None, updatewcs=True, **input_dict) source code

editpars(self)
Run Python GUI parameter editor to set parameter values.

source code

build(self)
Parses parameter list into dictionaries for use by each processing step, builds the PyDrizzle input association table, builds the PyDrizzle object and uses that to build the InputImage instances needed for MultiDrizzle processing.

source code

printInputFiles(self)
METHOD : printInputFiles PURPOSE : Print out the names of the file that Multidrizzle has identified for processing based upon the given input string.

source code

setMedianPars(self)
Sets the special median parameters which need to be parsed out of the original input parameters.

source code

_createInputCopies(self, files)
Creates copies of all input images.

source code

_checkStaticFile(self, static_file)
Checks input files before they are required later.

source code

_preMedian(self, skysub)
Perform the steps that take place before median computation: build static mask, subtract sky, drizzle into separate images.

source code

_postMedian(self, blotpars, drizcrpars, skypars)
Perform the steps that take place after median computation: blot, and drizcr.

source code

run(self, static=None, skysub=None, driz_separate=None, median=None, blot=None, driz_cr=None, driz_combine=None, timing=None)

source code

help(self)
Help function on Multidrizzle Class that prints __doc__ string.

source code

Class Variables

[hide private]

init_keys = ['mdriztab', 'runfile', 'workinplace', 'context', ...

driz_keys = ['refimage', 'group', 'ra', 'dec', 'build']

instr_keys = ['gain', 'gnkeyword', 'rdnoise', 'rnkeyword', 'ex...

sky_keys = ['skywidth', 'skystat', 'skylower', 'skyupper', 'sk...

median_keys = ['median_newmasks', 'combine_type', 'combine_nsi...

drizcr_keys = ['driz_cr_snr', 'driz_cr_scale', 'driz_cr_corr',...

blot_keys = ['blot_interp', 'blot_sinscl']

Method Details

[hide private]

printInputFiles(self)

source code



METHOD  : printInputFiles
PURPOSE : Print out the names of the file that Multidrizzle has identified
          for processing based upon the given input string.
INPUT   : String representing the user provided input string
OUTPUT  : none

_createInputCopies(self, files)

source code

Creates copies of all input images.

If a previous execution of multidrizzle has failed and _OrIg files already exist, before removing the _OrIg files, we will copy the 'sci' extensions out of those files _OrIg files and use them to overwrite what is currently in the existing input files. This protects us against crashes in the HST pipeline where Multidrizzle is restarted after the sky has already been subtracted from the input files.

Class Variable Details

[hide private]

init_keys

Value:

['mdriztab',
 'runfile',
 'workinplace',
 'context',
 'clean',
 'shiftfile',
 'staticfile',
 'static_sig',
...

instr_keys

Value:

['gain',
 'gnkeyword',
 'rdnoise',
 'rnkeyword',
 'exptime',
 'expkeyword',
 'crbit']

sky_keys

Value:

['skywidth',
 'skystat',
 'skylower',
 'skyupper',
 'skyclip',
 'skylsigma',
 'skyusigma',
 'skyuser']

median_keys

Value:

['median_newmasks',
 'combine_type',
 'combine_nsigma',
 'combine_nlow',
 'combine_nhigh',
 'combine_lthresh',
 'combine_hthresh',
 'combine_grow',
...

drizcr_keys

Value:

['driz_cr_snr',
 'driz_cr_scale',
 'driz_cr_corr',
 'driz_cr_grow',
 'driz_cr_ctegrow']