lsst.ip.isr g5e83b0b6c4+64f77a1dfb
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Attributes | List of all members
lsst.ip.isr.assembleCcdTask.AssembleCcdTask Class Reference

More...

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

Public Member Functions

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

Public Attributes

 allKeysToRemove
 

Static Public Attributes

 ConfigClass = AssembleCcdConfig
 

Static Protected Attributes

str _DefaultName = "assembleCcd"
 

Detailed Description

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

Contents

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

Inputs/Outputs to the assembleCcd method

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__()

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 137 of file assembleCcdTask.py.

Member Function Documentation

◆ assembleCcd()

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
TypeErrorwith 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
RuntimeErrorwith the following string:
No ccd detector found
The detector set on the input exposure is not set.

Definition at line 147 of file assembleCcdTask.py.

◆ postprocessExposure()

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 224 of file assembleCcdTask.py.

Member Data Documentation

◆ _DefaultName

str lsst.ip.isr.assembleCcdTask.AssembleCcdTask._DefaultName = "assembleCcd"
staticprotected

Definition at line 135 of file assembleCcdTask.py.

◆ allKeysToRemove

lsst.ip.isr.assembleCcdTask.AssembleCcdTask.allKeysToRemove

Definition at line 145 of file assembleCcdTask.py.

◆ ConfigClass

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

Definition at line 134 of file assembleCcdTask.py.


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