lsst.pipe.tasks  13.0-66-gfbf2f2ce+5
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.multiBand.MergeMeasurementsTask Class Reference

Merge measurements from multiple bands. More...

Inheritance diagram for lsst.pipe.tasks.multiBand.MergeMeasurementsTask:
lsst.pipe.tasks.multiBand.MergeSourcesTask

Public Member Functions

def __init__ (self, butler=None, schema=None, kwargs)
 Initialize the task. More...
 
def mergeCatalogs (self, catalogs, patchRef)
 Merge measurement catalogs to create a single reference catalog for forced photometry. More...
 
def getInputSchema (self, butler=None, schema=None)
 Obtain the input schema either directly or froma butler reference. More...
 
def run (self, patchRefList)
 Merge coadd sources from multiple bands. More...
 
def readCatalog (self, patchRef)
 Read input catalog. More...
 
def write (self, patchRef, catalog)
 Write the output. More...
 
def writeMetadata (self, dataRefList)
 No metadata to write, and not sure how to write it for a list of dataRefs. More...
 

Public Attributes

 schemaMapper
 
 fluxKey
 
 fluxErrKey
 
 fluxFlagKey
 
 flagKeys
 
 schema
 
 pseudoFilterKeys
 
 badFlags
 

Static Public Attributes

 ConfigClass = MergeMeasurementsConfig
 
string inputDataset = "meas"
 
string outputDataset = "ref"
 
 getSchemaCatalogs = _makeGetSchemaCatalogs("ref")
 
 RunnerClass = MergeSourcesRunner
 

Detailed Description

Merge measurements from multiple bands.

Contents

Description

Command-line task that merges measurements from multiple bands.

Combines consistent (i.e. with the same peaks and footprints) catalogs of sources from multiple filter bands to construct a unified catalog that is suitable for driving forced photometry. Every source is required to have centroid, shape and flux measurements in each band.

Inputs:
deepCoadd_meas{tract,patch,filter}: SourceCatalog
Outputs:
deepCoadd_ref{tract,patch}: SourceCatalog
Data Unit:
tract, patch

MergeMeasurementsTask subclasses MergeSourcesTask.

Task initialization

Initialize the task. Additional keyword arguments (forwarded to MergeSourcesTask.__init__):

Parameters
[in]schemathe schema of the detection catalogs used as input to this one
[in]butlera butler used to read the input schema from disk, if schema is None

The task will set its own self.schema attribute to the schema of the output merged catalog.

Invoking the Task

Merge coadd sources from multiple bands. Calls mergeCatalogs which must be defined in subclasses that inherit from MergeSourcesTask.

Parameters
[in]patchRefListlist of data references for each filter

Configuration parameters

See MergeMeasurementsConfig_

Debug variables

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

MergeMeasurementsTask has no debug variables.

A complete example of using MergeMeasurementsTask

MergeMeasurementsTask is meant to be run after deblending & measuring sources in every band. The purpose of the task is to generate a catalog of sources suitable for driving forced photometry in coadds and individual exposures. Command-line usage of MergeMeasurementsTask expects a data reference to the coadds to be processed. A list of the available optional arguments can be obtained by calling mergeCoaddMeasurements.py with the --help command line argument:

mergeCoaddMeasurements.py --help

To demonstrate usage of the DetectCoaddSourcesTask in the larger context of multi-band processing, we will process HSC data in the ci_hsc package. Assuming one has finished step 7 at High-level Overview of Multi-Band Coadd Processing, one may merge the catalogs generated after deblending and measuring as follows:

mergeCoaddMeasurements.py $CI_HSC_DIR/DATA --id patch=5,4 tract=0 filter=HSC-I^HSC-R

This will merge the HSC-I & HSC-R band catalogs. The results are written in $CI_HSC_DIR/DATA/deepCoadd-results/.

Definition at line 1220 of file multiBand.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.multiBand.MergeMeasurementsTask.__init__ (   self,
  butler = None,
  schema = None,
  kwargs 
)

Initialize the task.

Additional keyword arguments (forwarded to MergeSourcesTask.__init__):

Parameters
[in]schemathe schema of the detection catalogs used as input to this one
[in]butlera butler used to read the input schema from disk, if schema is None

The task will set its own self.schema attribute to the schema of the output merged catalog.

Definition at line 1300 of file multiBand.py.

Member Function Documentation

◆ getInputSchema()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.getInputSchema (   self,
  butler = None,
  schema = None 
)
inherited

Obtain the input schema either directly or froma butler reference.

Parameters
[in]butlerbutler reference to obtain the input schema from
[in]schemathe input schema

Definition at line 432 of file multiBand.py.

◆ mergeCatalogs()

def lsst.pipe.tasks.multiBand.MergeMeasurementsTask.mergeCatalogs (   self,
  catalogs,
  patchRef 
)

Merge measurement catalogs to create a single reference catalog for forced photometry.

Parameters
[in]catalogsthe catalogs to be merged
[in]patchRefpatch reference for data

For parent sources, we choose the first band in config.priorityList for which the merge_footprint flag for that band is is True.

For child sources, the logic is the same, except that we use the merge_peak flags.

Definition at line 1345 of file multiBand.py.

◆ readCatalog()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.readCatalog (   self,
  patchRef 
)
inherited

Read input catalog.

We read the input dataset provided by the 'inputDataset' class variable.

Parameters
[in]patchRefdata reference for patch
Returns
tuple consisting of the filter name and the catalog

Definition at line 469 of file multiBand.py.

◆ run()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.run (   self,
  patchRefList 
)
inherited

Merge coadd sources from multiple bands.

Calls mergeCatalogs which must be defined in subclasses that inherit from MergeSourcesTask.

Parameters
[in]patchRefListlist of data references for each filter

Definition at line 458 of file multiBand.py.

◆ write()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.write (   self,
  patchRef,
  catalog 
)
inherited

Write the output.

Parameters
[in]patchRefdata reference for patch
[in]catalogcatalog

We write as the dataset provided by the 'outputDataset' class variable.

Definition at line 495 of file multiBand.py.

◆ writeMetadata()

def lsst.pipe.tasks.multiBand.MergeSourcesTask.writeMetadata (   self,
  dataRefList 
)
inherited

No metadata to write, and not sure how to write it for a list of dataRefs.

Definition at line 512 of file multiBand.py.

Member Data Documentation

◆ badFlags

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.badFlags

Definition at line 1338 of file multiBand.py.

◆ ConfigClass

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.ConfigClass = MergeMeasurementsConfig
static

Definition at line 1295 of file multiBand.py.

◆ flagKeys

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.flagKeys

Definition at line 1318 of file multiBand.py.

◆ fluxErrKey

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxErrKey

Definition at line 1315 of file multiBand.py.

◆ fluxFlagKey

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxFlagKey

Definition at line 1316 of file multiBand.py.

◆ fluxKey

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxKey

Definition at line 1314 of file multiBand.py.

◆ getSchemaCatalogs

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.getSchemaCatalogs = _makeGetSchemaCatalogs("ref")
static

Definition at line 1298 of file multiBand.py.

◆ inputDataset

string lsst.pipe.tasks.multiBand.MergeMeasurementsTask.inputDataset = "meas"
static

Definition at line 1296 of file multiBand.py.

◆ outputDataset

string lsst.pipe.tasks.multiBand.MergeMeasurementsTask.outputDataset = "ref"
static

Definition at line 1297 of file multiBand.py.

◆ pseudoFilterKeys

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.pseudoFilterKeys

Definition at line 1331 of file multiBand.py.

◆ RunnerClass

lsst.pipe.tasks.multiBand.MergeSourcesTask.RunnerClass = MergeSourcesRunner
staticinherited

Definition at line 412 of file multiBand.py.

◆ schema

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.schema

Definition at line 1329 of file multiBand.py.

◆ schemaMapper

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.schemaMapper

Definition at line 1312 of file multiBand.py.


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