lsst.ip.isr.assembleCcdTask.AssembleCcdTask Class Reference

More...

Inheritance diagram for lsst.ip.isr.assembleCcdTask.AssembleCcdTask:

Public Member Functions
def	__init__ (self, **kwargs)
	Initialize the AssembleCcdTask. More...
def	assembleCcd (self, assembleInput)
	Assemble a set of amps into a single CCD size image. More...
def	postprocessExposure (self, outExposure, inExposure)

Public Attributes
	allKeysToRemove

Static Public Attributes
	ConfigClass = AssembleCcdConfig

Detailed Description

Assemble a set of amplifier images into a full detector size set of pixels.

Contents

• Description
• Task initialization
• Inputs/Outputs to the assembleCcd method
• Configuration parameters
• Debug variables
• A complete example of using AssembleCcdTask

Description

This task assembles sections of an image into a larger mosaic. The sub-sections are typically amplifier sections and are to be assembled into a detector size pixel grid. The assembly is driven by the entries in the raw amp information. The task can be configured to return a detector image with non-data (e.g. overscan) pixels included. The task can also renormalize the pixel values to a nominal gain of 1. The task also removes exposure metadata that has context in raw amps, but not in trimmed detectors (e.g. 'BIASSEC').

Task initialization

Initialize the AssembleCcdTask.

    The keys for removal specified in the config are added to a default set:
    ('DATASEC', 'BIASSEC', 'TRIMSEC', 'GAIN')

Inputs/Outputs to the assembleCcd method

Assemble a set of amps into a single CCD size image.

Parameters

[in]

assembleInput

– Either a dictionary of amp lsst.afw.image.Exposures or a single lsst.afw.image.Exposure containing all raw amps. If a dictionary of amp exposures, the key should be the amp name.

Returns

assembledCcd – An lsst.afw.image.Exposure of the assembled amp sections.

Exceptions

TypeError

with the following string:

Expected either a dictionary of amp exposures or a single raw exposure

The input exposures to be assembled do not adhere to the required format.

Exceptions

RuntimeError

with the following string:

No ccd detector found

The detector set on the input exposure is not set.

Configuration parameters

See AssembleCcdConfig

Debug variables

The command line task interface supports a flag -d to import debug.py from your PYTHONPATH; see Debugging Tasks with lsstDebug for more about debug.py files.

The available variables in AssembleCcdTask are:

display

A dictionary containing debug point names as keys with frame number as value. Valid keys are:

assembledExposure

display assembled exposure

A complete example of using AssembleCcdTask

---

To investigate the Debug variables, put something like

import lsstDebug
def DebugInfo(name):
    di = lsstDebug.getInfo(name)        # N.b. lsstDebug.Info(name) would call us recursively
    if name == "lsst.ip.isr.assembleCcdTask":
        di.display = {'assembledExposure':2}
    return di
 
lsstDebug.Info = DebugInfo

into your debug.py file and run runAssembleTask.py with the –debug flag.

Conversion notes:
    Display code should be updated once we settle on a standard way of controlling what is displayed.

Definition at line 53 of file assembleCcdTask.py.

Constructor & Destructor Documentation

__init__()

def lsst.ip.isr.assembleCcdTask.AssembleCcdTask.__init__	(		self,
		**	kwargs
	)

Initialize the AssembleCcdTask.

    The keys for removal specified in the config are added to a default set:
    ('DATASEC', 'BIASSEC', 'TRIMSEC', 'GAIN')

Definition at line 129 of file assembleCcdTask.py.

    def __init__(self, **kwargs):
        """!Initialize the AssembleCcdTask
 
        The keys for removal specified in the config are added to a default set:
        ('DATASEC', 'BIASSEC', 'TRIMSEC', 'GAIN')
        """
        pipeBase.Task.__init__(self, **kwargs)
 
        self.allKeysToRemove = ('DATASEC', 'BIASSEC', 'TRIMSEC', 'GAIN') + tuple(self.config.keysToRemove)
 

Member Function Documentation

assembleCcd()

def lsst.ip.isr.assembleCcdTask.AssembleCcdTask.assembleCcd	(		self,
			assembleInput
	)

Assemble a set of amps into a single CCD size image.

Parameters

[in]

assembleInput

– Either a dictionary of amp lsst.afw.image.Exposures or a single lsst.afw.image.Exposure containing all raw amps. If a dictionary of amp exposures, the key should be the amp name.

Returns

assembledCcd – An lsst.afw.image.Exposure of the assembled amp sections.

Exceptions

TypeError

with the following string:

Expected either a dictionary of amp exposures or a single raw exposure

The input exposures to be assembled do not adhere to the required format.

Exceptions

RuntimeError

with the following string:

No ccd detector found

The detector set on the input exposure is not set.

Definition at line 139 of file assembleCcdTask.py.

    def assembleCcd(self, assembleInput):
        """!Assemble a set of amps into a single CCD size image
        @param[in] assembleInput -- Either a dictionary of amp lsst.afw.image.Exposures or a single
                                    lsst.afw.image.Exposure containing all raw
                                    amps.  If a dictionary of amp exposures,
                                    the key should be the amp name.
        @return assembledCcd -- An lsst.afw.image.Exposure of the assembled amp sections.
 
        @throws TypeError with the following string:
 
        <DL>
          <DT> Expected either a dictionary of amp exposures or a single raw exposure
          <DD> The input exposures to be assembled do not adhere to the required format.
        </DL>
 
        @throws RuntimeError with the following string:
 
        <DL>
          <DT> No ccd detector found
          <DD> The detector set on the input exposure is not set.
        </DL>
        """
        ccd = None
        if isinstance(assembleInput, dict):
            # assembleInput is a dictionary of amp name: amp exposure
 
            # Assume all amps have the same detector, so get the detector from an arbitrary amp
            ccd = next(iter(assembleInput.values())).getDetector()
 
            def getNextExposure(amp):
                return assembleInput[amp.getName()]
        elif hasattr(assembleInput, "getMaskedImage"):
            # assembleInput is a single exposure
            ccd = assembleInput.getDetector()
 
            def getNextExposure(amp):
                return assembleInput
        else:
            raise TypeError("Expected either a dictionary of amp exposures or a single raw exposure")
 
        if ccd is None:
            raise RuntimeError("No ccd detector found")
 
        if not self.config.doTrim:
            outBox = cameraGeomUtils.calcRawCcdBBox(ccd)
        else:
            outBox = ccd.getBBox()
        outExposure = afwImage.ExposureF(outBox)
        outMI = outExposure.getMaskedImage()
 
        if self.config.doTrim:
            assemble = cameraGeom.assembleAmplifierImage
        else:
            assemble = cameraGeom.assembleAmplifierRawImage
 
        for amp in ccd:
            inMI = getNextExposure(amp).getMaskedImage()
            assemble(outMI, inMI, amp)
        #
        # If we are returning an "untrimmed" image (with overscans and extended register) we
        # need to update the ampInfo table in the Detector as we've moved the amp images into
        # place in a single Detector image
        #
        if not self.config.doTrim:
            ccd = cameraGeom.makeUpdatedDetector(ccd)
 
        outExposure.setDetector(ccd)
        self.postprocessExposure(outExposure=outExposure, inExposure=getNextExposure(ccd[0]))
 
        return outExposure
 

postprocessExposure()

def lsst.ip.isr.assembleCcdTask.AssembleCcdTask.postprocessExposure	(		self,
			outExposure,
			inExposure
	)

Set exposure non-image attributes, including wcs and metadata and display exposure (if requested)

Call after assembling the pixels

@param[in,out]  outExposure assembled exposure:
                            - removes unwanted keywords
                            - sets wcs, filter, and detector
@param[in]      inExposure  input exposure

Definition at line 210 of file assembleCcdTask.py.

    def postprocessExposure(self, outExposure, inExposure):
        """Set exposure non-image attributes, including wcs and metadata and display exposure (if requested)
 
        Call after assembling the pixels
 
        @param[in,out]  outExposure assembled exposure:
                                    - removes unwanted keywords
                                    - sets wcs, filter, and detector
        @param[in]      inExposure  input exposure
        """
        if inExposure.hasWcs():
            outExposure.setWcs(inExposure.getWcs())
 
        exposureMetadata = inExposure.getMetadata()
        for key in self.allKeysToRemove:
            if exposureMetadata.exists(key):
                exposureMetadata.remove(key)
        outExposure.setMetadata(exposureMetadata)
 
        # note: don't copy PhotoCalib, because it is assumed to be unknown in raw data
        outExposure.info.id = inExposure.info.id
        outExposure.setFilterLabel(inExposure.getFilterLabel())
        outExposure.getInfo().setVisitInfo(inExposure.getInfo().getVisitInfo())
 
        frame = getDebugFrame(self._display, "assembledExposure")
        if frame:
            afwDisplay.Display(frame=frame).mtv(outExposure, title="postprocessExposure")

Member Data Documentation

allKeysToRemove

lsst.ip.isr.assembleCcdTask.AssembleCcdTask.allKeysToRemove

Definition at line 137 of file assembleCcdTask.py.

ConfigClass

lsst.ip.isr.assembleCcdTask.AssembleCcdTask.ConfigClass = AssembleCcdConfig

static

Definition at line 126 of file assembleCcdTask.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_isr/22.0.1-27-g97737f7+2a20fdde0d/python/lsst/ip/isr/assembleCcdTask.py