NumpySummaryTask

Python API summary

from lsst.faro.base.BaseSubTasks import NumpySummaryTask

classNumpySummaryTask(config: Optional[Config] = None, name: Optional[str] = None, parentTask: Optional[Task] = None, log: Optional[Union[logging.Logger, lsst.utils.logging.LsstLogAdapter]] = None)

Base class for data processing tasks...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(measurements, agg_name, package, metric)

Undocumented...

See also

See the NumpySummaryTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

columns

Default

{}

Field type

DictField

Key type

str

Value type

str

Columns required for metric calculation. These are full column names, encompassing all columns

in a SourceTable and columns that do not change name with band in an ObjectTable. If per-band columns are required, use columnsBand instead.

columnsBand

Default

{}

Field type

DictField

Key type

str

Value type

str

Column suffixes used to identify the required columns for metric calculation. The band name

will be prepended to this stub to select the columns of interest. These values are used to select flux columns in an objectTable.

shelveName

Default

''

Field type

str Field

Name of shelve file to persist in-memory objects sent as input to the metric

measurement run method. Used for testing, development, and debug work.

summary

Default

'median'

Field type

str Field

Aggregation to use for summary metrics