MetricConfig

class lsst.verify.tasks.MetricConfig(*args, **kw)

Bases: PipelineTaskConfig

Attributes Summary

connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
metricName	The metric calculated by a MetricTask with this config (lsst.verify.Name, read-only).
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

metricName

The metric calculated by a MetricTask with this config (lsst.verify.Name, read-only).

saveLogOutput

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

Methods Documentation

validate()

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.