lsst.pipe.drivers 22.0.1-1-g8b6839f+5b309e1f25
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.drivers.constructCalibs.SkyTask Class Reference
Inheritance diagram for lsst.pipe.drivers.constructCalibs.SkyTask:
lsst.pipe.drivers.constructCalibs.CalibTask lsst::ctrl::pool::parallel::BatchPoolTask lsst::ctrl::pool::parallel::BatchCmdLineTask

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def scatterProcess (self, pool, ccdIdLists)
 Scatter the processing among the nodes. More...
 
def measureBackground (self, cache, dataId)
 Measure background model for CCD. More...
 
def processSingleBackground (self, dataRef)
 Process a single CCD for the background. More...
 
def processSingle (self, dataRef, backgrounds, scales)
 
def combine (self, cache, struct, outputId)
 Combine multiple background models of a particular CCD and write the output. More...
 

Static Public Attributes

 ConfigClass = SkyConfig
 
string calibName = "sky"
 

Detailed Description

Task for sky frame construction

The sky frame is a (relatively) small-scale background
model, the response of the camera to the sky.

To construct, we first remove a large-scale background (e.g., caused
by moonlight) which may vary from image to image. Then we construct a
model of the sky, which is essentially a binned version of the image
(important configuration parameters: sky.background.[xy]BinSize).
It is these models which are coadded to yield the sky frame.

Definition at line 1182 of file constructCalibs.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.drivers.constructCalibs.SkyTask.__init__ (   self,
args,
**  kwargs 
)
Constructor

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1198 of file constructCalibs.py.

Member Function Documentation

◆ combine()

def lsst.pipe.drivers.constructCalibs.SkyTask.combine (   self,
  cache,
  struct,
  outputId 
)

Combine multiple background models of a particular CCD and write the output.

    Only the slave nodes execute this method.

    @param cache  Process pool cache
    @param struct  Parameters for the combination, which has the following components:
        * ccdName     Name tuple for CCD
        * ccdIdList   List of data identifiers for combination
    @param outputId    Data identifier for combined image (exposure part only)
    @return binned calib image

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1316 of file constructCalibs.py.

◆ measureBackground()

def lsst.pipe.drivers.constructCalibs.SkyTask.measureBackground (   self,
  cache,
  dataId 
)

Measure background model for CCD.

    This method is executed by the slaves.

    The background models for all CCDs in an exposure will be
    combined to form a full focal-plane background model.

    @param cache  Process pool cache
    @param dataId  Data identifier
    @return Bcakground model

Definition at line 1246 of file constructCalibs.py.

◆ processSingle()

def lsst.pipe.drivers.constructCalibs.SkyTask.processSingle (   self,
  dataRef,
  backgrounds,
  scales 
)
Process a single CCD, specified by a data reference

We subtract the appropriate focal plane background model,
divide by the appropriate scale and measure the background.

Only slave nodes execute this method.

@param dataRef  Data reference for single CCD
@param backgrounds  Background model for each visit
@param scales  Scales for each visit
@return Processed exposure

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1288 of file constructCalibs.py.

◆ processSingleBackground()

def lsst.pipe.drivers.constructCalibs.SkyTask.processSingleBackground (   self,
  dataRef 
)

Process a single CCD for the background.

    This method is executed by the slaves.

    Because we're interested in the background, we detect and mask astrophysical
    sources, and pixels above the noise level.

    @param dataRef  Data reference for CCD.
    @return processed exposure

Definition at line 1269 of file constructCalibs.py.

◆ scatterProcess()

def lsst.pipe.drivers.constructCalibs.SkyTask.scatterProcess (   self,
  pool,
  ccdIdLists 
)

Scatter the processing among the nodes.

    Only the master node executes this method, assigning work to the
    slaves.

    We measure and subtract off a large-scale background model across
    all CCDs, which requires a scatter/gather. Then we process the
    individual CCDs, subtracting the large-scale background model and
    the residual background model measured. These residuals will be
    combined for the sky frame.

    @param pool  Process pool
    @param ccdIdLists  Dict of data identifier lists for each CCD name
    @return Dict of lists of returned data for each CCD name

Reimplemented from lsst.pipe.drivers.constructCalibs.CalibTask.

Definition at line 1203 of file constructCalibs.py.

Member Data Documentation

◆ calibName

string lsst.pipe.drivers.constructCalibs.SkyTask.calibName = "sky"
static

Definition at line 1196 of file constructCalibs.py.

◆ ConfigClass

lsst.pipe.drivers.constructCalibs.SkyTask.ConfigClass = SkyConfig
static

Definition at line 1194 of file constructCalibs.py.


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