XYPlot

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

Bases: PlotAction

Make a plot (with errorbars) of one quantity (X) vs another (Y).

Attributes Summary

boolKwargs

Keyword arguments to ax.errorbar that take boolean values (Dict, default {})

numKwargs

Keyword arguments to ax.errorbar that take numerical (float or int) values (Dict, default {})

strKwargs

Keyword arguments to ax.errorbar that take string values (Dict, default {})

xAxisLabel

The label to use for the x-axis.

xLinThresh

The value around zero where the scale becomes linear in x-axis when symlog is set as the scale.

xLine

The value of x where a vertical line is drawn.

xScale

The scale to use for the x-axis.

yAxisLabel

The label to use for the y-axis.

yLinThresh

The value around zero where the scale becomes linear in y-axis when symlog is set as the scale.

yLine

The value of y where a horizontal line is drawn.

yScale

The scale to use for the y-axis.

Methods Summary

__call__(data, **kwargs)

Call self as a function.

getInputSchema()

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

makePlot(data[, plotInfo])

Make the plot.

setDefaults()

Subclass hook for computing defaults.

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

boolKwargs

Keyword arguments to ax.errorbar that take boolean values (Dict, default {})

numKwargs

Keyword arguments to ax.errorbar that take numerical (float or int) values (Dict, default {})

strKwargs

Keyword arguments to ax.errorbar that take string values (Dict, default {})

xAxisLabel

The label to use for the x-axis. (str, default 'x')

xLinThresh

The value around zero where the scale becomes linear in x-axis when symlog is set as the scale. Sets the linthresh parameter of set_xscale. (float, default 1e-06)

xLine

The value of x where a vertical line is drawn. (float, default None)

xScale

The scale to use for the x-axis. (str, default 'linear')

Allowed values:

'linear'

linear

'log'

log

'symlog'

symlog

'None'

Field is optional

yAxisLabel

The label to use for the y-axis. (str, default 'y')

yLinThresh

The value around zero where the scale becomes linear in y-axis when symlog is set as the scale. Sets the linthresh parameter of set_yscale. (float, default 1e-06)

yLine

The value of y where a horizontal line is drawn. (float, default None)

yScale

The scale to use for the y-axis. (str, default 'linear')

Allowed values:

'linear'

linear

'log'

log

'symlog'

symlog

'None'

Field is optional

Methods Documentation

__call__(data: KeyedData, **kwargs) Figure

Call self as a function.

getInputSchema() KeyedDataSchema

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Returns:
resultKeyedDataSchema

The schema this action requires to be present when calling this action, keys are unformatted.

makePlot(data: KeyedData, plotInfo: Mapping[str, str] | None = None, **kwargs: Any) Figure

Make the plot.

Parameters:
dataDataFrame

The catalog containing various rho statistics.

**kwargs

Additional keyword arguments to pass to the plot

Returns:
figFigure

The resulting figure.

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

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.