rubin_sim MAF: Available metrics¶
Core LSST MAF metrics¶
AbsMaxMetric
Calculate the max of the absolute value of a simData column slice.
AbsMaxPercentMetric
Return the percent of data which matches the absolute value of the
AbsMeanMetric
Calculate the mean of the absolute value of a simData column slice.
AbsMedianMetric
Calculate the median of the absolute value of a simData column slice.
AccumulateCountMetric
Calculate the accumulated stat
AccumulateM5Metric
Calculate the accumulated stat
AccumulateMetric
Calculate the accumulated stat
AccumulateUniformityMetric
Make a 2D version of UniformityMetric
ActivityOverPeriodMetric
Count fraction of object period we could identify activity
ActivityOverTimeMetric
Count fraction of survey we could identify activity for an SSobject.
AgnTimeLagMetric
Base class for the metrics.
AngularSpreadMetric
Compute the angular spread statistic which measures
AreaSummaryMetric
Find the min/max of a value over the area with the ‘best’ results
AreaThresholdMetric
Find the amount of area on the sky that meets a given threshold value.
BDParallaxMetric
Calculate the distance to which one could reach a parallax SNR for a
BaseMetric
Base class for the metrics.
BaseMoMetric
Base class for the moving object metrics.
BinaryMetric
Return 1 if there is data,
badval
otherwise.
BruteOSFMetric
Assume I can’t trust the slewtime or visittime colums.
CampaignLengthMetric
Calculate the number of seasons (roughly, years) a pointing is observed.
CheckColorSlope
Check if the data has a color and a slope
ChipVendorMetric
See what happens if we have chips from different vendors
CoaddM5PerNightMetric
Histogram the coadded depth of visits in each night.
Coaddm5Metric
Calculate the coadded m5 value.
ColRegistry
ColRegistry tracks the columns needed for all metric objects
ColorAsteroidMetric
Calculate the likelihood of being able to calculate the color of an
ColorSlope2NightMetric
Like ColorSlopeMetric, but span over 2 nights
ColorSlopeMetric
How many times do we get a color and slope in a night
CountBeyondThreshold
Count the number of entries in a data column above or below
CountExplimMetric
Count the number of x second visits.
CountMetric
Count the length of a simData column slice.
CountRatioMetric
Count the length of a column slice, then divide by
norm_val
.
CountSubsetMetric
Count the length of a column slice which matches
subset
.
CountUniqueMetric
Return the number of unique values.
CrowdingM5Metric
Calculate the magnitude at which the photometric error exceeds
CrowdingMagUncertMetric
Calculate the mean uncertainty in magnitude due to crowding.
CumulativeMetric
For plotting up the cumulative number of observations.
DcrPrecisionMetric
Determine how precise a DCR correction could be made
DiscoveryDistanceMetric
Returns the distance of the first discovery track of an SSobject.
DiscoveryEclonlatMetric
Returns the ecliptic lon/lat and solar elong of the first discovery
DiscoveryMetric
Identify the discovery opportunities for an SSobject.
DiscoveryNChancesMetric
Calculate total number of discovery opportunities for an SSobject.
DiscoveryNObsMetric
Calculates the number of observations in the first discovery
DiscoveryRadecMetric
Returns the RA/Dec of the first discovery track of an SSobject.
DiscoveryTimeMetric
Returns the time of the first discovery track of an SSobject.
DiscoveryVelocityMetric
Returns the sky velocity of the first discovery track of an SSobject.
ExgalM5
Calculate co-added five-sigma limiting depth after dust extinction.
ExgalM5WithCuts
Calculate co-added five-sigma limiting depth, but apply dust extinction and depth cuts.
FOArea
Given an n_visit threshold, how much AREA receives at least that many
FONv
Given asky area, what is the minimum and median NVISITS obtained over
FftMetric
Calculate a truncated FFT of the exposure times.
FootprintFractionMetric
Calculate fraction of a desired footprint got covered.
FracAboveMetric
Find the fraction of data values above a given
cutoff
.
FracBelowMetric
Find the fraction of data values below a given
cutoff
.
FullRangeAngleMetric
Calculate the full range of an angular (degrees) column slice.
FullRangeMetric
Calculate the range of a simData column slice.
GalPlaneFootprintMetric
Evaluate the survey overlap with desired regions in the
GalPlaneSeasonGapsTimescaleMetric
Evaluate the gap between sequential seasonal gaps in
GalPlaneTimePerFilterMetric
Evaluate the fraction of exposure time spent in each filter as a
GalPlaneVisitIntervalsTimescaleMetric
Evaluate the intervals between sequential observations in a
GapsMetric
Compute the number of times a gaps of a specified timescale
GeneralUniformityMetric
Calculate how uniformly any values are distributed.
HighVelocityMetric
Count number of times an SSobject appears trailed.
HighVelocityNightsMetric
Count the number of discovery opportunities (via trailing) for an
HistogramM5Metric
Calculate the coadded depth for each bin (e.g., per night).
HistogramMetric
A wrapper to stats.binned_statistic
HourglassMetric
Plot the filters used as a function of time.
IdentityMetric
Return the metric value.
InstantaneousColorMetric
Identify SSobjects which could have observations suitable to
InterNightGapsMetric
Calculate the (reduce_func) of the gap between consecutive
IntraNightGapsMetric
Calculate the (reduce_func) of the gap between consecutive
KnownObjectsMetric
Identify SSobjects which could be classified as ‘previously known’
KuiperMetric
Find the Kuiper V statistic for a distribution, useful for angles.
LightcurveColorOuterMetric
Calculate the liklihood of being able to calculate a color and
LightcurveInversionAsteroidMetric
Evaluate the liklihood that the detections could be used to enable
MagicDiscoveryMetric
Count the number of nights with discovery opportunities
MaxGapMetric
Find the maximum gap (in days) in between successive observations.
MaxMetric
Calculate the maximum of a simData column slice.
MaxPercentMetric
Return the percent of data which matches the maximum value
MaxStateChangesWithinMetric
Compute the maximum number of changes of state that occur
MeanAngleMetric
Calculate the mean of an angular (degree) column slice.
MeanCampaignFrequencyMetric
Calculate the mean separation between nights, within a season -
MeanMetric
Calculate the mean of a simData column slice.
MeanValueAtHMetric
Return the mean value of a metric at a given H.
MedianMetric
Calculate the median of a simData column slice.
MetricRegistry
Meta class for metrics, to build a registry of metric classes.
MinMetric
Calculate the minimum of a simData column slice.
MinTimeBetweenStatesMetric
Compute the minimum time between changes of state in a column value.
MoCompletenessAtTimeMetric
Calculate the completeness (relative to the entire population)
MoCompletenessMetric
Calculate the fraction of the population that meets
threshold
value
NChangesMetric
Compute the number of times a column value changes.
NNightsMetric
Count the number of distinct nights an SSobject is observed.
NObsMetric
Count the total number of observations where an SSobject was ‘visible’.
NObsNoSinglesMetric
Count the number of observations for an SSobject, without singles.
NRevisitsMetric
Calculate the number of consecutive visits with
NStateChangesFasterThanMetric
Compute the number of changes of state that happen faster than ‘cutoff’.
NVisitsPerNightMetric
Histogram the number of visits in each night.
NgalScaleMetric
Approximate number of galaxies, scaled by median seeing.
NightPointingMetric
Gather relevant information for a night to plot.
NightTimespanMetric
Calculate the maximum time span covered in each night,
NightgapsMetric
Histogram the number of nights between observations.
NlcPointsMetric
Number of points in stellar light curves
NormalizeMetric
Return a metric values divided by ‘norm_val’. Useful for turning summary statistics into fractions.
NoutliersNsigmaMetric
Calculate the # of visits less than n_sigma below the mean (n_sigma<0)
NstarsMetric
Calculate the number of stars detectable above some uncertainty
ObsArcMetric
Calculate the difference in time between the first and last observation
OpenShutterFractionMetric
Compute the fraction of time the shutter is open
OptimalM5Metric
Compare the co-added depth of the survey to one where
PairFractionMetric
What fraction of observations are part of a pair.
PairMetric
Count the number of pairs of visits that could be used for
ParallaxCoverageMetric
Check how well the parallax factor is distributed.
ParallaxDcrDegenMetric
Use the full parallax and DCR displacement vectors to find if they
ParallaxMetric
Calculate the uncertainty in a parallax measurement
PassMetric
Pass the entire dataslice array back to the MetricBundle.
PeakVMagMetric
Pull out the peak V magnitude of all observations of the SSobject.
PercentileMetric
Find the value of a column at a given
percentile
.
PeriodicDetectMetric
Determine if we would be able to classify an object as
PeriodicQualityMetric
Evaluate phase coverage over a given period.
PhaseGapMetric
Measure the maximum gap in phase coverage for
ProperMotionMetric
Calculate the uncertainty in the returned proper motion.
QSONumberCountsMetric
Calculate the number of quasars expected with SNR>=5
RIZDetectionCoaddExposureTime
A metric computing the total exposure time of an riz coadd.
RadiusObsMetric
Evaluate slice point radial position in the focal plane of each visit,
RapidRevisitMetric
Base class for the metrics.
RapidRevisitUniformityMetric
Calculate uniformity of time between consecutive visits on
RealMeanMetric
Calculate the mean of a column with no nans or infs.
RelRmsMetric
Calculate the relative scatter metric (RMS divided by median).
RmsAngleMetric
Calculate the standard deviation of an angular (degrees) column slice.
RmsMetric
Calculate the standard deviation of a simData column slice.
RobustRmsMetric
Use the inter-quartile range of the data to estimate the RMS.
SFUncertMetric
Structure Function (SF) Uncertainty Metric.
SNCadenceMetric
Metric to estimate the redshift limit for faint supernovae
SNNSNMetric
Measure zlim of type Ia supernovae.
SNSLMetric
Calculate the number of expected well-measured strongly lensed SN
SNSNRMetric
Metric to estimate the detection rate for faint supernovae
SeasonLengthMetric
Calculate the length of LSST seasons, in days.
SkySaturationMetric
Check if the sky would saturate a visit in an exposure
SnrWeightedMetric
Take the SNR weighted average of a column.
StarDensityMetric
Interpolate the stellar luminosity function to return the number of
StaticProbesFoMEmulatorMetricSimple
This calculates the Figure of Merit for the combined
StringCountMetric
Count up the number of times each string appears in a column.
SumMetric
Calculate the sum of a simData column slice.
SurfaceBrightLimitMetric
Gaussian limit, ignoring systematic errors in photometry
TdcMetric
Calculate the Time Delay Challenge metric,
TemplateExistsMetric
Calculate the fraction of images with a previous template
TemplateTime
Find the time at which we expect to hit incremental template
TgapsMetric
Histogram the times of the gaps between observations.
TgapsPercentMetric
Compute the fraction of the time gaps between observations that occur
TotalNumberSSO
Calculate the total number of objects of a given population
TotalPowerMetric
Calculate the total power in the angular power spectrum between lmin/lmax.
TransientMetric
Calculate what fraction of the transients would be detected. Best paired with a spatial slicer.
UniformityMetric
Calculate how uniformly the observations are spaced in time.
UniqueRatioMetric
Return the number of unique values divided by the
UseMetric
Metric to classify visits by type of visits
ValueAtHMetric
Return the metric value at a given H value.
VisitGapMetric
Calculate the (reduce_func) of the gap between any
VisitGroupsMetric
Count the number of visits per night within delta_t_min and delta_t_max.
VolumeSumMetric
Compute the total volume assuming a metric has values of distance.
WeakLensingNvisits
A proxy metric for WL systematics. Higher values indicate better systematics mitigation.
YearCoverageMetric
Count the number of
bins
covered by night_col.
ZeropointMetric
Return a metric values with the addition of ‘zp’. Useful for altering the zeropoint for summary statistics.
Contributed maf_contrib metrics¶
DepthLimitedNumGalMetric
This metric calculates the number of galaxies while accounting for the
FilterPairTGapsMetric
Figure of merit to measure the coverage the time gaps in same
GRBTransientMetric
Evaluate the likelihood of detecting a GRB optical counterpart.
GW170817DetMetric
Wrapper metric class for GW170817-like kilonovae based on the
GalaxyCountsMetric
Estimate the number of galaxies expected at a particular (extragalactic)
KNePopMetric
Base class for the metrics.
LVDwarfsMetric
Estimate the detection limit in total dwarf luminosity for
MicrolensingMetric
Quantifies detectability of Microlensing events.
NYoungStarsMetric
Calculate the distance or number of stars with
PeriodicMetric
From a set of observation times, uses code provided by Robert Siverd
PeriodicStarMetric
At each slice_point, run a Monte Carlo simulation to see how
PeriodicStarModulationMetric
Evaluate how well a periodic source can be fit on a short baseline,
PhotometricSelfCalUniformityMetric
Base class for the metrics.
PrestoColorKNePopMetric
Base class for the metrics.
StarCountMassMetric
Find the number of stars in a given field in the mass range
StarCountMetric
Find the number of stars in a given field between d1 and d2 in parsecs.
StaticProbesFoMEmulatorMetric
This calculates the Figure of Merit for the combined
TdePopMetric
Base class for the metrics.
TripletBandMetric
Find the number of ‘triplets’ of three images taken in the same band,
TripletMetric
Find the number of ‘triplets’ of three images taken in any band,
XRBPopMetric
Evaluate whether a given XRB would be detectable.