lsst.faro

The lsst.faro module contains code for computing scientific performance metrics on the outputs of the LSST science pipelines. lsst.faro is a Gen3 middleware- and PipelineTask- based package for computing scientific performance metrics.

Contributing

lsst.faro is developed at https://github.com/lsst/faro. You can find Jira issues for this module under the faro component.

Python API reference

lsst.faro Package

lsst.faro.base Package

Classes

CatalogMeasurementBaseConfig Configuration for CatalogMeasurementBaseTask.
CatalogMeasurementBaseConnections(*[, config])
CatalogMeasurementBaseTask(config, *args, …) Base class for science performance metrics measured from source/object catalogs.
CatalogSummaryBaseConfig
CatalogSummaryBaseConnections(*, config)
CatalogSummaryBaseTask(config, *args, **kwargs)
MatchedBaseConfig
MatchedBaseConnections(*[, config])
MatchedBaseTask(config, *args, **kwargs)
MatchedTractBaseTask(config, *args, **kwargs)
NumSourcesMatchedTask([config, name, …]) Extension of NumSourcesTask to count sources in a matched catalog
NumSourcesMergeTask([config, name, …])
NumSourcesTask([config, name, parentTask, log]) Simple default task to count the number of sources/objects in catalog.
NumpySummaryConfig
NumpySummaryTask([config, name, parentTask, log])

lsst.faro.measurement Package

Classes

AB1Config
AB1Task([config, name, parentTask, log])
ADxTask([config, name, parentTask, log])
AFxTask([config, name, parentTask, log])
AMxConfig
AMxTask([config, name, parentTask, log])
DetectorMeasurementConfig
DetectorMeasurementTask(config, *args, **kwargs)
DetectorTableMeasurementConfig Configuration for DetectorTableMeasurementTask.
DetectorTableMeasurementTask(config, *args, …) Base class for science performance metrics measured on single-detector source catalogs.
ForcedSourceMultiBandTableMeasurementConfig Configuration for ForcedSourceMultiBandTableMeasurementTask.
ForcedSourceMultiBandTableMeasurementConnections(*)
ForcedSourceMultiBandTableMeasurementTask(…) Base class for multi-band science performance metrics measured on multi-visit forced source catalogs.
ForcedSourceTableMeasurementConfig Configuration for ForcedSourceTableMeasurementTask.
ForcedSourceTableMeasurementConnections(*[, …])
ForcedSourceTableMeasurementTask(config, …) Base class for per-band science performance metrics measured on multi-visit forced source catalogs.
HistMedianTask([config, name, parentTask, log])
ModelPhotRepTask(config, *args, **kwargs) A Task that computes a ModelPhotRep photometric repeatability metric
PA1Config Config fields for the PA1 photometric repeatability metric.
PA1Task(config, *args, **kwargs) A Task that computes the PA1 photometric repeatability metric from an input set of multiple visits of the same field.
PF1Config
PF1Task(config, *args, **kwargs) A Task that computes PF1, the percentage of photometric repeatability measurements that deviate by more than PA2 mmag from the mean.
PatchMatchedMeasurementConfig
PatchMatchedMeasurementConnections(*[, config])
PatchMatchedMeasurementTask(config, *args, …)
PatchMatchedMultiBandMeasurementConfig
PatchMatchedMultiBandMeasurementConnections(*)
PatchMatchedMultiBandMeasurementTask(config, …)
PatchMeasurementConfig
PatchMeasurementConnections(*[, config])
PatchMeasurementTask(config, *args, **kwargs)
PatchMultiBandTableMeasurementConfig Configuration for PatchMultiBandTableMeasurementTask.
PatchMultiBandTableMeasurementConnections(*)
PatchMultiBandTableMeasurementTask(config, …) Base class for science performance metrics measured on single-tract source catalogs, multi-band.
PatchTableMeasurementConfig Configuration for PatchTableMeasurementTask.
PatchTableMeasurementConnections(*[, config])
PatchTableMeasurementTask(config, *args, …) Base class for per-band science performance metrics measured on single-tract object catalogs.
StarFracTask([config, name, parentTask, log])
TExConfig
TExTableConfig Class to organize the yaml configuration parameters to be passed to TExTableTask when using a parquet table input.
TExTableTask([config, name, parentTask, log]) Class to perform the tex_table calculation on a parquet table data object.
TExTask([config, name, parentTask, log])
TractMatchedMeasurementConfig
TractMatchedMeasurementConnections(*[, config])
TractMatchedMeasurementTask(config, *args, …)
TractMeasurementConfig
TractMeasurementConnections(*[, config])
TractMeasurementTask(config, *args, **kwargs)
TractMultiBandMeasurementConfig
TractMultiBandMeasurementConnections(*[, config])
TractMultiBandMeasurementTask(config, *args, …)
TractMultiBandTableMeasurementConfig Configuration for TractMultiBandTableMeasurementTask.
TractMultiBandTableMeasurementConnections(*)
TractMultiBandTableMeasurementTask(config, …) Base class for science performance metrics measured on single-tract object catalogs, multi-band.
TractTableMeasurementConfig Configuration for TractTableMeasurementTask.
TractTableMeasurementConnections(*[, config])
TractTableMeasurementTask(config, *args, …) Base class for per-band science performance metrics measured on single-tract object catalogs.
VisitMeasurementConfig
VisitMeasurementTask(config, *args, **kwargs)
VisitTableMeasurementConfig Configuration for VisitTableMeasurementTask.
VisitTableMeasurementTask(config, *args, …) Base class for science performance metrics measured on single-visit source catalogs.
WPerpConfig
WPerpTask([config, name, parentTask, log])

lsst.faro.summary Package

lsst.faro.utils Module