Action Types

Here is a list of the current actions implemented in analysis_tools. Please look at these carefully before adding new actions to avoid duplication.

Plot actions are covered in a separate section.

Scalar Actions

lsst.analysis.tools.actions.scalar Package

Classes

ApproxFloor(*args, **kw)

Returns the median of the lowest ten values of the sorted input.

CountAction(*args, **kw)

Returns the number of non-NaN entries in the given column.

CountUniqueAction(*args, **kw)

Counts the number of unique rows in a given column.

FracInRange(*args, **kw)

Compute the fraction of a distribution that is between specified minimum and maximum values, and is not NaN.

FracNan(*args, **kw)

Compute the fraction of vector entries that are NaN.

FracThreshold(*args, **kw)

Compute the fraction of a distribution that is above or below a specified threshold.

MaxAction(*args, **kw)

Returns the maximum of the given data.

MeanAction(*args, **kw)

Calculates the mean of the given data.

MedianAction(*args, **kw)

Calculates the median of the given data.

MinAction(*args, **kw)

Returns the minimum of the given data.

SigmaMadAction(*args, **kw)

Calculates the sigma mad of the given data.

StdevAction(*args, **kw)

Calculates the standard deviation of the given data.

Class Inheritance Diagram

Inheritance diagram of lsst.analysis.tools.actions.scalar.scalarActions.ApproxFloor, lsst.analysis.tools.actions.scalar.scalarActions.CountAction, lsst.analysis.tools.actions.scalar.scalarActions.CountUniqueAction, lsst.analysis.tools.actions.scalar.scalarActions.FracInRange, lsst.analysis.tools.actions.scalar.scalarActions.FracNan, lsst.analysis.tools.actions.scalar.scalarActions.FracThreshold, lsst.analysis.tools.actions.scalar.scalarActions.MaxAction, lsst.analysis.tools.actions.scalar.scalarActions.MeanAction, lsst.analysis.tools.actions.scalar.scalarActions.MedianAction, lsst.analysis.tools.actions.scalar.scalarActions.MinAction, lsst.analysis.tools.actions.scalar.scalarActions.SigmaMadAction, lsst.analysis.tools.actions.scalar.scalarActions.StdevAction

Vector Actions

lsst.analysis.tools.actions.vector Package

Classes

AddVector(*args, **kw)

Calculate (A+B).

BandSelector(*args, **kw)

Makes a mask for sources observed in a specified set of bands.

BinnedCorr2Config(*args, **kw)

A Config class that holds some of the parameters supported by treecorr.

CalcBinnedStatsAction(*args, **kw)

CalcE(*args, **kw)

Calculate a complex value representation of the ellipticity.

CalcE1(*args, **kw)

Calculate \(e_1\) (distortion-type) or \(g_1\) (shear-type).

CalcE2(*args, **kw)

Calculate \(e_2\) (distortion-type) or \(g_2\) (shear-type).

CalcEDiff(*args, **kw)

Calculate the difference of two ellipticities as a complex quantity.

CalcRhoStatistics(*args, **kw)

Calculate rho statistics.

CalcShapeSize(*args, **kw)

Calculate a size: \((I_{xx}I_{yy}-I_{xy}^2)^{\frac{1}{4}}\) (determinant radius) or \(\sqrt{(I_{xx}+I_{yy})/2}\) (trace radius).

CalcSn(*args, **kw)

Calculate the signal-to-noise ratio from a single flux vector.

CoaddPlotFlagSelector(*args, **kw)

This default setting makes it take the band from the kwargs.

ConstantValue(*args, **kw)

Return a constant scalar value.

ConvertFluxToMag(*args, **kw)

Turn nano janskies into magnitudes.

ConvertUnits(*args, **kw)

Convert the units of a vector.

DivideVector(*args, **kw)

Calculate (A/B)

DownselectVector(*args, **kw)

Get a vector from KeyedData, apply specified selector, return the shorter Vector.

ExtendednessSelector(*args, **kw)

A selector that picks between extended and point sources.

ExtinctionCorrectedMagDiff(*args, **kw)

Compute the difference between two magnitudes and correct for extinction By default bands are derived from the <band>_ prefix on flux columns, per the naming convention in the Object Table: e.g.

FlagSelector(*args, **kw)

The base flag selector to use to select valid sources for QA.

FractionalDifference(*args, **kw)

Calculate (A-B)/B.

GalaxySelector(*args, **kw)

A selector that picks out galaxies based off of their extendedness values.

GoodDiaSourceSelector(*args, **kw)

Selects good DIA sources from diaSourceTables.

LoadVector(*args, **kw)

Load and return a Vector from KeyedData.

MagDiff(*args, **kw)

Calculate the difference between two magnitudes; each magnitude is derived from a flux column.

MultiCriteriaDownselectVector(*args, **kw)

Get a vector from KeyedData, apply specified set of selectors with AND logic, and return the shorter Vector.

MultiplyVector(*args, **kw)

Calculate (A*B)

PerGroupStatistic(*args, **kw)

Compute per-group statistic values and return result as a vector with one element per group.

RAcosDec(*args, **kw)

Construct a vector of RA*cos(Dec) in order to have commensurate values between RA and Dec.

RangeSelector(*args, **kw)

Selects rows within a range, inclusive of min/exclusive of max.

ResidualWithPerGroupStatistic(*args, **kw)

Compute residual between individual elements of group and the per-group statistic.

SkyObjectSelector(*args, **kw)

Selects sky objects in the given band(s).

SkySourceSelector(*args, **kw)

Selects sky sources from sourceTables.

SnSelector(*args, **kw)

Selects points that have S/N > threshold in the given flux type.

StarSelector(*args, **kw)

A selector that picks out stars based off of their extendedness values.

SubtractVector(*args, **kw)

Calculate (A-B).

ThresholdSelector(*args, **kw)

Return a mask corresponding to an applied threshold.

UnknownSelector(*args, **kw)

A selector that picks out unclassified objects based off of their extendedness values.

VectorSelector(*args, **kw)

Load a boolean vector from KeyedData and return it for use as a selector.

VisitPlotFlagSelector(*args, **kw)

Select on a set of flags appropriate for making visit-level plots (i.e., using sourceTable_visit catalogs).

Class Inheritance Diagram

Inheritance diagram of lsst.analysis.tools.actions.vector.mathActions.AddVector, lsst.analysis.tools.actions.vector.selectors.BandSelector, lsst.analysis.tools.actions.vector.calcRhoStatistics.BinnedCorr2Config, lsst.analysis.tools.actions.vector.calcBinnedStats.CalcBinnedStatsAction, lsst.analysis.tools.actions.vector.ellipticity.CalcE, lsst.analysis.tools.actions.vector.ellipticity.CalcE1, lsst.analysis.tools.actions.vector.ellipticity.CalcE2, lsst.analysis.tools.actions.vector.ellipticity.CalcEDiff, lsst.analysis.tools.actions.vector.calcRhoStatistics.CalcRhoStatistics, lsst.analysis.tools.actions.vector.calcShapeSize.CalcShapeSize, lsst.analysis.tools.actions.vector.vectorActions.CalcSn, lsst.analysis.tools.actions.vector.selectors.CoaddPlotFlagSelector, lsst.analysis.tools.actions.vector.mathActions.ConstantValue, lsst.analysis.tools.actions.vector.vectorActions.ConvertFluxToMag, lsst.analysis.tools.actions.vector.vectorActions.ConvertUnits, lsst.analysis.tools.actions.vector.mathActions.DivideVector, lsst.analysis.tools.actions.vector.vectorActions.DownselectVector, lsst.analysis.tools.actions.vector.selectors.ExtendednessSelector, lsst.analysis.tools.actions.vector.vectorActions.ExtinctionCorrectedMagDiff, lsst.analysis.tools.actions.vector.selectors.FlagSelector, lsst.analysis.tools.actions.vector.mathActions.FractionalDifference, lsst.analysis.tools.actions.vector.selectors.GalaxySelector, lsst.analysis.tools.actions.vector.selectors.GoodDiaSourceSelector, lsst.analysis.tools.actions.vector.vectorActions.LoadVector, lsst.analysis.tools.actions.vector.vectorActions.MagDiff, lsst.analysis.tools.actions.vector.vectorActions.MultiCriteriaDownselectVector, lsst.analysis.tools.actions.vector.mathActions.MultiplyVector, lsst.analysis.tools.actions.vector.vectorActions.PerGroupStatistic, lsst.analysis.tools.actions.vector.vectorActions.RAcosDec, lsst.analysis.tools.actions.vector.selectors.RangeSelector, lsst.analysis.tools.actions.vector.vectorActions.ResidualWithPerGroupStatistic, lsst.analysis.tools.actions.vector.selectors.SkyObjectSelector, lsst.analysis.tools.actions.vector.selectors.SkySourceSelector, lsst.analysis.tools.actions.vector.selectors.SnSelector, lsst.analysis.tools.actions.vector.selectors.StarSelector, lsst.analysis.tools.actions.vector.mathActions.SubtractVector, lsst.analysis.tools.actions.vector.selectors.ThresholdSelector, lsst.analysis.tools.actions.vector.selectors.UnknownSelector, lsst.analysis.tools.actions.vector.selectors.VectorSelector, lsst.analysis.tools.actions.vector.selectors.VisitPlotFlagSelector

KeyedData Actions

lsst.analysis.tools.actions.keyedData Package

Classes

AddComputedVector(*args, **kw)

Compute a Vector from the specified VectorAction and add it to a copy of the KeyedData, returning the result.

ChainedKeyedDataActions(*args, **kw)

Run a series of KeyedDataActions and accumulated their output into one KeyedData result.

KeyedDataSelectorAction(*args, **kw)

Extract Vector specified by vectorKeys from input KeyedData and optionally apply selectors to down select extracted vectors.

KeyedScalars(*args, **kw)

Creates an output of type KeyedData, where the keys are given by the identifiers in scalarActions and the values are the results of the corresponding ScalarAction.

StellarLocusFitAction(*args, **kw)

Determine Stellar Locus fit parameters from given input Vectors.

Class Inheritance Diagram

Inheritance diagram of lsst.analysis.tools.actions.keyedData.keyedDataActions.AddComputedVector, lsst.analysis.tools.actions.keyedData.keyedDataActions.ChainedKeyedDataActions, lsst.analysis.tools.actions.keyedData.keyedDataActions.KeyedDataSelectorAction, lsst.analysis.tools.actions.keyedData.keyedDataActions.KeyedScalars, lsst.analysis.tools.actions.keyedData.stellarLocusFit.StellarLocusFitAction