Inheritance diagram for lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask:

Public Member Functions
def	__init__ (self, args, *kwargs)

def	parseAndRun (cls, args, *kwargs)

def	runDataRef (self, dataRef)

def	run (self, exposure, dataId=None)

def	extractCrosstalkRatios (self, exposure, threshold=None, badPixels=None)

def	reduce (self, ratioList)

def	measureCrosstalkCoefficients (self, ratios, rejIter=3, rejSigma=2.0)

def	debugView (self, stepname, exposure)

def	debugPixels (self, stepname, pixelsIn, pixelsOut, i, j)

def	debugRatios (self, stepname, ratios, i, j)

def	applyOverrides (cls, config)

def	parseAndRun (cls, args=None, config=None, log=None, doReturnResults=False)

def	writeConfig (self, butler, clobber=False, doBackup=True)

def	writeSchemas (self, butler, clobber=False, doBackup=True)

def	writeMetadata (self, dataRef)

def	writePackageVersions (self, butler, clobber=False, doBackup=True, dataset="packages")

def	emptyMetadata (self)

def	getSchemaCatalogs (self)

def	getAllSchemaCatalogs (self)

def	getFullMetadata (self)

def	getFullName (self)

def	getName (self)

def	getTaskDict (self)

def	makeSubtask (self, name, **keyArgs)

def	timer (self, name, logLevel=Log.DEBUG)

def	makeField (cls, doc)

def	__reduce__ (self)

Public Attributes
	calib

	metadata

	log

	config

Static Public Attributes
	ConfigClass = MeasureCrosstalkConfig

	RunnerClass = TaskRunner

bool	canMultiprocess = True

Detailed Description

Measure intra-detector crosstalk.

Notes
-----
The crosstalk this method measures assumes that when a bright
pixel is found in one detector amplifier, all other detector
amplifiers may see an increase in the same pixel location
(relative to the readout amplifier) as these other pixels are read
out at the same time.

After processing each input exposure through a limited set of ISR
stages, bright unmasked pixels above the threshold are identified.
The potential CT signal is found by taking the ratio of the
appropriate background-subtracted pixel value on the other
amplifiers to the input value on the source amplifier.  If the
source amplifier has a large number of bright pixels as well, the
background level may be elevated, leading to poor ratio
measurements.

The set of ratios found between each pair of amplifiers across all
input exposures is then gathered to produce the final CT
coefficients.  The sigma-clipped mean and sigma are returned from
these sets of ratios, with the coefficient to supply to the ISR
CrosstalkTask() being the multiplicative inverse of these values.

Definition at line 103 of file measureCrosstalk.py.

Constructor & Destructor Documentation

◆ init()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 132 of file measureCrosstalk.py.

     def __init__(self, *args, **kwargs):
         CmdLineTask.__init__(self, *args, **kwargs)
         self.makeSubtask("isr")
         self.calib = CrosstalkCalib()
  

Member Function Documentation

◆ reduce()

def lsst.pipe.base.task.Task.__reduce__ ( self )

inherited

Pickler.

Reimplemented in lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, and lsst.pipe.drivers.coaddDriver.CoaddDriverTask.

Definition at line 373 of file task.py.

     def __reduce__(self):
         """Pickler.
         """
         return self.__class__, (self.config, self._name, self._parentTask, None)

◆ applyOverrides()

def lsst.pipe.base.cmdLineTask.CmdLineTask.applyOverrides	(	cls,
		config
	)

inherited

A hook to allow a task to change the values of its config *after* the camera-specific
overrides are loaded but before any command-line overrides are applied.

Parameters
----------
config : instance of task's ``ConfigClass``
    Task configuration.

Notes
-----
This is necessary in some cases because the camera-specific overrides may retarget subtasks,
wiping out changes made in ConfigClass.setDefaults. See LSST Trac ticket #2282 for more discussion.

.. warning::

   This is called by CmdLineTask.parseAndRun; other ways of constructing a config will not apply
   these overrides.

Reimplemented in lsst.pipe.drivers.constructCalibs.FringeTask, lsst.pipe.drivers.constructCalibs.FlatTask, lsst.pipe.drivers.constructCalibs.DarkTask, and lsst.pipe.drivers.constructCalibs.BiasTask.

Definition at line 527 of file cmdLineTask.py.

     def applyOverrides(cls, config):
         """A hook to allow a task to change the values of its config *after* the camera-specific
         overrides are loaded but before any command-line overrides are applied.
  
         Parameters
         ----------
         config : instance of task's ``ConfigClass``
             Task configuration.
  
         Notes
         -----
         This is necessary in some cases because the camera-specific overrides may retarget subtasks,
         wiping out changes made in ConfigClass.setDefaults. See LSST Trac ticket #2282 for more discussion.
  
         .. warning::
  
            This is called by CmdLineTask.parseAndRun; other ways of constructing a config will not apply
            these overrides.
         """
         pass
  

◆ debugPixels()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.debugPixels	(	self,
		stepname,
		pixelsIn,
		pixelsOut,
		i,
		j
	)

Utility function to examine the CT ratio pixel values.

Parameters
----------
stepname : `str`
    State of processing to view.
pixelsIn : `np.ndarray`
    Pixel values from the potential crosstalk "source".
pixelsOut : `np.ndarray`
    Pixel values from the potential crosstalk "victim".
i : `int`
    Index of the source amplifier.
j : `int`
    Index of the target amplifier.

Definition at line 504 of file measureCrosstalk.py.

     def debugPixels(self, stepname, pixelsIn, pixelsOut, i, j):
         """Utility function to examine the CT ratio pixel values.
  
         Parameters
         ----------
         stepname : `str`
             State of processing to view.
         pixelsIn : `np.ndarray`
             Pixel values from the potential crosstalk "source".
         pixelsOut : `np.ndarray`
             Pixel values from the potential crosstalk "victim".
         i : `int`
             Index of the source amplifier.
         j : `int`
             Index of the target amplifier.
         """
         frame = getDebugFrame(self._display, stepname)
         if frame:
             if i == j or len(pixelsIn) == 0 or len(pixelsOut) < 1:
                 pass
             import matplotlib.pyplot as plot
             figure = plot.figure(1)
             figure.clear()
  
             axes = figure.add_axes((0.1, 0.1, 0.8, 0.8))
             axes.plot(pixelsIn, pixelsOut / pixelsIn, 'k+')
             plot.xlabel("Source amplifier pixel value")
             plot.ylabel("Measured pixel ratio")
             plot.title("(Source %d -> Victim %d) median ratio: %f" %
                        (i, j, np.median(pixelsOut / pixelsIn)))
             figure.show()
  
             prompt = "Press Enter to continue: "
             while True:
                 ans = input(prompt).lower()
                 if ans in ("", "c",):
                     break
             plot.close()
  

◆ debugRatios()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.debugRatios	(	self,
		stepname,
		ratios,
		i,
		j
	)

Utility function to examine the final CT ratio set.

Parameters
----------
stepname : `str`
    State of processing to view.
ratios : `List` of `List` of `np.ndarray`
    Array of measured CT ratios, indexed by source/victim
    amplifier.
i : `int`
    Index of the source amplifier.
j : `int`
    Index of the target amplifier.

Definition at line 543 of file measureCrosstalk.py.

     def debugRatios(self, stepname, ratios, i, j):
         """Utility function to examine the final CT ratio set.
  
         Parameters
         ----------
         stepname : `str`
             State of processing to view.
         ratios : `List` of `List` of `np.ndarray`
             Array of measured CT ratios, indexed by source/victim
             amplifier.
         i : `int`
             Index of the source amplifier.
         j : `int`
             Index of the target amplifier.
         """
         frame = getDebugFrame(self._display, stepname)
         if frame:
             if i == j or ratios is None or len(ratios) < 1:
                 pass
  
             RR = ratios[i][j]
             if RR is None or len(RR) < 1:
                 pass
  
             value = np.mean(RR)
  
             import matplotlib.pyplot as plot
             figure = plot.figure(1)
             figure.clear()
             plot.hist(x=RR, bins='auto', color='b', rwidth=0.9)
             plot.xlabel("Measured pixel ratio")
             plot.axvline(x=value, color="k")
             plot.title("(Source %d -> Victim %d) clipped mean ratio: %f" % (i, j, value))
             figure.show()
  
             prompt = "Press Enter to continue: "
             while True:
                 ans = input(prompt).lower()
                 if ans in ("", "c",):
                     break
             plot.close()

◆ debugView()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.debugView	(	self,
		stepname,
		exposure
	)

Utility function to examine the image being processed.

Parameters
----------
stepname : `str`
    State of processing to view.
exposure : `lsst.afw.image.Exposure`
    Exposure to view.

Definition at line 482 of file measureCrosstalk.py.

     def debugView(self, stepname, exposure):
         """Utility function to examine the image being processed.
  
         Parameters
         ----------
         stepname : `str`
             State of processing to view.
         exposure : `lsst.afw.image.Exposure`
             Exposure to view.
         """
         frame = getDebugFrame(self._display, stepname)
         if frame:
             display = getDisplay(frame)
             display.scale('asinh', 'zscale')
             display.mtv(exposure)
  
             prompt = "Press Enter to continue: "
             while True:
                 ans = input(prompt).lower()
                 if ans in ("", "c",):
                     break
  

◆ emptyMetadata()

def lsst.pipe.base.task.Task.emptyMetadata ( self )

inherited

Empty (clear) the metadata for this Task and all sub-Tasks.

Definition at line 153 of file task.py.

     def emptyMetadata(self):
         """Empty (clear) the metadata for this Task and all sub-Tasks.
         """
         for subtask in self._taskDict.values():
             subtask.metadata = dafBase.PropertyList()
  

◆ extractCrosstalkRatios()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.extractCrosstalkRatios	(	self,
		exposure,
		threshold = `None`,
		badPixels = `None`
	)

Extract crosstalk ratios between different amplifiers.

For pixels above ``threshold``, we calculate the ratio between
each background-subtracted target amp and the source amp. We
return a list of ratios for each pixel for each target/source
combination, as a matrix of lists.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure for which to measure crosstalk.
threshold : `float`, optional
    Lower limit on pixels for which we measure crosstalk.
badPixels : `list` of `str`, optional
    Mask planes indicating a pixel is bad.

Returns
-------
ratios : `list` of `list` of `numpy.ndarray`
   A matrix of pixel arrays. ``ratios[i][j]`` is an array of
   the fraction of the ``j``-th amp present on the ``i``-th amp.
   The value is `None` for the diagonal elements.

Notes
-----
This has been moved into MeasureCrosstalkTask to allow for easier
debugging.

The lsstDebug.Info() method can be rewritten for __name__ =
`lsst.ip.isr.measureCrosstalk`, and supports the parameters:

debug.display['extract'] : `bool`
    Display the exposure under consideration, with the pixels used
    for crosstalk measurement indicated by the DETECTED mask plane.
debug.display['pixels'] : `bool`
    Display a plot of the ratio calculated for each pixel used in this
    exposure, split by amplifier pairs.  The median value is listed
    for reference.

Definition at line 265 of file measureCrosstalk.py.

     def extractCrosstalkRatios(self, exposure, threshold=None, badPixels=None):
         """Extract crosstalk ratios between different amplifiers.
  
         For pixels above ``threshold``, we calculate the ratio between
         each background-subtracted target amp and the source amp. We
         return a list of ratios for each pixel for each target/source
         combination, as a matrix of lists.
  
         Parameters
         ----------
         exposure : `lsst.afw.image.Exposure`
             Exposure for which to measure crosstalk.
         threshold : `float`, optional
             Lower limit on pixels for which we measure crosstalk.
         badPixels : `list` of `str`, optional
             Mask planes indicating a pixel is bad.
  
         Returns
         -------
         ratios : `list` of `list` of `numpy.ndarray`
            A matrix of pixel arrays. ``ratios[i][j]`` is an array of
            the fraction of the ``j``-th amp present on the ``i``-th amp.
            The value is `None` for the diagonal elements.
  
         Notes
         -----
         This has been moved into MeasureCrosstalkTask to allow for easier
         debugging.
  
         The lsstDebug.Info() method can be rewritten for __name__ =
         `lsst.ip.isr.measureCrosstalk`, and supports the parameters:
  
         debug.display['extract'] : `bool`
             Display the exposure under consideration, with the pixels used
             for crosstalk measurement indicated by the DETECTED mask plane.
         debug.display['pixels'] : `bool`
             Display a plot of the ratio calculated for each pixel used in this
             exposure, split by amplifier pairs.  The median value is listed
             for reference.
         """
         if threshold is None:
             threshold = self.config.threshold
         if badPixels is None:
             badPixels = list(self.config.badMask)
  
         mi = exposure.getMaskedImage()
         FootprintSet(mi, Threshold(threshold), "DETECTED")
         detected = mi.getMask().getPlaneBitMask("DETECTED")
         bad = mi.getMask().getPlaneBitMask(badPixels)
         bg = self.calib.calculateBackground(mi, badPixels + ["DETECTED"])
  
         self.debugView('extract', exposure)
  
         ccd = exposure.getDetector()
         ratios = [[None for iAmp in ccd] for jAmp in ccd]
  
         for ii, iAmp in enumerate(ccd):
             iImage = mi[iAmp.getBBox()]
             iMask = iImage.mask.array
             select = (iMask & detected > 0) & (iMask & bad == 0) & np.isfinite(iImage.image.array)
             for jj, jAmp in enumerate(ccd):
                 if ii == jj:
                     continue
                 jImage = self.calib.extractAmp(mi.image, jAmp, iAmp, isTrimmed=self.config.isTrimmed)
                 ratios[jj][ii] = (jImage.array[select] - bg)/iImage.image.array[select]
                 self.debugPixels('pixels', iImage.image.array[select], jImage.array[select] - bg, ii, jj)
         return ratios
  

◆ getAllSchemaCatalogs()

def lsst.pipe.base.task.Task.getAllSchemaCatalogs ( self )

inherited

Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.

Returns
-------
schemacatalogs : `dict`
    Keys are butler dataset type, values are a empty catalog (an instance of the appropriate
    lsst.afw.table Catalog type) for all tasks in the hierarchy, from the top-level task down
    through all subtasks.

Notes
-----
This method may be called on any task in the hierarchy; it will return the same answer, regardless.

The default implementation should always suffice. If your subtask uses schemas the override
`Task.getSchemaCatalogs`, not this method.

Definition at line 188 of file task.py.

     def getAllSchemaCatalogs(self):
         """Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
  
         Returns
         -------
         schemacatalogs : `dict`
             Keys are butler dataset type, values are a empty catalog (an instance of the appropriate
             lsst.afw.table Catalog type) for all tasks in the hierarchy, from the top-level task down
             through all subtasks.
  
         Notes
         -----
         This method may be called on any task in the hierarchy; it will return the same answer, regardless.
  
         The default implementation should always suffice. If your subtask uses schemas the override
         `Task.getSchemaCatalogs`, not this method.
         """
         schemaDict = self.getSchemaCatalogs()
         for subtask in self._taskDict.values():
             schemaDict.update(subtask.getSchemaCatalogs())
         return schemaDict
  

◆ getFullMetadata()

def lsst.pipe.base.task.Task.getFullMetadata ( self )

inherited

Get metadata for all tasks.

Returns
-------
metadata : `lsst.daf.base.PropertySet`
    The `~lsst.daf.base.PropertySet` keys are the full task name. Values are metadata
    for the top-level task and all subtasks, sub-subtasks, etc..

Notes
-----
The returned metadata includes timing information (if ``@timer.timeMethod`` is used)
and any metadata set by the task. The name of each item consists of the full task name
with ``.`` replaced by ``:``, followed by ``.`` and the name of the item, e.g.::

    topLevelTaskName:subtaskName:subsubtaskName.itemName

using ``:`` in the full task name disambiguates the rare situation that a task has a subtask
and a metadata item with the same name.

Definition at line 210 of file task.py.

     def getFullMetadata(self):
         """Get metadata for all tasks.
  
         Returns
         -------
         metadata : `lsst.daf.base.PropertySet`
             The `~lsst.daf.base.PropertySet` keys are the full task name. Values are metadata
             for the top-level task and all subtasks, sub-subtasks, etc..
  
         Notes
         -----
         The returned metadata includes timing information (if ``@timer.timeMethod`` is used)
         and any metadata set by the task. The name of each item consists of the full task name
         with ``.`` replaced by ``:``, followed by ``.`` and the name of the item, e.g.::
  
             topLevelTaskName:subtaskName:subsubtaskName.itemName
  
         using ``:`` in the full task name disambiguates the rare situation that a task has a subtask
         and a metadata item with the same name.
         """
         fullMetadata = dafBase.PropertySet()
         for fullName, task in self.getTaskDict().items():
             fullMetadata.set(fullName.replace(".", ":"), task.metadata)
         return fullMetadata
  

◆ getFullName()

def lsst.pipe.base.task.Task.getFullName ( self )

inherited

Get the task name as a hierarchical name including parent task names.

Returns
-------
fullName : `str`
    The full name consists of the name of the parent task and each subtask separated by periods.
    For example:

    - The full name of top-level task "top" is simply "top".
    - The full name of subtask "sub" of top-level task "top" is "top.sub".
    - The full name of subtask "sub2" of subtask "sub" of top-level task "top" is "top.sub.sub2".

Definition at line 235 of file task.py.

     def getFullName(self):
         """Get the task name as a hierarchical name including parent task names.
  
         Returns
         -------
         fullName : `str`
             The full name consists of the name of the parent task and each subtask separated by periods.
             For example:
  
             - The full name of top-level task "top" is simply "top".
             - The full name of subtask "sub" of top-level task "top" is "top.sub".
             - The full name of subtask "sub2" of subtask "sub" of top-level task "top" is "top.sub.sub2".
         """
         return self._fullName
  

◆ getName()

def lsst.pipe.base.task.Task.getName ( self )

inherited

Get the name of the task.

Returns
-------
taskName : `str`
    Name of the task.

See also
--------
getFullName

Definition at line 250 of file task.py.

     def getName(self):
         """Get the name of the task.
  
         Returns
         -------
         taskName : `str`
             Name of the task.
  
         See also
         --------
         getFullName
         """
         return self._name
  

◆ getSchemaCatalogs()

def lsst.pipe.base.task.Task.getSchemaCatalogs ( self )

inherited

Get the schemas generated by this task.

Returns
-------
schemaCatalogs : `dict`
    Keys are butler dataset type, values are an empty catalog (an instance of the appropriate
    `lsst.afw.table` Catalog type) for this task.

Notes
-----

.. warning::

   Subclasses that use schemas must override this method. The default implemenation returns
   an empty dict.

This method may be called at any time after the Task is constructed, which means that all task
schemas should be computed at construction time, *not* when data is actually processed. This
reflects the philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.

See also
--------
Task.getAllSchemaCatalogs

Definition at line 159 of file task.py.

     def getSchemaCatalogs(self):
         """Get the schemas generated by this task.
  
         Returns
         -------
         schemaCatalogs : `dict`
             Keys are butler dataset type, values are an empty catalog (an instance of the appropriate
             `lsst.afw.table` Catalog type) for this task.
  
         Notes
         -----
  
         .. warning::
  
            Subclasses that use schemas must override this method. The default implemenation returns
            an empty dict.
  
         This method may be called at any time after the Task is constructed, which means that all task
         schemas should be computed at construction time, *not* when data is actually processed. This
         reflects the philosophy that the schema should not depend on the data.
  
         Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.
  
         See also
         --------
         Task.getAllSchemaCatalogs
         """
         return {}
  

◆ getTaskDict()

def lsst.pipe.base.task.Task.getTaskDict ( self )

inherited

Get a dictionary of all tasks as a shallow copy.

Returns
-------
taskDict : `dict`
    Dictionary containing full task name: task object for the top-level task and all subtasks,
    sub-subtasks, etc..

Definition at line 264 of file task.py.

     def getTaskDict(self):
         """Get a dictionary of all tasks as a shallow copy.
  
         Returns
         -------
         taskDict : `dict`
             Dictionary containing full task name: task object for the top-level task and all subtasks,
             sub-subtasks, etc..
         """
         return self._taskDict.copy()
  

◆ makeField()

def lsst.pipe.base.task.Task.makeField	(	cls,
		doc
	)

inherited

Make a `lsst.pex.config.ConfigurableField` for this task.

Parameters
----------
doc : `str`
    Help text for the field.

Returns
-------
configurableField : `lsst.pex.config.ConfigurableField`
    A `~ConfigurableField` for this task.

Examples
--------
Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use::

    class OtherTaskConfig(lsst.pex.config.Config)
aSubtask = ATaskClass.makeField("a brief description of what this task does")

Definition at line 329 of file task.py.

     def makeField(cls, doc):
         """Make a `lsst.pex.config.ConfigurableField` for this task.
  
         Parameters
         ----------
         doc : `str`
             Help text for the field.
  
         Returns
         -------
         configurableField : `lsst.pex.config.ConfigurableField`
             A `~ConfigurableField` for this task.
  
         Examples
         --------
         Provides a convenient way to specify this task is a subtask of another task.
  
         Here is an example of use::
  
             class OtherTaskConfig(lsst.pex.config.Config)
                 aSubtask = ATaskClass.makeField("a brief description of what this task does")
         """
         return ConfigurableField(doc=doc, target=cls)
  

◆ makeSubtask()

def lsst.pipe.base.task.Task.makeSubtask	(		self,
			name,
		**	keyArgs
	)

inherited

Create a subtask as a new instance as the ``name`` attribute of this task.

Parameters
----------
name : `str`
    Brief name of the subtask.
keyArgs
    Extra keyword arguments used to construct the task. The following arguments are automatically
    provided and cannot be overridden:

    - "config".
    - "parentTask".

Notes
-----
The subtask must be defined by ``Task.config.name``, an instance of pex_config ConfigurableField
or RegistryField.

Definition at line 275 of file task.py.

     def makeSubtask(self, name, **keyArgs):
         """Create a subtask as a new instance as the ``name`` attribute of this task.
  
         Parameters
         ----------
         name : `str`
             Brief name of the subtask.
         keyArgs
             Extra keyword arguments used to construct the task. The following arguments are automatically
             provided and cannot be overridden:
  
             - "config".
             - "parentTask".
  
         Notes
         -----
         The subtask must be defined by ``Task.config.name``, an instance of pex_config ConfigurableField
         or RegistryField.
         """
         taskField = getattr(self.config, name, None)
         if taskField is None:
             raise KeyError(f"{self.getFullName()}'s config does not have field {name!r}")
         subtask = taskField.apply(name=name, parentTask=self, **keyArgs)
         setattr(self, name, subtask)
  

◆ measureCrosstalkCoefficients()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.measureCrosstalkCoefficients	(	self,
		ratios,
		rejIter = `3`,
		rejSigma = `2.0`
	)

Measure crosstalk coefficients from the ratios.

Given a list of ratios for each target/source amp combination,
we measure a sigma clipped mean and error.

The coefficient errors returned are the standard deviation of
the final set of clipped input ratios.

Parameters
----------
ratios : `list` of `list` of `numpy.ndarray`
   Matrix of arrays of ratios.
rejIter : `int`
   Number of rejection iterations.
rejSigma : `float`
   Rejection threshold (sigma).

Returns
-------
coeff : `numpy.ndarray`
    Crosstalk coefficients.
coeffErr : `numpy.ndarray`
    Crosstalk coefficient errors.
coeffNum : `numpy.ndarray`
    Number of pixels for each measurement.

Notes
-----
This has been moved into MeasureCrosstalkTask to allow for easier
debugging.

The lsstDebug.Info() method can be rewritten for __name__ =
`lsst.ip.isr.measureCrosstalk`, and supports the parameters:

debug.display['measure'] : `bool`
    Display a histogram of the combined ratio measurements for
    a pair of source/target amplifiers from the final set of
    clipped input ratios.

Definition at line 401 of file measureCrosstalk.py.

     def measureCrosstalkCoefficients(self, ratios, rejIter=3, rejSigma=2.0):
         """Measure crosstalk coefficients from the ratios.
  
         Given a list of ratios for each target/source amp combination,
         we measure a sigma clipped mean and error.
  
         The coefficient errors returned are the standard deviation of
         the final set of clipped input ratios.
  
         Parameters
         ----------
         ratios : `list` of `list` of `numpy.ndarray`
            Matrix of arrays of ratios.
         rejIter : `int`
            Number of rejection iterations.
         rejSigma : `float`
            Rejection threshold (sigma).
  
         Returns
         -------
         coeff : `numpy.ndarray`
             Crosstalk coefficients.
         coeffErr : `numpy.ndarray`
             Crosstalk coefficient errors.
         coeffNum : `numpy.ndarray`
             Number of pixels for each measurement.
  
         Notes
         -----
         This has been moved into MeasureCrosstalkTask to allow for easier
         debugging.
  
         The lsstDebug.Info() method can be rewritten for __name__ =
         `lsst.ip.isr.measureCrosstalk`, and supports the parameters:
  
         debug.display['measure'] : `bool`
             Display a histogram of the combined ratio measurements for
             a pair of source/target amplifiers from the final set of
             clipped input ratios.
         """
         if rejIter is None:
             rejIter = self.config.rejIter
         if rejSigma is None:
             rejSigma = self.config.rejSigma
  
         numAmps = len(ratios)
         assert all(len(rr) == numAmps for rr in ratios)
  
         coeff = np.zeros((numAmps, numAmps))
         coeffErr = np.zeros((numAmps, numAmps))
         coeffNum = np.zeros((numAmps, numAmps), dtype=int)
  
         for ii, jj in itertools.product(range(numAmps), range(numAmps)):
             if ii == jj:
                 values = [0.0]
             else:
                 values = np.array(ratios[ii][jj])
                 values = values[np.abs(values) < 1.0]  # Discard unreasonable values
  
             coeffNum[ii][jj] = len(values)
  
             if len(values) == 0:
                 self.log.warn("No values for matrix element %d,%d" % (ii, jj))
                 coeff[ii][jj] = np.nan
                 coeffErr[ii][jj] = np.nan
             else:
                 if ii != jj:
                     for rej in range(rejIter):
                         lo, med, hi = np.percentile(values, [25.0, 50.0, 75.0])
                         sigma = 0.741*(hi - lo)
                         good = np.abs(values - med) < rejSigma*sigma
                         if good.sum() == len(good):
                             break
                         values = values[good]
  
             coeff[ii][jj] = np.mean(values)
             coeffErr[ii][jj] = np.nan if coeffNum[ii][jj] == 1 else np.std(values)
             self.debugRatios('measure', ratios, ii, jj)
  
         return coeff, coeffErr, coeffNum
  

◆ parseAndRun() [1/2]

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.parseAndRun	(		cls,
		*	args,
		**	kwargs
	)

Collate crosstalk results from multiple exposures.

Process all input exposures through runDataRef, construct
final measurements from the final list of results from each
input, and persist the output calibration.

This method will be deprecated as part of DM-24760.

Returns
-------
coeff : `numpy.ndarray`
    Crosstalk coefficients.
coeffErr : `numpy.ndarray`
    Crosstalk coefficient errors.
coeffNum : `numpy.ndarray`
    Number of pixels used for crosstalk measurement.
calib : `lsst.ip.isr.CrosstalkCalib`
    Crosstalk object created from the measurements.

Definition at line 149 of file measureCrosstalk.py.

     def parseAndRun(cls, *args, **kwargs):
         """Collate crosstalk results from multiple exposures.
  
         Process all input exposures through runDataRef, construct
         final measurements from the final list of results from each
         input, and persist the output calibration.
  
         This method will be deprecated as part of DM-24760.
  
         Returns
         -------
         coeff : `numpy.ndarray`
             Crosstalk coefficients.
         coeffErr : `numpy.ndarray`
             Crosstalk coefficient errors.
         coeffNum : `numpy.ndarray`
             Number of pixels used for crosstalk measurement.
         calib : `lsst.ip.isr.CrosstalkCalib`
             Crosstalk object created from the measurements.
  
         """
         kwargs["doReturnResults"] = True
         results = super(MeasureCrosstalkTask, cls).parseAndRun(*args, **kwargs)
         task = cls(config=results.parsedCmd.config, log=results.parsedCmd.log)
         resultList = [rr.result for rr in results.resultList]
         if results.parsedCmd.dumpRatios:
             import pickle
             pickle.dump(resultList, open(results.parsedCmd.dumpRatios, "wb"))
         coeff, coeffErr, coeffNum = task.reduce(resultList)
  
         calib = CrosstalkCalib()
         provenance = IsrProvenance()
  
         calib.coeffs = coeff
         calib.coeffErr = coeffErr
         calib.coeffNum = coeffNum
  
         outputFileName = results.parsedCmd.outputFileName
         if outputFileName is not None:
             butler = results.parsedCmd.butler
             dataId = results.parsedCmd.id.idList[0]
  
             # Rework to use lsst.ip.isr.CrosstalkCalib.
             det = butler.get('raw', dataId).getDetector()
             calib._detectorName = det.getName()
             calib._detectorSerial = det.getSerial()
             calib.nAmp = len(det)
             calib.hasCrosstalk = True
             calib.writeText(outputFileName + ".yaml")
  
             provenance.calibType = 'CROSSTALK'
             provenance._detectorName = det.getName()
             provenance.fromDataIds(results.parsedCmd.id.idList)
             provenance.writeText(outputFileName + '_prov.yaml')
  
         return Struct(
             coeff=coeff,
             coeffErr=coeffErr,
             coeffNum=coeffNum,
             calib=calib,
         )
  

◆ parseAndRun() [2/2]

def lsst.pipe.base.cmdLineTask.CmdLineTask.parseAndRun	(	cls,
		args = `None`,
		config = `None`,
		log = `None`,
		doReturnResults = `False`
	)

inherited

Parse an argument list and run the command.

Parameters
----------
args : `list`, optional
    List of command-line arguments; if `None` use `sys.argv`.
config : `lsst.pex.config.Config`-type, optional
    Config for task. If `None` use `Task.ConfigClass`.
log : `lsst.log.Log`-type, optional
    Log. If `None` use the default log.
doReturnResults : `bool`, optional
    If `True`, return the results of this task. Default is `False`. This is only intended for
    unit tests and similar use. It can easily exhaust memory (if the task returns enough data and you
    call it enough times) and it will fail when using multiprocessing if the returned data cannot be
    pickled.

Returns
-------
struct : `lsst.pipe.base.Struct`
    Fields are:

    ``argumentParser``
the argument parser (`lsst.pipe.base.ArgumentParser`).
    ``parsedCmd``
the parsed command returned by the argument parser's
`~lsst.pipe.base.ArgumentParser.parse_args` method
(`argparse.Namespace`).
    ``taskRunner``
the task runner used to run the task (an instance of `Task.RunnerClass`).
    ``resultList``
results returned by the task runner's ``run`` method, one entry
per invocation (`list`). This will typically be a list of
`Struct`, each containing at least an ``exitStatus`` integer
(0 or 1); see `Task.RunnerClass` (`TaskRunner` by default) for
more details.

Notes
-----
Calling this method with no arguments specified is the standard way to run a command-line task
from the command-line. For an example see ``pipe_tasks`` ``bin/makeSkyMap.py`` or almost any other
file in that directory.

If one or more of the dataIds fails then this routine will exit (with a status giving the
number of failed dataIds) rather than returning this struct;  this behaviour can be
overridden by specifying the ``--noExit`` command-line option.

Definition at line 549 of file cmdLineTask.py.

     def parseAndRun(cls, args=None, config=None, log=None, doReturnResults=False):
         """Parse an argument list and run the command.
  
         Parameters
         ----------
         args : `list`, optional
             List of command-line arguments; if `None` use `sys.argv`.
         config : `lsst.pex.config.Config`-type, optional
             Config for task. If `None` use `Task.ConfigClass`.
         log : `lsst.log.Log`-type, optional
             Log. If `None` use the default log.
         doReturnResults : `bool`, optional
             If `True`, return the results of this task. Default is `False`. This is only intended for
             unit tests and similar use. It can easily exhaust memory (if the task returns enough data and you
             call it enough times) and it will fail when using multiprocessing if the returned data cannot be
             pickled.
  
         Returns
         -------
         struct : `lsst.pipe.base.Struct`
             Fields are:
  
             ``argumentParser``
                 the argument parser (`lsst.pipe.base.ArgumentParser`).
             ``parsedCmd``
                 the parsed command returned by the argument parser's
                 `~lsst.pipe.base.ArgumentParser.parse_args` method
                 (`argparse.Namespace`).
             ``taskRunner``
                 the task runner used to run the task (an instance of `Task.RunnerClass`).
             ``resultList``
                 results returned by the task runner's ``run`` method, one entry
                 per invocation (`list`). This will typically be a list of
                 `Struct`, each containing at least an ``exitStatus`` integer
                 (0 or 1); see `Task.RunnerClass` (`TaskRunner` by default) for
                 more details.
  
         Notes
         -----
         Calling this method with no arguments specified is the standard way to run a command-line task
         from the command-line. For an example see ``pipe_tasks`` ``bin/makeSkyMap.py`` or almost any other
         file in that directory.
  
         If one or more of the dataIds fails then this routine will exit (with a status giving the
         number of failed dataIds) rather than returning this struct;  this behaviour can be
         overridden by specifying the ``--noExit`` command-line option.
         """
         if args is None:
             commandAsStr = " ".join(sys.argv)
             args = sys.argv[1:]
         else:
             commandAsStr = "{}{}".format(lsst.utils.get_caller_name(skip=1), tuple(args))
  
         argumentParser = cls._makeArgumentParser()
         if config is None:
             config = cls.ConfigClass()
         parsedCmd = argumentParser.parse_args(config=config, args=args, log=log, override=cls.applyOverrides)
         # print this message after parsing the command so the log is fully configured
         parsedCmd.log.info("Running: %s", commandAsStr)
  
         taskRunner = cls.RunnerClass(TaskClass=cls, parsedCmd=parsedCmd, doReturnResults=doReturnResults)
         resultList = taskRunner.run(parsedCmd)
  
         try:
             nFailed = sum(((res.exitStatus != 0) for res in resultList))
         except (TypeError, AttributeError) as e:
             # NOTE: TypeError if resultList is None, AttributeError if it doesn't have exitStatus.
             parsedCmd.log.warn("Unable to retrieve exit status (%s); assuming success", e)
             nFailed = 0
  
         if nFailed > 0:
             if parsedCmd.noExit:
                 parsedCmd.log.error("%d dataRefs failed; not exiting as --noExit was set", nFailed)
             else:
                 sys.exit(nFailed)
  
         return Struct(
             argumentParser=argumentParser,
             parsedCmd=parsedCmd,
             taskRunner=taskRunner,
             resultList=resultList,
         )
  

◆ reduce()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.reduce	(	self,
		ratioList
	)

Combine ratios to produce crosstalk coefficients.

Parameters
----------
ratioList : `list` of `list` of `list` of `numpy.ndarray`
    A list of matrices of arrays; a list of results from
    `extractCrosstalkRatios`.

Returns
-------
coeff : `numpy.ndarray`
    Crosstalk coefficients.
coeffErr : `numpy.ndarray`
    Crosstalk coefficient errors.
coeffNum : `numpy.ndarray`
    Number of pixels used for crosstalk measurement.

Raises
------
RuntimeError
    Raised if there is no crosstalk data available.

Notes
-----
The lsstDebug.Info() method can be rewritten for __name__ =
`lsst.ip.isr.measureCrosstalk`, and supports the parameters:

debug.display['reduce'] : `bool`
    Display a histogram of the combined ratio measurements for
    a pair of source/target amplifiers from all input
    exposures/detectors.

Definition at line 333 of file measureCrosstalk.py.

     def reduce(self, ratioList):
         """Combine ratios to produce crosstalk coefficients.
  
         Parameters
         ----------
         ratioList : `list` of `list` of `list` of `numpy.ndarray`
             A list of matrices of arrays; a list of results from
             `extractCrosstalkRatios`.
  
         Returns
         -------
         coeff : `numpy.ndarray`
             Crosstalk coefficients.
         coeffErr : `numpy.ndarray`
             Crosstalk coefficient errors.
         coeffNum : `numpy.ndarray`
             Number of pixels used for crosstalk measurement.
  
         Raises
         ------
         RuntimeError
             Raised if there is no crosstalk data available.
  
         Notes
         -----
         The lsstDebug.Info() method can be rewritten for __name__ =
         `lsst.ip.isr.measureCrosstalk`, and supports the parameters:
  
         debug.display['reduce'] : `bool`
             Display a histogram of the combined ratio measurements for
             a pair of source/target amplifiers from all input
             exposures/detectors.
         """
         numAmps = None
         for rr in ratioList:
             if rr is None:
                 continue
  
             if numAmps is None:
                 numAmps = len(rr)
  
             assert len(rr) == numAmps
             assert all(len(xx) == numAmps for xx in rr)
  
         if numAmps is None:
             raise RuntimeError("Unable to measure crosstalk signal for any amplifier")
  
         ratios = [[None for jj in range(numAmps)] for ii in range(numAmps)]
         for ii, jj in itertools.product(range(numAmps), range(numAmps)):
             if ii == jj:
                 result = []
             else:
                 values = [rr[ii][jj] for rr in ratioList]
                 num = sum(len(vv) for vv in values)
                 if num == 0:
                     self.log.warn("No values for matrix element %d,%d" % (ii, jj))
                     result = np.nan
                 else:
                     result = np.concatenate([vv for vv in values if len(vv) > 0])
             ratios[ii][jj] = result
             self.debugRatios('reduce', ratios, ii, jj)
         coeff, coeffErr, coeffNum = self.measureCrosstalkCoefficients(ratios, self.config.rejIter,
                                                                       self.config.rejSigma)
         self.log.info("Coefficients:\n%s\n", coeff)
         self.log.info("Errors:\n%s\n", coeffErr)
         self.log.info("Numbers:\n%s\n", coeffNum)
         return coeff, coeffErr, coeffNum
  

◆ run()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.run	(	self,
		exposure,
		dataId = `None`
	)

Extract and return cross talk ratios for an exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Image data to measure crosstalk ratios from.
dataId   :
    Optional data ID for the exposure to process; used for logging.

Returns
-------
ratios : `list` of `list` of `numpy.ndarray`
    A matrix of pixel arrays.

Definition at line 245 of file measureCrosstalk.py.

     def run(self, exposure, dataId=None):
         """Extract and return cross talk ratios for an exposure.
  
         Parameters
         ----------
         exposure : `lsst.afw.image.Exposure`
             Image data to measure crosstalk ratios from.
         dataId   :
             Optional data ID for the exposure to process; used for logging.
  
         Returns
         -------
         ratios : `list` of `list` of `numpy.ndarray`
             A matrix of pixel arrays.
         """
         ratios = self.extractCrosstalkRatios(exposure)
         self.log.info("Extracted %d pixels from %s",
                       sum(len(jj) for ii in ratios for jj in ii if jj is not None), dataId)
         return ratios
  

◆ runDataRef()

def lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.runDataRef	(	self,
		dataRef
	)

Get crosstalk ratios for detector.

Parameters
----------
dataRef : `lsst.daf.peristence.ButlerDataRef`
    Data references for detectors to process.

Returns
-------
ratios : `list` of `list` of `numpy.ndarray`
    A matrix of pixel arrays.

Definition at line 219 of file measureCrosstalk.py.

     def runDataRef(self, dataRef):
         """Get crosstalk ratios for detector.
  
         Parameters
         ----------
         dataRef : `lsst.daf.peristence.ButlerDataRef`
             Data references for detectors to process.
  
         Returns
         -------
         ratios : `list` of `list` of `numpy.ndarray`
             A matrix of pixel arrays.
         """
         exposure = None
         if not self.config.doRerunIsr:
             try:
                 exposure = dataRef.get("postISRCCD")
             except NoResults:
                 pass
  
         if exposure is None:
             exposure = self.isr.runDataRef(dataRef).exposure
  
         dataId = dataRef.dataId
         return self.run(exposure, dataId=dataId)
  

◆ timer()

def lsst.pipe.base.task.Task.timer	(	self,
		name,
		logLevel = `Log.DEBUG`
	)

inherited

Context manager to log performance data for an arbitrary block of code.

Parameters
----------
name : `str`
    Name of code being timed; data will be logged using item name: ``Start`` and ``End``.
logLevel
    A `lsst.log` level constant.

Examples
--------
Creating a timer context::

    with self.timer("someCodeToTime"):
pass  # code to time

See also
--------
timer.logInfo

Definition at line 301 of file task.py.

     def timer(self, name, logLevel=Log.DEBUG):
         """Context manager to log performance data for an arbitrary block of code.
  
         Parameters
         ----------
         name : `str`
             Name of code being timed; data will be logged using item name: ``Start`` and ``End``.
         logLevel
             A `lsst.log` level constant.
  
         Examples
         --------
         Creating a timer context::
  
             with self.timer("someCodeToTime"):
                 pass  # code to time
  
         See also
         --------
         timer.logInfo
         """
         logInfo(obj=self, prefix=name + "Start", logLevel=logLevel)
         try:
             yield
         finally:
             logInfo(obj=self, prefix=name + "End", logLevel=logLevel)
  

◆ writeConfig()

def lsst.pipe.base.cmdLineTask.CmdLineTask.writeConfig	(	self,
		butler,
		clobber = `False`,
		doBackup = `True`
	)

inherited

Write the configuration used for processing the data, or check that an existing
one is equal to the new one if present.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler used to write the config. The config is written to dataset type
    `CmdLineTask._getConfigName`.
clobber : `bool`, optional
    A boolean flag that controls what happens if a config already has been saved:
    - `True`: overwrite or rename the existing config, depending on ``doBackup``.
    - `False`: raise `TaskError` if this config does not match the existing config.
doBackup : bool, optional
    Set to `True` to backup the config files if clobbering.

Reimplemented in lsst.pipe.tasks.postprocess.ConsolidateSourceTableTask.

Definition at line 656 of file cmdLineTask.py.

     def writeConfig(self, butler, clobber=False, doBackup=True):
         """Write the configuration used for processing the data, or check that an existing
         one is equal to the new one if present.
  
         Parameters
         ----------
         butler : `lsst.daf.persistence.Butler`
             Data butler used to write the config. The config is written to dataset type
             `CmdLineTask._getConfigName`.
         clobber : `bool`, optional
             A boolean flag that controls what happens if a config already has been saved:
             - `True`: overwrite or rename the existing config, depending on ``doBackup``.
             - `False`: raise `TaskError` if this config does not match the existing config.
         doBackup : bool, optional
             Set to `True` to backup the config files if clobbering.
         """
         configName = self._getConfigName()
         if configName is None:
             return
         if clobber:
             butler.put(self.config, configName, doBackup=doBackup)
         elif butler.datasetExists(configName, write=True):
             # this may be subject to a race condition; see #2789
             try:
                 oldConfig = butler.get(configName, immediate=True)
             except Exception as exc:
                 raise type(exc)(f"Unable to read stored config file {configName} (exc); "
                                 "consider using --clobber-config")
  
             def logConfigMismatch(msg):
                 self.log.fatal("Comparing configuration: %s", msg)
  
             if not self.config.compare(oldConfig, shortcut=False, output=logConfigMismatch):
                 raise TaskError(
                     f"Config does not match existing task config {configName!r} on disk; "
                     "tasks configurations must be consistent within the same output repo "
                     "(override with --clobber-config)")
         else:
             butler.put(self.config, configName)
  

◆ writeMetadata()

def lsst.pipe.base.cmdLineTask.CmdLineTask.writeMetadata	(	self,
		dataRef
	)

inherited

Write the metadata produced from processing the data.

Parameters
----------
dataRef
    Butler data reference used to write the metadata.
    The metadata is written to dataset type `CmdLineTask._getMetadataName`.

Reimplemented in lsst.pipe.tasks.postprocess.WriteObjectTableTask, lsst.pipe.tasks.postprocess.ConsolidateSourceTableTask, lsst.pipe.tasks.postprocess.TransformSourceTableTask, lsst.pipe.tasks.postprocess.ConsolidateObjectTableTask, lsst.pipe.tasks.postprocess.TransformCatalogBaseTask, lsst.pipe.drivers.multiBandDriver.MultiBandDriverTask, lsst.pipe.drivers.coaddDriver.CoaddDriverTask, and lsst.pipe.tasks.postprocess.WriteSourceTableTask.

Definition at line 731 of file cmdLineTask.py.

     def writeMetadata(self, dataRef):
         """Write the metadata produced from processing the data.
  
         Parameters
         ----------
         dataRef
             Butler data reference used to write the metadata.
             The metadata is written to dataset type `CmdLineTask._getMetadataName`.
         """
         try:
             metadataName = self._getMetadataName()
             if metadataName is not None:
                 dataRef.put(self.getFullMetadata(), metadataName)
         except Exception as e:
             self.log.warn("Could not persist metadata for dataId=%s: %s", dataRef.dataId, e)
  

◆ writePackageVersions()

def lsst.pipe.base.cmdLineTask.CmdLineTask.writePackageVersions	(	self,
		butler,
		clobber = `False`,
		doBackup = `True`,
		dataset = `"packages"`
	)

inherited

Compare and write package versions.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler used to read/write the package versions.
clobber : `bool`, optional
    A boolean flag that controls what happens if versions already have been saved:
    - `True`: overwrite or rename the existing version info, depending on ``doBackup``.
    - `False`: raise `TaskError` if this version info does not match the existing.
doBackup : `bool`, optional
    If `True` and clobbering, old package version files are backed up.
dataset : `str`, optional
    Name of dataset to read/write.

Raises
------
TaskError
    Raised if there is a version mismatch with current and persisted lists of package versions.

Notes
-----
Note that this operation is subject to a race condition.

Definition at line 747 of file cmdLineTask.py.

     def writePackageVersions(self, butler, clobber=False, doBackup=True, dataset="packages"):
         """Compare and write package versions.
  
         Parameters
         ----------
         butler : `lsst.daf.persistence.Butler`
             Data butler used to read/write the package versions.
         clobber : `bool`, optional
             A boolean flag that controls what happens if versions already have been saved:
             - `True`: overwrite or rename the existing version info, depending on ``doBackup``.
             - `False`: raise `TaskError` if this version info does not match the existing.
         doBackup : `bool`, optional
             If `True` and clobbering, old package version files are backed up.
         dataset : `str`, optional
             Name of dataset to read/write.
  
         Raises
         ------
         TaskError
             Raised if there is a version mismatch with current and persisted lists of package versions.
  
         Notes
         -----
         Note that this operation is subject to a race condition.
         """
         packages = Packages.fromSystem()
  
         if clobber:
             return butler.put(packages, dataset, doBackup=doBackup)
         if not butler.datasetExists(dataset, write=True):
             return butler.put(packages, dataset)
  
         try:
             old = butler.get(dataset, immediate=True)
         except Exception as exc:
             raise type(exc)(f"Unable to read stored version dataset {dataset} ({exc}); "
                             "consider using --clobber-versions or --no-versions")
         # Note that because we can only detect python modules that have been imported, the stored
         # list of products may be more or less complete than what we have now.  What's important is
         # that the products that are in common have the same version.
         diff = packages.difference(old)
         if diff:
             versions_str = "; ".join(f"{pkg}: {diff[pkg][1]} vs {diff[pkg][0]}" for pkg in diff)
             raise TaskError(
                 f"Version mismatch ({versions_str}); consider using --clobber-versions or --no-versions")
         # Update the old set of packages in case we have more packages that haven't been persisted.
         extra = packages.extra(old)
         if extra:
             old.update(packages)
             butler.put(old, dataset, doBackup=doBackup)
  

◆ writeSchemas()

def lsst.pipe.base.cmdLineTask.CmdLineTask.writeSchemas	(	self,
		butler,
		clobber = `False`,
		doBackup = `True`
	)

inherited

Write the schemas returned by `lsst.pipe.base.Task.getAllSchemaCatalogs`.

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler used to write the schema. Each schema is written to the dataset type specified as the
    key in the dict returned by `~lsst.pipe.base.Task.getAllSchemaCatalogs`.
clobber : `bool`, optional
    A boolean flag that controls what happens if a schema already has been saved:
    - `True`: overwrite or rename the existing schema, depending on ``doBackup``.
    - `False`: raise `TaskError` if this schema does not match the existing schema.
doBackup : `bool`, optional
    Set to `True` to backup the schema files if clobbering.

Notes
-----
If ``clobber`` is `False` and an existing schema does not match a current schema,
then some schemas may have been saved successfully and others may not, and there is no easy way to
tell which is which.

Definition at line 696 of file cmdLineTask.py.

     def writeSchemas(self, butler, clobber=False, doBackup=True):
         """Write the schemas returned by `lsst.pipe.base.Task.getAllSchemaCatalogs`.
  
         Parameters
         ----------
         butler : `lsst.daf.persistence.Butler`
             Data butler used to write the schema. Each schema is written to the dataset type specified as the
             key in the dict returned by `~lsst.pipe.base.Task.getAllSchemaCatalogs`.
         clobber : `bool`, optional
             A boolean flag that controls what happens if a schema already has been saved:
             - `True`: overwrite or rename the existing schema, depending on ``doBackup``.
             - `False`: raise `TaskError` if this schema does not match the existing schema.
         doBackup : `bool`, optional
             Set to `True` to backup the schema files if clobbering.
  
         Notes
         -----
         If ``clobber`` is `False` and an existing schema does not match a current schema,
         then some schemas may have been saved successfully and others may not, and there is no easy way to
         tell which is which.
         """
         for dataset, catalog in self.getAllSchemaCatalogs().items():
             schemaDataset = dataset + "_schema"
             if clobber:
                 butler.put(catalog, schemaDataset, doBackup=doBackup)
             elif butler.datasetExists(schemaDataset, write=True):
                 oldSchema = butler.get(schemaDataset, immediate=True).getSchema()
                 if not oldSchema.compare(catalog.getSchema(), afwTable.Schema.IDENTICAL):
                     raise TaskError(
                         f"New schema does not match schema {dataset!r} on disk; "
                         "schemas must be consistent within the same output repo "
                         "(override with --clobber-config)")
             else:
                 butler.put(catalog, schemaDataset)
  

Member Data Documentation

◆ calib

lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.calib

Definition at line 135 of file measureCrosstalk.py.

◆ canMultiprocess

bool lsst.pipe.base.cmdLineTask.CmdLineTask.canMultiprocess = True

staticinherited

Definition at line 524 of file cmdLineTask.py.

◆ config

lsst.pipe.base.task.Task.config

inherited

Definition at line 149 of file task.py.

◆ ConfigClass

lsst.ip.isr.measureCrosstalk.MeasureCrosstalkTask.ConfigClass = MeasureCrosstalkConfig

static

Definition at line 129 of file measureCrosstalk.py.

◆ log

lsst.pipe.base.task.Task.log

inherited

Definition at line 148 of file task.py.

◆ metadata

lsst.pipe.base.task.Task.metadata

inherited

Definition at line 121 of file task.py.

◆ RunnerClass

lsst.pipe.base.cmdLineTask.CmdLineTask.RunnerClass = TaskRunner

staticinherited

Definition at line 523 of file cmdLineTask.py.

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

/j/snowflake/release/lsstsw/stack/1a1d771/Linux64/ip_isr/20.0.0-5-gfcb36e1+4/python/lsst/ip/isr/measureCrosstalk.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __reduce__()

◆ applyOverrides()

◆ debugPixels()

◆ debugRatios()

◆ debugView()

◆ emptyMetadata()

◆ extractCrosstalkRatios()

◆ getAllSchemaCatalogs()

◆ getFullMetadata()

◆ getFullName()

◆ getName()

◆ getSchemaCatalogs()

◆ getTaskDict()

◆ makeField()

◆ makeSubtask()

◆ measureCrosstalkCoefficients()

◆ parseAndRun() [1/2]

◆ parseAndRun() [2/2]

◆ reduce()

◆ run()

◆ runDataRef()

◆ timer()

◆ writeConfig()

◆ writeMetadata()

◆ writePackageVersions()

◆ writeSchemas()

Member Data Documentation

◆ calib

◆ canMultiprocess

◆ config

◆ ConfigClass

◆ log

◆ metadata

◆ RunnerClass

◆ init()

◆ reduce()