HistStatsPanel

class lsst.analysis.tools.actions.plot.HistStatsPanel(*args, **kw)

Bases: Config

A Config class that holds parameters to configure a the stats panel shown for histPlot.

The fields in this class correspond to the parameters that can be used to customize the HistPlot stats panel.

• The ListField parameter a dict to specify names of 3 stat columns accepts latex formating

• The other parameters (stat1, stat2, stat3) are lists of strings that specify vector keys correspoinding to scalar values computed in the prep/process/produce steps of an analysis tools plot/metric configurable action. There should be one key for each group in the HistPanel.

A separate config class is used instead of constructing DictField’s in HistPanel for each parameter for clarity and consistency.

Notes

This is intended to be used as a configuration of the HistPlot/HistPanel class.

If no HistStatsPanel is specified then the default behavor persists where the stats panel shows N / median / sigma_mad for each group in the panel.

Attributes Summary

stat1	A list specifying the vector keys of the first scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)
stat2	A list specifying the vector keys of the second scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)
stat3	A list specifying the vector keys of the third scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)
statsLabels	list specifying the labels for stats (List, default ('N$_{{data}}$', 'Med', '${{\\sigma}}_{{MAD}}$'))

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

stat1

A list specifying the vector keys of the first scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)

stat2

A list specifying the vector keys of the second scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)

stat3

A list specifying the vector keys of the third scalar statistic to be shown in this panel.there should be one entry for each hist in the panel (List, default None)

statsLabels

list specifying the labels for stats (List, default ('N$_{{data}}$', 'Med', '${{\\sigma}}_{{MAD}}$'))

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.