lsst.ip.isr.fringe.FringeTask Class Reference

Inheritance diagram for lsst.ip.isr.fringe.FringeTask:

Public Member Functions
def	readFringes (self, dataRef, assembler=None)
def	run (self, exposure, fringes, seed=None)
def	runDataRef (self, exposure, dataRef, assembler=None)
def	checkFilter (self, exposure)
def	removePedestal (self, fringe)
def	generatePositions (self, exposure, rng)
def	measureExposure (self, exposure, positions, title="Fringe")
def	solve (self, science, fringes)
def	subtract (self, science, fringes, solution)

Static Public Attributes
	ConfigClass = FringeConfig

Detailed Description

Task to remove fringes from a science exposure

We measure fringe amplitudes at random positions on the science exposure
and at the same positions on the (potentially multiple) fringe frames
and solve for the scales simultaneously.

Definition at line 66 of file fringe.py.

Member Function Documentation

checkFilter()

def lsst.ip.isr.fringe.FringeTask.checkFilter	(		self,
			exposure
	)

Check whether we should fringe-subtract the science exposure

Definition at line 164 of file fringe.py.

generatePositions()

def lsst.ip.isr.fringe.FringeTask.generatePositions	(		self,
			exposure,
			rng
	)

Generate a random distribution of positions for measuring fringe amplitudes

Definition at line 178 of file fringe.py.

measureExposure()

def lsst.ip.isr.fringe.FringeTask.measureExposure	(		self,
			exposure,
			positions,
			title = "Fringe"
	)

Measure fringe amplitudes for an exposure

The fringe amplitudes are measured as the statistic within a square
aperture.  The statistic within a larger aperture are subtracted so
as to remove the background.

@param exposure    Exposure to measure
@param positions   Array of (x,y) for fringe measurement
@param title       Title for display
@return Array of fringe measurements

Definition at line 188 of file fringe.py.

readFringes()

def lsst.ip.isr.fringe.FringeTask.readFringes	(		self,
			dataRef,
			assembler = None
	)

Read the fringe frame(s)

The current implementation assumes only a single fringe frame and
will have to be updated to support multi-mode fringe subtraction.

This implementation could be optimised by persisting the fringe
positions and fluxes.

@param dataRef     Data reference for the science exposure
@param assembler   An instance of AssembleCcdTask (for assembling fringe frames)
@return Struct(fringes: fringe exposure or list of fringe exposures;
       seed: 32-bit uint derived from ccdExposureId for random number generator

Definition at line 75 of file fringe.py.

removePedestal()

def lsst.ip.isr.fringe.FringeTask.removePedestal	(		self,
			fringe
	)

Remove pedestal from fringe exposure

Definition at line 168 of file fringe.py.

run()

def lsst.ip.isr.fringe.FringeTask.run	(		self,
			exposure,
			fringes,
			seed = None
	)

Remove fringes from the provided science exposure.

Primary method of FringeTask.  Fringes are only subtracted if the
science exposure has a filter listed in the configuration.

@param exposure    Science exposure from which to remove fringes
@param fringes     Exposure or list of Exposures
@param seed        32-bit unsigned integer for random number generator

Definition at line 104 of file fringe.py.

runDataRef()

def lsst.ip.isr.fringe.FringeTask.runDataRef	(		self,
			exposure,
			dataRef,
			assembler = None
	)

Remove fringes from the provided science exposure.

Retrieve fringes from butler dataRef provided and remove from
provided science exposure.
Fringes are only subtracted if the science exposure has a filter
listed in the configuration.

@param exposure    Science exposure from which to remove fringes
@param dataRef     Data reference for the science exposure
@param assembler   An instance of AssembleCcdTask (for assembling fringe frames)

Definition at line 147 of file fringe.py.

solve()

def lsst.ip.isr.fringe.FringeTask.solve	(		self,
			science,
			fringes
	)

Solve (with iterative clipping) for the scale factors

@param science     Array of science exposure fringe amplitudes
@param fringes     Array of arrays of fringe frame fringe amplitudes
@return Array of scale factors for the fringe frames

Definition at line 229 of file fringe.py.

subtract()

def lsst.ip.isr.fringe.FringeTask.subtract	(		self,
			science,
			fringes,
			solution
	)

Subtract the fringes

@param science     Science exposure
@param fringes     List of fringe frames
@param solution    Array of scale factors for the fringe frames

Definition at line 342 of file fringe.py.

Member Data Documentation

ConfigClass

lsst.ip.isr.fringe.FringeTask.ConfigClass = FringeConfig

static

Definition at line 73 of file fringe.py.

---

The documentation for this class was generated from the following file:

• python/lsst/ip/isr/fringe.py