StellarLocusFitAction

class lsst.analysis.tools.actions.keyedData.StellarLocusFitAction(*args, **kw)

Bases: KeyedDataAction

Determine Stellar Locus fit parameters from given input Vectors.

Attributes Summary

stellarLocusFitDict

The parameters to use for the stellar locus fit.

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.
getOutputSchema()	Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.

Attributes Documentation

stellarLocusFitDict

The parameters to use for the stellar locus fit. For xMin/Max, yMin/Max, and m/bFixed, the default parameters are examples and are not generally useful for any of the fits, so should be updated in the PlotAction definition in the atools directory. The dict needs to contain xMin/xMax/yMin/yMax which are the limits of the initial point selection box for fitting the stellar locus, mFixed and bFixed are meant to represent the intercept and gradient of a canonical fit for a given dataset (and should be derived from data). They are used here as an initial guess for the fitting. nSigmaToClip1/2 set the number of sigma to clip perpendicular the fit in the first and second fit iterations after the initial guess and point selection fit. minObjectForFit sets a minimum number of points deemed suitable for inclusion in the fit in order to bother attempting the fit. (Dict, default {'xMin': 0.1, 'xMax': 0.2, 'yMin': 0.1, 'yMax': 0.2, 'mHW': 0.5, 'bHW': 0.0, 'nSigmaToClip1': 3.5, 'nSigmaToClip2': 5.0, 'minObjectForFit': 3})

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor], **kwargs) → MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor]

Call self as a function.

getInputSchema() → Tensor]]]

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.

getOutputSchema() → Tensor]]]

Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.

Returns:

resultKeyedDataSchema or None

The schema this action will produce when returning from call. This will be unformatted if any templates are present. Should return None if action does not return KeyedData.