DM-16536: Migrate all metrics from ap.verify.measurements

COPYRIGHT

@@ -1 +1 @@
-Copyright 2017-2018 University of Washington
+Copyright 2017-2019 University of Washington

doc/lsst.ap.association/index.rst

@@ -28,6 +28,20 @@ You can find Jira issues for this module under the `ap_association <https://jira
 
 .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
 
+.. _lsst.ap.association-command-line-taskref:
+
+Task reference
+==============
+
+.. _lsst.ap.association-tasks:
+
+Tasks
+-----
+
+.. lsst-tasks::
+   :root: lsst.ap.association
+   :toctree: tasks
+
 .. _lsst.ap.association-pyapi:
 
 Python API reference
@@ -36,3 +50,7 @@ Python API reference
 .. automodapi:: lsst.ap.association
    :no-main-docstr:
    :no-inheritance-diagram:
+
+.. automodapi:: lsst.ap.association.metrics
+   :no-main-docstr:
+   :no-inheritance-diagram:

doc/lsst.ap.association/tasks/lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask.rst

@@ -0,0 +1,50 @@
+.. lsst-task-topic:: lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask
+
+###################################
+FractionUpdatedDiaObjectsMetricTask
+###################################
+
+``FractionUpdatedDiaObjectsMetricTask`` computes the fraction of DIAObjects that were updated when processing data through source association (as the ``ap_association.fracUpdatedDiaObjects`` metric).
+It requires task metadata as input.
+While the task can operate at image-level or coarser granularity, the current algorithm may double-count objects and should not be run on multiple visits.
+
+.. _lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask-summary:
+
+Processing summary
+==================
+
+``FractionUpdatedDiaObjectsMetricTask`` reads ``AssociationTask`` statistics from task metadata associated with one or more processed images.
+It uses these statistics to compute the fraction of potentially updatable DIAObjects that were updated with new sources when processing those images.
+
+.. _lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask-butler:
+
+Butler datasets
+===============
+
+Input datasets
+--------------
+
+:lsst-config-field:`~lsst.verify.tasks.metadataMetricTask.MetadataMetricConfig.metadata`
+    The metadata of the top-level command-line task (e.g., ``ProcessCcdTask``, ``ApPipeTask``) being instrumented.
+    Because the metadata produced by each top-level task is a different Butler dataset type, this dataset **must** be explicitly configured when running ``FractionUpdatedDiaObjectsMetricTask`` or a :lsst-task:`~lsst.verify.gen2tasks.MetricsControllerTask` that contains it.
+
+.. _lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask

doc/lsst.ap.association/tasks/lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask.rst

@@ -0,0 +1,49 @@
+.. lsst-task-topic:: lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask
+
+#############################
+NumberNewDiaObjectsMetricTask
+#############################
+
+``NumberNewDiaObjectsMetricTask`` computes the number of DIAObjects created when processing data through source association (as the ``ap_association.numNewDiaObjects`` metric).
+It requires task metadata as input, and can operate at image-level or coarser granularity.
+
+.. _lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask-summary:
+
+Processing summary
+==================
+
+``NumberNewDiaObjectsMetricTask`` reads ``AssociationTask`` statistics from task metadata associated with one or more processed images.
+It uses these statistics to count the number of new DIAObjects added when processing those images.
+
+.. _lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask-butler:
+
+Butler datasets
+===============
+
+Input datasets
+--------------
+
+:lsst-config-field:`~lsst.verify.tasks.metadataMetricTask.MetadataMetricConfig.metadata`
+    The metadata of the top-level command-line task (e.g., ``ProcessCcdTask``, ``ApPipeTask``) being instrumented.
+    Because the metadata produced by each top-level task is a different Butler dataset type, this dataset **must** be explicitly configured when running ``NumberNewDiaObjectsMetricTask`` or a :lsst-task:`~lsst.verify.gen2tasks.MetricsControllerTask` that contains it.
+
+.. _lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.ap.association.metrics.NumberNewDiaObjectsMetricTask

doc/lsst.ap.association/tasks/lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask.rst

@@ -0,0 +1,50 @@
+.. lsst-task-topic:: lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask
+
+######################################
+NumberUnassociatedDiaObjectsMetricTask
+######################################
+
+``NumberUnassociatedDiaObjectsMetricTask`` computes the number of DIAObjects that are *not* updated when processing data through source association (as the ``ap_association.numUnassociatedDiaObjects`` metric).
+It requires task metadata as input.
+While the task can operate at image-level or coarser granularity, the current algorithm may double-count objects and should not be run on multiple visits.
+
+.. _lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask-summary:
+
+Processing summary
+==================
+
+``NumberUnassociatedDiaObjectsMetricTask`` reads ``AssociationTask`` statistics from task metadata associated with one or more processed images.
+It uses these statistics to count the number of unassociated DIAObjects when processing those images.
+
+.. _lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask-butler:
+
+Butler datasets
+===============
+
+Input datasets
+--------------
+
+:lsst-config-field:`~lsst.verify.tasks.metadataMetricTask.MetadataMetricConfig.metadata`
+    The metadata of the top-level command-line task (e.g., ``ProcessCcdTask``, ``ApPipeTask``) being instrumented.
+    Because the metadata produced by each top-level task is a different Butler dataset type, this dataset **must** be explicitly configured when running ``NumberUnassociatedDiaObjectsMetricTask`` or a :lsst-task:`~lsst.verify.gen2tasks.MetricsControllerTask` that contains it.
+
+.. _lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.ap.association.metrics.NumberUnassociatedDiaObjectsMetricTask

doc/lsst.ap.association/tasks/lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask.rst

@@ -0,0 +1,49 @@
+.. lsst-task-topic:: lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask
+
+#####################################
+TotalUnassociatedDiaObjectsMetricTask
+#####################################
+
+``TotalUnassociatedDiaObjectsMetricTask`` computes the number of DIAObjects that have only a single source (as the ``ap_association.totalUnassociatedDiaObjects`` metric).
+It requires a prompt products database as input, and is meaningful only at dataset-level granularity.
+
+.. _lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask-summary:
+
+Processing summary
+==================
+
+``TotalUnassociatedDiaObjectsMetricTask`` queries the database (through `~lsst.dax.ppdb.Ppdb`) for the number of DIAObjects with exactly one source.
+
+.. _lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask-api:
+
+Python API summary
+==================
+
+.. lsst-task-api-summary:: lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask-butler:
+
+Butler datasets
+===============
+
+Input datasets
+--------------
+
+:lsst-config-field:`~lsst.verify.tasks.ppdbMetricTask.PpdbMetricConfig.dbInfo`
+    The Butler dataset from which the database connection can be initialized.
+    The type must match the input required by the :lsst-config-field:`~lsst.verify.tasks.ppdbMetricTask.PpdbMetricConfig.dbLoader` subtask (default: the top-level science task's config).
+    If the input is a config, its name **must** be explicitly configured when running ``TotalUnassociatedDiaObjectsMetricTask`` or a :lsst-task:`~lsst.verify.gen2tasks.MetricsControllerTask` that contains it.
+
+.. _lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask-subtasks:
+
+Retargetable subtasks
+=====================
+
+.. lsst-task-config-subtasks:: lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask
+
+.. _lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask-configs:
+
+Configuration fields
+====================
+
+.. lsst-task-config-fields:: lsst.ap.association.metrics.TotalUnassociatedDiaObjectsMetricTask