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¶
CatalogMeasurementBaseTask(config, *args, …) |
|
CatalogMeasurementBaseTaskConfig |
|
CatalogSummaryBaseTask(config, *args, **kwargs) |
|
CatalogSummaryBaseTaskConfig |
|
CatalogSummaryBaseTaskConnections(*, config) |
|
MatchedBaseTask(config, *args, **kwargs) |
|
MatchedBaseTaskConfig |
|
MatchedBaseTaskConnections(*[, config]) |
|
MatchedTractBaseTask(config, *args, **kwargs) |
|
NumSourcesMergeTask([config, name, …]) |
|
NumSourcesTask([config, name, parentTask, log]) |
|
NumpySummaryTask([config, name, parentTask, log]) |
|
NumpySummaryTaskConfig |
lsst.faro.preparation Package¶
Classes¶
lsst.faro.measurement Package¶
Classes¶
AB1Task([config, name, parentTask, log]) |
|
AB1TaskConfig |
|
ADxTask([config, name, parentTask, log]) |
|
AFxTask([config, name, parentTask, log]) |
|
AMxTask([config, name, parentTask, log]) |
|
AMxTaskConfig |
|
DetectorMeasurementTask(config, *args, **kwargs) |
|
DetectorMeasurementTaskConfig |
|
HistMedianTask([config, name, parentTask, log]) |
|
ModelPhotRepTask(config, *args, **kwargs) |
A Task that computes a *ModelPhotRep 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. |
PA1TaskConfig |
Config fields for the PA1 photometric repeatability metric. |
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. |
PF1TaskConfig |
|
PatchMatchedMeasurementTask(config, *args, …) |
|
PatchMatchedMeasurementTaskConfig |
|
PatchMatchedMeasurementTaskConnections(*, config) |
|
PatchMatchedMultiBandMeasurementTask(config, …) |
|
PatchMatchedMultiBandMeasurementTaskConfig |
|
PatchMatchedMultiBandMeasurementTaskConnections(*, …) |
|
PatchMeasurementTask(config, *args, **kwargs) |
|
PatchMeasurementTaskConfig |
|
PatchMeasurementTaskConnections(*, config) |
|
StarFracTask([config, name, parentTask, log]) |
|
TExTask([config, name, parentTask, log]) |
|
TExTaskConfig |
|
TractMatchedMeasurementTask(config, *args, …) |
|
TractMatchedMeasurementTaskConfig |
|
TractMatchedMeasurementTaskConnections(*, config) |
|
TractMeasurementTask(config, *args, **kwargs) |
|
TractMeasurementTaskConfig |
|
TractMeasurementTaskConnections(*, config) |
|
TractMultiBandMeasurementTask(config, *args, …) |
|
TractMultiBandMeasurementTaskConfig |
|
TractMultiBandMeasurementTaskConnections(*, …) |
|
VisitMeasurementTask(config, *args, **kwargs) |
|
VisitMeasurementTaskConfig |
|
WPerpTask([config, name, parentTask, log]) |
|
WPerpTaskConfig |
lsst.faro.summary Package¶
Classes¶
PatchMatchedSummaryTask(config, *args, **kwargs) |
|
PatchMatchedSummaryTaskConfig |
|
PatchMatchedSummaryTaskConnections(*, config) |
|
PatchSummaryTask(config, *args, **kwargs) |
|
PatchSummaryTaskConfig |
|
PatchSummaryTaskConnections(*, config) |
|
TractMatchedSummaryTask(config, *args, **kwargs) |
|
TractMatchedSummaryTaskConfig |
|
TractMatchedSummaryTaskConnections(*, config) |
|
VisitSummaryTask(config, *args, **kwargs) |
|
VisitSummaryTaskConfig |
|
VisitSummaryTaskConnections(*, config) |