Help on class BaseMetric in module lsst.sims.maf.metrics.baseMetric:
class BaseMetric(__builtin__.object)
| Base class for the metrics.
|
| Methods defined here:
|
| __init__(self, col=None, metricName=None, maps=None, units=None, metricDtype=None, badval=-666)
| Instantiate metric.
|
| 'col' is a kwarg for purposes of the MAF driver; when actually using a metric, it must be set to
| the names of the data columns that the metric will operate on. This can be a single string or a list.
|
| 'maps' is a list of any maps that the metric will need, accessed via slicePoint that is passed from the slicer.
|
| After inheriting from this base metric :
| * every metric object will have metricDtype (the type of data it calculates) set according to:
| -- kwarg (metricDtype='float', 'int', etc)
| -- 'float' (assumes float if not specified in kwarg)
| -- 'object' (if reduce functions are present and value not set in kwarg)
| * every metric object will have the data columns it requires added to the column registry
| (so the driver can know which columns to pull from the database)
|
| run(self, dataSlice, slicePoint=None)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __metaclass__ = <class 'lsst.sims.maf.metrics.baseMetric.MetricRegistr...
| Meta class for metrics, to build a registry of metric classes.
|
| colInfo = <lsst.sims.maf.utils.getColInfo.ColInfo object>
|
| colRegistry = <lsst.sims.maf.metrics.baseMetric.ColRegistry object>
|
| registry = {'AveSlewFracMetric': <class 'lsst.sims.maf.metrics.slewMet...