lsst.pipe.tasks  21.0.0-51-gd3b42663+3149e5afc4
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.postprocess.WriteObjectTableTask Class Reference
Inheritance diagram for lsst.pipe.tasks.postprocess.WriteObjectTableTask:

Public Member Functions

def __init__ (self, butler=None, schema=None, **kwargs)
 
def runDataRef (self, patchRefList)
 Merge coadd sources from multiple bands. More...
 
def readCatalog (self, patchRef)
 
def run (self, catalogs, tract, patch)
 
def write (self, patchRef, catalog)
 
def writeMetadata (self, dataRefList)
 

Static Public Attributes

 ConfigClass = WriteObjectTableConfig
 
 RunnerClass = MergeSourcesRunner
 
tuple inputDatasets = ('forced_src', 'meas', 'ref')
 
string outputDataset = 'obj'
 

Detailed Description

Write filter-merged source tables to parquet

Definition at line 71 of file postprocess.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.__init__ (   self,
  butler = None,
  schema = None,
**  kwargs 
)

Definition at line 84 of file postprocess.py.

Member Function Documentation

◆ readCatalog()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.readCatalog (   self,
  patchRef 
)
Read input catalogs

Read all the input datasets given by the 'inputDatasets'
attribute.

Parameters
----------
patchRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference for patch

Returns
-------
Tuple consisting of band name and a dict of catalogs, keyed by
dataset name

Definition at line 114 of file postprocess.py.

◆ run()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.run (   self,
  catalogs,
  tract,
  patch 
)
Merge multiple catalogs.

Parameters
----------
catalogs : `dict`
    Mapping from filter names to dict of catalogs.
tract : int
    tractId to use for the tractId column
patch : str
    patchId to use for the patchId column

Returns
-------
catalog : `lsst.pipe.tasks.parquetTable.ParquetTable`
    Merged dataframe, with each column prefixed by
    `filter_tag(filt)`, wrapped in the parquet writer shim class.

Definition at line 139 of file postprocess.py.

◆ runDataRef()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.runDataRef (   self,
  patchRefList 
)

Merge coadd sources from multiple bands.

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

Parameters
[in]patchRefListlist of data references for each filter

Definition at line 90 of file postprocess.py.

◆ write()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.write (   self,
  patchRef,
  catalog 
)
Write the output.

Parameters
----------
catalog : `ParquetTable`
    Catalog to write
patchRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference for patch

Definition at line 177 of file postprocess.py.

◆ writeMetadata()

def lsst.pipe.tasks.postprocess.WriteObjectTableTask.writeMetadata (   self,
  dataRefList 
)
No metadata to write, and not sure how to write it for a list of dataRefs.

Definition at line 194 of file postprocess.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.postprocess.WriteObjectTableTask.ConfigClass = WriteObjectTableConfig
static

Definition at line 75 of file postprocess.py.

◆ inputDatasets

tuple lsst.pipe.tasks.postprocess.WriteObjectTableTask.inputDatasets = ('forced_src', 'meas', 'ref')
static

Definition at line 79 of file postprocess.py.

◆ outputDataset

string lsst.pipe.tasks.postprocess.WriteObjectTableTask.outputDataset = 'obj'
static

Definition at line 82 of file postprocess.py.

◆ RunnerClass

lsst.pipe.tasks.postprocess.WriteObjectTableTask.RunnerClass = MergeSourcesRunner
static

Definition at line 76 of file postprocess.py.


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