lsst.faro¶
The lsst.faro module contains code for computing scientific performance metrics on the outputs of the LSST science pipelines.
Prior to the development of the Gen3 middleware, the Gen2-based lsst.validate.drp package computed scientific performance metrics.
lsst.faro is the new Gen3 middleware- and PipelineTask- based package for computing scientific performance metrics.
The algorithms implemented in validate_drp were ported as-is to run in lsst.faro.
validate_drp is now deprecated; all future development of metrics will be carried out in lsst.faro.
Design and Development¶
Using faro¶
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) |
|
NumSourcesMergeTask([config, name, …]) |
|
NumSourcesTask([config, name, parentTask, log]) |
Simple default task count the number of sources/objects in catalog. |
NumpySummaryConfig |
|
NumpySummaryTask([config, name, parentTask, log]) |
lsst.faro.preparation Package¶
Classes¶
PatchMatchedMultiBandPreparationConfig |
|
PatchMatchedMultiBandPreparationConnections(*) |
|
PatchMatchedMultiBandPreparationTask(config, …) |
|
PatchMatchedPreparationConfig |
|
PatchMatchedPreparationConnections(*[, config]) |
|
PatchMatchedPreparationTask(config, *args, …) |
|
TractMatchedPreparationConfig |
|
TractMatchedPreparationConnections(*[, config]) |
|
TractMatchedPreparationTask(config, *args, …) |
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. |
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) |
|
StarFracTask([config, name, parentTask, log]) |
|
TExConfig |
|
TExTask([config, name, parentTask, log]) |
|
TractMatchedMeasurementConfig |
|
TractMatchedMeasurementConnections(*[, config]) |
|
TractMatchedMeasurementTask(config, *args, …) |
|
TractMeasurementConfig |
|
TractMeasurementConnections(*[, config]) |
|
TractMeasurementTask(config, *args, **kwargs) |
|
TractMultiBandMeasurementConfig |
|
TractMultiBandMeasurementConnections(*[, config]) |
|
TractMultiBandMeasurementTask(config, *args, …) |
|
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¶
Classes¶
PatchMatchedSummaryConfig |
|
PatchMatchedSummaryConnections(*, config) |
|
PatchMatchedSummaryTask(config, *args, **kwargs) |
|
PatchSummaryConfig |
|
PatchSummaryConnections(*, config) |
|
PatchSummaryTask(config, *args, **kwargs) |
|
TractMatchedSummaryConfig |
|
TractMatchedSummaryConnections(*, config) |
|
TractMatchedSummaryTask(config, *args, **kwargs) |
|
VisitSummaryConfig |
|
VisitSummaryConnections(*, config) |
|
VisitSummaryTask(config, *args, **kwargs) |