lsst.pipe.tasks  13.0-29-g7046ce1+1
 All Classes Namespaces Files Functions Variables Groups Pages
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__
 Initialize the task. More...
 
def mergeCatalogs
 Merge measurement catalogs to create a single reference catalog for forced photometry. More...
 
- Public Member Functions inherited from lsst.pipe.tasks.multiBand.MergeSourcesTask
def getInputSchema
 Obtain the input schema either directly or froma butler reference. More...
 
def __init__
 Initialize the task. More...
 
def run
 Merge coadd sources from multiple bands. More...
 
def readCatalog
 Read input catalog. More...
 
def mergeCatalogs
 Merge multiple catalogs. More...
 
def write
 Write the output. More...
 
def writeMetadata
 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"
 
tuple getSchemaCatalogs = _makeGetSchemaCatalogs("ref")
 
- Static Public Attributes inherited from lsst.pipe.tasks.multiBand.MergeSourcesTask
 ConfigClass = MergeSourcesConfig
 
 RunnerClass = MergeSourcesRunner
 
 inputDataset = None
 
 outputDataset = None
 
 getSchemaCatalogs = None
 

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]schema,:the schema of the detection catalogs used as input to this one
[in]butler,:a 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:

1 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:

1 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 1211 of file multiBand.py.

Constructor & Destructor Documentation

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]schema,:the schema of the detection catalogs used as input to this one
[in]butler,:a 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 1291 of file multiBand.py.

Member Function Documentation

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

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

Parameters
[in]catalogs,:the catalogs to be merged
[in]patchRef,:patch 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 1336 of file multiBand.py.

Member Data Documentation

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.badFlags

Definition at line 1329 of file multiBand.py.

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

Definition at line 1286 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.flagKeys

Definition at line 1309 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxErrKey

Definition at line 1306 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxFlagKey

Definition at line 1307 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.fluxKey

Definition at line 1305 of file multiBand.py.

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

Definition at line 1289 of file multiBand.py.

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

Definition at line 1287 of file multiBand.py.

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

Definition at line 1288 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.pseudoFilterKeys

Definition at line 1322 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.schema

Definition at line 1320 of file multiBand.py.

lsst.pipe.tasks.multiBand.MergeMeasurementsTask.schemaMapper

Definition at line 1303 of file multiBand.py.


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