lsst.pipe.tasks  21.0.0-58-g436064c8+549a115573
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.postprocess.TransformObjectCatalogTask Class Reference
Inheritance diagram for lsst.pipe.tasks.postprocess.TransformObjectCatalogTask:
lsst.pipe.tasks.postprocess.TransformCatalogBaseTask

Public Member Functions

def run (self, parq, funcs=None, dataId=None, band=None)
 
def outputDataset (self)
 
def inputDataset (self)
 
def ConfigClass (self)
 
def runQuantum (self, butlerQC, inputRefs, outputRefs)
 
def runDataRef (self, dataRef)
 
def getFunctors (self)
 
def getAnalysis (self, parq, funcs=None, band=None)
 
def transform (self, band, parq, funcs, dataId)
 
def write (self, df, parqRef)
 
def writeMetadata (self, dataRef)
 

Public Attributes

 funcs
 

Static Public Attributes

 ConfigClass = TransformObjectCatalogConfig
 
string inputDataset = 'deepCoadd_obj'
 
string outputDataset = 'objectTable'
 

Detailed Description

Produce a flattened Object Table to match the format specified in
sdm_schemas.

Do the same set of postprocessing calculations on all bands

This is identical to `TransformCatalogBaseTask`, except for that it does the
specified functor calculations for all filters present in the
input `deepCoadd_obj` table.  Any specific `"filt"` keywords specified
by the YAML file will be superceded.

Definition at line 692 of file postprocess.py.

Member Function Documentation

◆ ConfigClass()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.ConfigClass (   self)
inherited

Definition at line 563 of file postprocess.py.

◆ getAnalysis()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.getAnalysis (   self,
  parq,
  funcs = None,
  band = None 
)
inherited

Definition at line 626 of file postprocess.py.

◆ getFunctors()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.getFunctors (   self)
inherited

Definition at line 623 of file postprocess.py.

◆ inputDataset()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.inputDataset (   self)
inherited

Definition at line 559 of file postprocess.py.

◆ outputDataset()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.outputDataset (   self)
inherited

Definition at line 555 of file postprocess.py.

◆ run()

def lsst.pipe.tasks.postprocess.TransformObjectCatalogTask.run (   self,
  parq,
  funcs = None,
  dataId = None,
  band = None 
)
Do postprocessing calculations

Takes a `ParquetTable` object and dataId,
returns a dataframe with results of postprocessing calculations.

Parameters
----------
parq : `lsst.pipe.tasks.parquetTable.ParquetTable`
    ParquetTable from which calculations are done.
funcs : `lsst.pipe.tasks.functors.Functors`
    Functors to apply to the table's columns
dataId : dict, optional
    Used to add a `patchId` column to the output dataframe.
band : `str`, optional
    Filter band that is being processed.

Returns
------
    `pandas.DataFrame`

Reimplemented from lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.

Definition at line 717 of file postprocess.py.

◆ runDataRef()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.runDataRef (   self,
  dataRef 
)
inherited

Reimplemented in lsst.pipe.tasks.postprocess.TransformSourceTableTask.

Definition at line 586 of file postprocess.py.

◆ runQuantum()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.runQuantum (   self,
  butlerQC,
  inputRefs,
  outputRefs 
)
inherited

Definition at line 576 of file postprocess.py.

◆ transform()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.transform (   self,
  band,
  parq,
  funcs,
  dataId 
)
inherited

Definition at line 632 of file postprocess.py.

◆ write()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.write (   self,
  df,
  parqRef 
)
inherited

Definition at line 644 of file postprocess.py.

◆ writeMetadata()

def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.writeMetadata (   self,
  dataRef 
)
inherited
No metadata to write.

Definition at line 647 of file postprocess.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.postprocess.TransformObjectCatalogTask.ConfigClass = TransformObjectCatalogConfig
static

Definition at line 704 of file postprocess.py.

◆ funcs

lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.funcs
inherited

Definition at line 571 of file postprocess.py.

◆ inputDataset

string lsst.pipe.tasks.postprocess.TransformObjectCatalogTask.inputDataset = 'deepCoadd_obj'
static

Definition at line 706 of file postprocess.py.

◆ outputDataset

string lsst.pipe.tasks.postprocess.TransformObjectCatalogTask.outputDataset = 'objectTable'
static

Definition at line 707 of file postprocess.py.


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