MetadataAnalysisConfig

class lsst.analysis.tools.tasks.MetadataAnalysisConfig(*args, **kw)

Bases: AnalysisBaseConfig

Attributes Summary

addOutputNamePrefix	If True, the connections class output name will be prefixed to the analysis 'atools' name when the value is dispatched to sasquatch.
atools	The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)
bands	Filter bands on which to run all of the actions (List, default ['u', 'g', 'r', 'i', 'z', 'y'])
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
dataset_identifier	An identifier to be associated with output Metrics (str, default None)
inputDimensions	The dimensions of the input dataset.
metric_tags	List of tags which will be added to all configurable actions (List, default [])
metrics	The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)
plots	The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)
raiseNoWorkFoundOnEmptyMetadata	Raise a NoWorkFound error if none of the configured metrics are in the task metadata.
raiseNoWorkFoundOnIncompleteMetadata	Raise NoWorkFound if any of the configured metrics are not in the task metadata.
reference_package	A package who's version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (str, default 'lsst_distrib')
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
timestamp_version	Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (str, default 'run_timestamp')

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

addOutputNamePrefix

If True, the connections class output name will be prefixed to the analysis ‘atools’ name when the value is dispatched to sasquatch. (bool, default False)

atools

The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

bands

Filter bands on which to run all of the actions (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

connections: pexConfig.ConfigField

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

dataset_identifier

An identifier to be associated with output Metrics (str, default None)

inputDimensions

The dimensions of the input dataset. (List, default [])

metric_tags

List of tags which will be added to all configurable actions (List, default [])

metrics

The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

plots

The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

raiseNoWorkFoundOnEmptyMetadata

Raise a NoWorkFound error if none of the configured metrics are in the task metadata. (bool, default False)

raiseNoWorkFoundOnIncompleteMetadata

Raise NoWorkFound if any of the configured metrics are not in the task metadata. (bool, default False)

reference_package

A package who’s version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (str, default 'lsst_distrib')

saveLogOutput

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

timestamp_version

Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (str, default 'run_timestamp')

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.