CatalogMeasurementBaseTask

Python API summary

from lsst.faro.base.CatalogMeasurementBase import CatalogMeasurementBaseTask

classCatalogMeasurementBaseTask(config, *args, **kwargs)

Base class for science performance metrics measured from source/object catalogs...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(**kwargs)

Run the MetricTask on in-memory data...

See also

See the CatalogMeasurementBaseTask API reference for complete details.

Retargetable subtasks

measure

Default

lsst.faro.base.BaseSubTasks.NumSourcesTask

Field type

ConfigurableField

Measure task

referenceCatalogLoader

Default

lsst.pipe.tasks.loadReferenceCatalog.LoadReferenceCatalogTask

Field type

ConfigurableField

Reference catalog loader

Configuration fields

connections

Data type

lsst.pipe.base.config.CatalogMeasurementBaseConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

requireAstrometry

Default

True

Field type

bool Field

Require that a given catalog have a valid WCS in order to be included in metric measurements?

requirePhotometry

Default

True

Field type

bool Field

Require that a given catalog have a valid photoCalib in order to be included in metric measurements?

saveLogOutput

Default

True

Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default

True

Field type

bool Field

Flag to enable/disable metadata saving for a task, enabled by default.