lsst.pipe.tasks
21.0.0-122-gbd923b4f+6d4c9210e2
|
Public Member Functions | |
def | outputDataset (self) |
def | inputDataset (self) |
def | ConfigClass (self) |
def | __init__ (self, *args, **kwargs) |
def | runQuantum (self, butlerQC, inputRefs, outputRefs) |
def | runDataRef (self, dataRef) |
def | run (self, parq, funcs=None, dataId=None, band=None) |
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 | |
Base class for transforming/standardizing a catalog by applying functors that convert units and apply calibrations. The purpose of this task is to perform a set of computations on an input `ParquetTable` dataset (such as `deepCoadd_obj`) and write the results to a new dataset (which needs to be declared in an `outputDataset` attribute). The calculations to be performed are defined in a YAML file that specifies a set of functors to be computed, provided as a `--functorFile` config parameter. An example of such a YAML file is the following: funcs: psfMag: functor: Mag args: - base_PsfFlux filt: HSC-G dataset: meas cmodel_magDiff: functor: MagDiff args: - modelfit_CModel - base_PsfFlux filt: HSC-G gauss_magDiff: functor: MagDiff args: - base_GaussianFlux - base_PsfFlux filt: HSC-G count: functor: Column args: - base_InputCount_value filt: HSC-G deconvolved_moments: functor: DeconvolvedMoments filt: HSC-G dataset: forced_src refFlags: - calib_psfUsed - merge_measurement_i - merge_measurement_r - merge_measurement_z - merge_measurement_y - merge_measurement_g - base_PixelFlags_flag_inexact_psfCenter - detect_isPrimary The names for each entry under "func" will become the names of columns in the output dataset. All the functors referenced are defined in `lsst.pipe.tasks.functors`. Positional arguments to be passed to each functor are in the `args` list, and any additional entries for each column other than "functor" or "args" (e.g., `'filt'`, `'dataset'`) are treated as keyword arguments to be passed to the functor initialization. The "refFlags" entry is shortcut for a bunch of `Column` functors with the original column and taken from the `'ref'` dataset. The "flags" entry will be expanded out per band. This task uses the `lsst.pipe.tasks.postprocess.PostprocessAnalysis` object to organize and excecute the calculations.
Definition at line 542 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.__init__ | ( | self, | |
* | args, | ||
** | kwargs | ||
) |
Definition at line 625 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.ConfigClass | ( | self | ) |
Definition at line 622 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.getAnalysis | ( | self, | |
parq, | |||
funcs = None , |
|||
band = None |
|||
) |
Definition at line 685 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.getFunctors | ( | self | ) |
Definition at line 682 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.inputDataset | ( | self | ) |
Definition at line 618 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.outputDataset | ( | self | ) |
Definition at line 614 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.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`
Definition at line 654 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.runDataRef | ( | self, | |
dataRef | |||
) |
Definition at line 645 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.runQuantum | ( | self, | |
butlerQC, | |||
inputRefs, | |||
outputRefs | |||
) |
Definition at line 635 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.transform | ( | self, | |
band, | |||
parq, | |||
funcs, | |||
dataId | |||
) |
Definition at line 691 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.write | ( | self, | |
df, | |||
parqRef | |||
) |
Definition at line 703 of file postprocess.py.
def lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.writeMetadata | ( | self, | |
dataRef | |||
) |
No metadata to write.
Definition at line 706 of file postprocess.py.
lsst.pipe.tasks.postprocess.TransformCatalogBaseTask.funcs |
Definition at line 630 of file postprocess.py.