NumSourcesTask¶
Python API summary¶
from lsst.faro.base.BaseSubTasks import NumSourcesTask
-
class
NumSourcesTask
(config=None, *, name=None, parentTask=None, log=None) Simple default task to count the number of sources/objects in catalog
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run
(metricName, catalog, **kwargs) Run NumSourcesTask Parameters ———- metricName : `str` The name of the metric to measure. catalog : `dict` `lsst.afw.table` Catalog type kwargs Extra keyword arguments used to construct the task. Returns ——- measurement : `Struct` The measured value of the metric
...
See also
See the NumSourcesTask
API reference for complete details.
Retargetable subtasks¶
No subtasks.
Configuration fields¶
columns¶
- Columns required for metric calculation. Should be all columns in SourceTable contexts,
and columns that do not change name with band in ObjectTable contexts
columnsBand¶
Columns required for metric calculation that change with band in ObjectTable contexts
doPrimary¶
Only count sources where detect_isPrimary is True.
shelveName¶
- 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.