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)	Performs count actions, with threshold-based filtering.
CountUniqueAction(*args, **kw)	Counts the number of unique rows in a given column.
DivideScalar(*args, **kw)	Calculate (A/B) for scalars.
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 above or below a threshold.
IqrHistAction(*args, **kw)	Calculates the interquartile range of the given histogram data.
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.
MedianHistAction(*args, **kw)	Calculates the median of the given histogram data.
MinAction(*args, **kw)	Returns the minimum of the given data.
RmsAction(*args, **kw)	Calculates the root mean square of the given data (without subtracting the mean as in StdevAction).
SigmaMadAction(*args, **kw)	Calculates the sigma mad of the given data.
StdevAction(*args, **kw)	Calculates the standard deviation of the given data.
SumAction(*args, **kw)	Returns the sum of all values in the column.
ValueAction(*args, **kw)	Extracts the first value from a vector.

Class Inheritance Diagram

Vector Actions

lsst.analysis.tools.actions.vector Package

Classes

AddVector(*args, **kw)	Calculate (A+B).
AngularSeparation(*args, **kw)	Calculate the angular separation between two coordinate positions.
BandSelector(*args, **kw)	Makes a mask for sources observed in a specified set of bands.
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.
CalcMomentSize(*args, **kw)	Calculate a size based on 2D moments.
CalcRhoStatistics(*args, **kw)	Calculate rho statistics.
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.
ColorDiff(*args, **kw)	Calculate the difference between two colors from flux actions.
ColorError(*args, **kw)	Calculate the error in a color from two different flux error columns.
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.
CosVector(*args, **kw)	Calculate cos(A)
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.
FiniteSelector(*args, **kw)	Return a mask of finite values for a vector key
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.
InjectedClassSelector(*args, **kw)	A selector for injected objects of a given class.
InjectedGalaxySelector(*args, **kw)	A selector for injected stars of a given class.
InjectedObjectSelector(*args, **kw)	A selector for injected objects.
InjectedStarSelector(*args, **kw)	A selector for injected stars of a given class.
IsMatchedObjectSameClass(*args, **kw)	Action to return whether matched objects are the same class.
LoadVector(*args, **kw)	Load and return a Vector from KeyedData.
Log10Vector(*args, **kw)	Calculate log10(A)
MagDiff(*args, **kw)	Calculate the difference between two magnitudes; each magnitude is derived from a flux column.
MagSelector(*args, **kw)	Selects points that have minMag < mag (AB) < maxMag.
MatchedObjectSelector(*args, **kw)	A selector that selects matched objects with finite distances.
MatchingFlagSelector(*args, **kw)	The default flag selector to apply pre matching.
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.
RaiseFromBaseVector(*args, **kw)	Calculate n**A
RaiseToPowerVector(*args, **kw)	Calculate A**n
RangeSelector(*args, **kw)	Selects rows within a range, inclusive of min/exclusive of max.
ReferenceGalaxySelector(*args, **kw)	A selector that selects galaxies from a catalog with a boolean column identifying unresolved sources.
ReferenceObjectSelector(*args, **kw)	A selector that selects all objects from a catalog with a boolean column identifying unresolved sources.
ReferenceStarSelector(*args, **kw)	A selector that selects stars from a catalog with a boolean column identifying unresolved sources.
ResidualWithPerGroupStatistic(*args, **kw)	Compute residual between individual elements of group and the per-group statistic.
SelectorBase(*args, **kw)
SinVector(*args, **kw)	Calculate sin(A)
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.
SqrtVector(*args, **kw)	Calculate sqrt(A)
SquareVector(*args, **kw)	Calculate A**2
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.
TreecorrConfig(*args, **kwargs)	Deprecated since version v28.0.
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

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.
CalcBinnedCompletenessAction(*args, **kw)	Calculate completeness and purity in a single magnitude bin.
CalcCompletenessHistogramAction(*args, **kw)	Action to calculate a histogram of completeness vs magnitude.
CalcRelativeDistances(*args, **kw)	Calculate relative distances in a matched catalog.
ChainedKeyedDataActions(*args, **kw)	Run a series of KeyedDataActions and accumulated their output into one KeyedData result.
KeyedDataKeyAccessAction(*args, **kw)	Fetches the value for a given top-level key in a KeyedData.
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.
MagnitudeCompletenessConfig(*args, **kw)	Configuration for measuring magnitudes at given completeness thresholds.
StellarLocusFitAction(*args, **kw)	Determine Stellar Locus fit parameters from given input Vectors.

Class Inheritance Diagram