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.

Using faro

• Getting started
• Running faro
• Adding a metric to faro

Design and Development

• Design goals
• Design concepts
• Organization of the faro package
• References and prior art

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(*args, **kw)	Configuration for CatalogMeasurementBaseTask.
CatalogMeasurementBaseConnections(*[, config])
CatalogMeasurementBaseTask(config, *args, ...)	Base class for science performance metrics measured from source/object catalogs.
CatalogSummaryBaseConfig(*args, **kw)
CatalogSummaryBaseConnections(*[, config])
CatalogSummaryBaseTask(config, *args, **kwargs)
MatchedBaseConfig(*args, **kw)
MatchedBaseConnections(*[, config])
MatchedBaseTask(config, *args, **kwargs)
MatchedTractBaseTask(config, *args, **kwargs)
NumSourcesConfig(*args, **kw)
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(*args, **kw)
NumpySummaryTask([config, name, parentTask, log])

lsst.faro.preparation Package

Classes

PatchMatchedMultiBandPreparationConfig(...)
PatchMatchedMultiBandPreparationConnections(*)
PatchMatchedMultiBandPreparationTask(config, ...)
PatchMatchedPreparationConfig(*args, **kw)
PatchMatchedPreparationConnections(*[, config])
PatchMatchedPreparationTask(config, *args, ...)
TractMatchedPreparationConfig(*args, **kw)
TractMatchedPreparationConnections(*[, config])
TractMatchedPreparationTask(config, *args, ...)

lsst.faro.measurement Package

Classes

AB1Config(*args, **kw)
AB1Task([config, name, parentTask, log])
ADxTask([config, name, parentTask, log])
AFxTask([config, name, parentTask, log])
AMxConfig(*args, **kw)
AMxTask([config, name, parentTask, log])
DetectorMeasurementConfig(*args, **kw)
DetectorMeasurementTask(config, *args, **kwargs)
DetectorTableMeasurementConfig(*args, **kw)	Configuration for DetectorTableMeasurementTask.
DetectorTableMeasurementTask(config, *args, ...)	Base class for science performance metrics measured on single-detector source catalogs.
FluxStatisticConfig(*args, **kw)	Class to configure the flux statistic measurement task.
FluxStatisticTask([config, name, ...])	Class to perform flux statistic calculations on parquet table data.
ForcedSourceMultiBandTableMeasurementConfig(...)	Configuration for ForcedSourceMultiBandTableMeasurementTask.
ForcedSourceMultiBandTableMeasurementConnections(*)
ForcedSourceMultiBandTableMeasurementTask(...)	Base class for multi-band science performance metrics measured on multi-visit forced source catalogs.
ForcedSourceTableMeasurementConfig(*args, **kw)	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(*args, **kw)	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(*args, **kw)
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(*args, **kw)
PatchMatchedMeasurementConnections(*[, config])
PatchMatchedMeasurementTask(config, *args, ...)
PatchMatchedMultiBandMeasurementConfig(...)
PatchMatchedMultiBandMeasurementConnections(*)
PatchMatchedMultiBandMeasurementTask(config, ...)
PatchMeasurementConfig(*args, **kw)
PatchMeasurementConnections(*[, config])
PatchMeasurementTask(config, *args, **kwargs)
PatchMultiBandTableMeasurementConfig(*args, **kw)	Configuration for PatchMultiBandTableMeasurementTask.
PatchMultiBandTableMeasurementConnections(*)
PatchMultiBandTableMeasurementTask(config, ...)	Base class for science performance metrics measured on single-patch source catalogs, multi-band.
PatchTableMeasurementConfig(*args, **kw)	Configuration for PatchTableMeasurementTask.
PatchTableMeasurementConnections(*[, config])
PatchTableMeasurementTask(config, *args, ...)	Base class for per-band science performance metrics measured on single-patch object catalogs.
StarFracTask([config, name, parentTask, log])
TExConfig(*args, **kw)
TExTableConfig(*args, **kw)	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])
TractMatchedCatalogMultiBandTableMeasurementConfig(...)	Configuration for TractMatchedCatalogMultiBandTableMeasurementTask.
TractMatchedCatalogMultiBandTableMeasurementConnections(*)
TractMatchedCatalogMultiBandTableMeasurementTask(...)	Base class for science performance metrics measured on single-tract object catalogs, multi-band.
TractMatchedCatalogTableMeasurementConfig(...)	Configuration for TractMatchedCatalogTableMeasurementTask.
TractMatchedCatalogTableMeasurementConnections(*)
TractMatchedCatalogTableMeasurementTask(...)	Base class for per-band science performance metrics measured on single-tract matched catalogs.
TractMatchedMeasurementConfig(*args, **kw)
TractMatchedMeasurementConnections(*[, config])
TractMatchedMeasurementTask(config, *args, ...)
TractMeasurementConfig(*args, **kw)
TractMeasurementConnections(*[, config])
TractMeasurementTask(config, *args, **kwargs)
TractMultiBandMeasurementConfig(*args, **kw)
TractMultiBandMeasurementConnections(*[, config])
TractMultiBandMeasurementTask(config, *args, ...)
TractMultiBandTableMeasurementConfig(*args, **kw)	Configuration for TractMultiBandTableMeasurementTask.
TractMultiBandTableMeasurementConnections(*)
TractMultiBandTableMeasurementTask(config, ...)	Base class for science performance metrics measured on single-tract object catalogs, multi-band.
TractTableMeasurementConfig(*args, **kw)	Configuration for TractTableMeasurementTask.
TractTableMeasurementConnections(*[, config])
TractTableMeasurementTask(config, *args, ...)	Base class for per-band science performance metrics measured on single-tract object catalogs.
TractTableValueMeasurementConfig(*args, **kw)	Configuration for TractTableValueMeasurementTask.
TractTableValueMeasurementConnections(*[, ...])
TractTableValueMeasurementTask(**kwargs)	Measure a metric from a single row and combination of columns in a table.
VisitMeasurementConfig(*args, **kw)
VisitMeasurementTask(config, *args, **kwargs)
VisitTableMeasurementConfig(*args, **kw)	Configuration for VisitTableMeasurementTask.
VisitTableMeasurementTask(config, *args, ...)	Base class for science performance metrics measured on single-visit source catalogs.
WPerpConfig(*args, **kw)
WPerpTask([config, name, parentTask, log])

lsst.faro.summary Package

Classes

PatchMatchedSummaryConfig(*args, **kw)
PatchMatchedSummaryConnections(*[, config])
PatchMatchedSummaryTask(config, *args, **kwargs)
PatchSummaryConfig(*args, **kw)
PatchSummaryConnections(*[, config])
PatchSummaryTask(config, *args, **kwargs)
TractMatchedSummaryConfig(*args, **kw)
TractMatchedSummaryConnections(*[, config])
TractMatchedSummaryTask(config, *args, **kwargs)
VisitSummaryConfig(*args, **kw)
VisitSummaryConnections(*[, config])
VisitSummaryTask(config, *args, **kwargs)

lsst.faro.utils Module