Home       Trees       Indices       Help   
multidrizzle
Package multidrizzle :: Module input_image :: Class InputImage
[hide private]
[frames] | no frames]

Class InputImage

source code

The InputImage class is the base class for all of the various types of images

Instance Methods [hide private]
 
__init__(self, input, dqname, platescale, memmap=0, proc_unit='native')
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
setInstrumentParameters(self, instrpars, pri_header)
Sets the instrument parameters.		 source code
 
doUnitConversions(self)
Convert the sci extension pixels to electrons		 source code
 
getInstrParameter(self, value, header, keyword)
This method gets a instrument parameter from a pair of task parameters: a value, and a header keyword.		 source code
 
_averageFromHeader(self, header, keyword)
Averages out values taken from header.		 source code
 
_averageFromList(self, param)
Averages out values passed as a comma-separated list, disregarding the zero-valued entries.		 source code
 
getreferencesky(self) source code
 
getComputedSky(self) source code
 
setComputedSky(self, newValue) source code
 
getSubtractedSky(self) source code
 
setSubtractedSky(self, newValue) source code
 
getGain(self) source code
 
getExpTime(self) source code
 
getCRbit(self) source code
 
getRootname(self, name) source code
 
_isSubArray(self)
Instrument specific method to determine whether input is a subarray or not.		 source code
 
_isNotValid(self, par1, par2)
Method used to determine if a value or keyword is supplied as input for instrument specific parameters.		 source code
 
updateStaticMask(self, static_mask)
This method updates a static mask passed as a parameter, with mask info derived from the [SCI] array.		 source code
 
signature(self)
Generates a signature unique to this image.		 source code
 
computeSky(self, skypars)
Compute the sky value based upon the sci array of the chip		 source code
 
_extractSkyValue(self, ImageStatsObject, skystat) source code
 
subtractSky(self) source code
 
updateMDRIZSKY(self, filename=None) source code
 
runDrizCR(self, blotted_array, mask_array, drizcrpars, skypars, corr_file, cr_file)
Run 'deriv' and 'driz_cr' to create cosmic-ray mask for this image.		 source code
 
getflat(self)
Placeholder method for retrieving a detector's flat field.		 source code
 
getEffGain(self)
Method used to return the effective gain of a instrument's detector.		 source code
 
getReadNoise(self)
Method for trturning the readnoise of a detector (in electrons).		 source code
 
getReadNoiseImage(self)
Method for returning the readnoise image of a detector (in electrons).		 source code
 
getdarkcurrent(self)
Return the dark current for the detector.		 source code
 
getdarkimg(self)
Return an array representing the dark image for the detector.		 source code
 
getskyimg(self)
Return an array representing the sky image for the detector.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, input, dqname, platescale, memmap=0, proc_unit='native')
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

getInstrParameter(self, value, header, keyword)

source code 

This method gets a instrument parameter from a pair of task parameters: a value, and a header keyword.

The default behavior is:

  • if the value and header keyword are given, raise an exception.
  • if the value is given, use it.
  • if the value is blank and the header keyword is given, use the header keyword.
  • if both are blank, or if the header keyword is not found, return None.

_averageFromHeader(self, header, keyword)

source code 

Averages out values taken from header. The keywords where to read values from are passed as a comma-separated list.

updateStaticMask(self, static_mask)

source code 

This method updates a static mask passed as a parameter, with mask info derived from the [SCI] array. It also keeps a private static mask array appropriate for use with the [SCI] array when doing sky processing later on.

getflat(self)

source code 

Purpose

Placeholder method for retrieving a detector's flat field. This is an abstract method since each detector will be handled differently.

This method will return an array the same shape as the image.

getEffGain(self)

source code 

Purpose

Method used to return the effective gain of a instrument's detector.

This method returns a single floating point value.

getReadNoise(self)

source code 

Purpose

Method for trturning the readnoise of a detector (in electrons).

:units: electrons

getReadNoiseImage(self)

source code 

Purpose

Method for returning the readnoise image of a detector (in electrons).

The method will return an array of the same shape as the image.

:units: electrons

getdarkcurrent(self)

source code 

Purpose

Return the dark current for the detector. This value will be contained within an instrument specific keyword. The value in the image header will be converted to units of electrons.

:units: electrons

getdarkimg(self)

source code 

Purpose

Return an array representing the dark image for the detector.

:units: electrons

getskyimg(self)

source code 

Purpose

Return an array representing the sky image for the detector. The value of the sky is what would actually be subtracted from the exposure by the skysub step.

:units: electrons


   Home       Trees       Indices       Help   
multidrizzle
Generated by Epydoc 3.0.1 on Thu Jan 13 11:20:08 2011 http://epydoc.sourceforge.net