lsst.faro.measurement¶
Contributing¶
lsst.faro.measurement is developed at https://github.com/lsst/faro.
You can find Jira issues for this module under the faro component.
Pipeline tasks¶
- PatchMatchedMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- PatchMatchedMultiBandMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- PatchMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- TractMatchedMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- TractMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- TractMultiBandMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
- VisitMeasurementTask
- Base class for science performance metrics measured from source/object catalogs.
Tasks¶
- AB1Task
- Base class for data processing tasks.
- ADxTask
- Base class for data processing tasks.
- AFxTask
- Base class for data processing tasks.
- AMxTask
- Base class for data processing tasks.
- HistMedianTask
- Base class for data processing tasks.
- PA1Task
- A Task that computes the PA1 photometric repeatability metric from an input set of multiple visits of the same field.
- PF1Task
- A Task that computes PF1, the percentage of photometric repeatability measurements that deviate by more than PA2 mmag from the mean.
- StarFracTask
- Base class for data processing tasks.
- WPerpTask
- Base class for data processing tasks.
Configurations¶
- AB1Config
- Base class for configuration (config) objects.
- AMxConfig
- Base class for configuration (config) objects.
- PA1Config
- Config fields for the PA1 photometric repeatability metric.
- PatchMatchedMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- PatchMatchedMultiBandMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- PatchMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- TractMatchedMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- TractMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- TractMultiBandMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- VisitMeasurementConfig
- Configuration for CatalogMeasurementBaseTask.
- WPerpConfig
- Base class for configuration (config) objects.
Python API reference¶
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. |
FluxStatisticConfig |
Class to configure the flux statistic measurement task. |
FluxStatisticTask(config, name, parentTask, …) |
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 |
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, …) |
|
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-patch source catalogs, multi-band. |
PatchTableMeasurementConfig |
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 |
|
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, …) |
|
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 |
|
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. |
TractTableValueMeasurementConfig |
Configuration for TractTableValueMeasurementTask. |
TractTableValueMeasurementConnections(*, config) |
|
TractTableValueMeasurementTask(**kwargs) |
Measure a metric from a single row and combination of columns in a table. |
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, …) |