BaseMetric

class rubin_sim.maf.metrics.BaseMetric(col=None, metric_name=None, maps=None, units=None, metric_dtype=None, badval=-666, mask_val=None)

Bases: object

Base class for the metrics. Sets up some basic functionality for the MAF framework: after __init__ every metric will record the columns (and stackers) it requires into the column registry, and the metric_name, metric_dtype, and units for the metric will be set.

Parameters:

colstr or list [str]

Names of the data columns that the metric will use. The columns required for each metric is tracked in the ColRegistry, and used to retrieve data from the opsim database. Can be a single string or a list.

metric_namestr

Name to use for the metric (optional - if not set, will be derived).

mapslist [rubin_sim.maf.maps]

The maps that the metric will need (passed from the slicer).

unitsstr

The units for the value returned by the metric (optional - if not set, will be derived from the ColInfo).

metric_dtypestr

The type of value returned by the metric - ‘int’, ‘float’, ‘object’. If not set, will be derived by introspection.

badvalfloat

The value indicating “bad” values calculated by the metric.

Attributes Summary

col_info
col_registry
registry

Methods Summary

run(data_slice[, slice_point])

Calculate metric values.

Attributes Documentation

col_info = <rubin_sim.maf.stackers.get_col_info.ColInfo object>

col_registry = <rubin_sim.maf.metrics.base_metric.ColRegistry object>

registry = {'AbsMaxMetric': <class 'rubin_sim.maf.metrics.simple_metrics.AbsMaxMetric'>, 'AbsMaxPercentMetric': <class 'rubin_sim.maf.metrics.simple_metrics.AbsMaxPercentMetric'>, 'AbsMeanMetric': <class 'rubin_sim.maf.metrics.simple_metrics.AbsMeanMetric'>, 'AbsMedianMetric': <class 'rubin_sim.maf.metrics.simple_metrics.AbsMedianMetric'>, 'AccumulateCountMetric': <class 'rubin_sim.maf.metrics.vector_metrics.AccumulateCountMetric'>, 'AccumulateM5Metric': <class 'rubin_sim.maf.metrics.vector_metrics.AccumulateM5Metric'>, 'AccumulateMetric': <class 'rubin_sim.maf.metrics.vector_metrics.AccumulateMetric'>, 'AccumulateUniformityMetric': <class 'rubin_sim.maf.metrics.vector_metrics.AccumulateUniformityMetric'>, 'ActivityOverPeriodMetric': <class 'rubin_sim.maf.metrics.mo_metrics.ActivityOverPeriodMetric'>, 'ActivityOverTimeMetric': <class 'rubin_sim.maf.metrics.mo_metrics.ActivityOverTimeMetric'>, 'AgnTimeLagMetric': <class 'rubin_sim.maf.metrics.agn_time_lag_metric.AgnTimeLagMetric'>, 'AngularSpreadMetric': <class 'rubin_sim.maf.metrics.simple_metrics.AngularSpreadMetric'>, 'AreaSummaryMetric': <class 'rubin_sim.maf.metrics.area_summary_metrics.AreaSummaryMetric'>, 'AreaThresholdMetric': <class 'rubin_sim.maf.metrics.area_summary_metrics.AreaThresholdMetric'>, 'AveSlewFracMetric': <class 'rubin_sim.maf.metrics.slew_metrics.AveSlewFracMetric'>, 'BDParallaxMetric': <class 'rubin_sim.maf.metrics.brown_dwarf_metric.BDParallaxMetric'>, 'BaseChildMetric': <class 'rubin_sim.maf.metrics.mo_metrics.BaseChildMetric'>, 'BaseMoMetric': <class 'rubin_sim.maf.metrics.mo_metrics.BaseMoMetric'>, 'BinaryMetric': <class 'rubin_sim.maf.metrics.simple_metrics.BinaryMetric'>, 'BruteOSFMetric': <class 'rubin_sim.maf.metrics.technical_metrics.BruteOSFMetric'>, 'CampaignLengthMetric': <class 'rubin_sim.maf.metrics.season_metrics.CampaignLengthMetric'>, 'ChipVendorMetric': <class 'rubin_sim.maf.metrics.chip_vendor_metric.ChipVendorMetric'>, 'Coaddm5Metric': <class 'rubin_sim.maf.metrics.simple_metrics.Coaddm5Metric'>, 'ColorAsteroidMetric': <class 'rubin_sim.maf.metrics.mo_metrics.ColorAsteroidMetric'>, 'CountBeyondThreshold': <class 'rubin_sim.maf.metrics.simple_metrics.CountBeyondThreshold'>, 'CountExplimMetric': <class 'rubin_sim.maf.metrics.simple_metrics.CountExplimMetric'>, 'CountMetric': <class 'rubin_sim.maf.metrics.simple_metrics.CountMetric'>, 'CountRatioMetric': <class 'rubin_sim.maf.metrics.simple_metrics.CountRatioMetric'>, 'CountSubsetMetric': <class 'rubin_sim.maf.metrics.simple_metrics.CountSubsetMetric'>, 'CountUniqueMetric': <class 'rubin_sim.maf.metrics.simple_metrics.CountUniqueMetric'>, 'CrowdingM5Metric': <class 'rubin_sim.maf.metrics.crowding_metric.CrowdingM5Metric'>, 'CrowdingMagUncertMetric': <class 'rubin_sim.maf.metrics.crowding_metric.CrowdingMagUncertMetric'>, 'CumulativeMetric': <class 'rubin_sim.maf.metrics.cumulative_metric.CumulativeMetric'>, 'DcrPrecisionMetric': <class 'rubin_sim.maf.metrics.dcr_metric.DcrPrecisionMetric'>, 'DiscoveryDistanceMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryDistanceMetric'>, 'DiscoveryEclonlatMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryEclonlatMetric'>, 'DiscoveryMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryMetric'>, 'DiscoveryNChancesMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryNChancesMetric'>, 'DiscoveryNObsMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryNObsMetric'>, 'DiscoveryRadecMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryRadecMetric'>, 'DiscoveryTimeMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryTimeMetric'>, 'DiscoveryVelocityMetric': <class 'rubin_sim.maf.metrics.mo_metrics.DiscoveryVelocityMetric'>, 'ExgalM5': <class 'rubin_sim.maf.metrics.exgal_m5.ExgalM5'>, 'ExgalM5WithCuts': <class 'rubin_sim.maf.metrics.weak_lensing_systematics_metric.ExgalM5WithCuts'>, 'FOArea': <class 'rubin_sim.maf.metrics.summary_metrics.FOArea'>, 'FONv': <class 'rubin_sim.maf.metrics.summary_metrics.FONv'>, 'FSMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.FSMetric'>, 'FftMetric': <class 'rubin_sim.maf.metrics.fft_metric.FftMetric'>, 'FracAboveMetric': <class 'rubin_sim.maf.metrics.simple_metrics.FracAboveMetric'>, 'FracBelowMetric': <class 'rubin_sim.maf.metrics.simple_metrics.FracBelowMetric'>, 'FullRangeAngleMetric': <class 'rubin_sim.maf.metrics.simple_metrics.FullRangeAngleMetric'>, 'FullRangeMetric': <class 'rubin_sim.maf.metrics.simple_metrics.FullRangeMetric'>, 'GalPlaneFootprintMetric': <class 'rubin_sim.maf.metrics.galactic_plane_metrics.GalPlaneFootprintMetric'>, 'GalPlaneSeasonGapsTimescaleMetric': <class 'rubin_sim.maf.metrics.galplane_time_sampling_metrics.GalPlaneSeasonGapsTimescaleMetric'>, 'GalPlaneTimePerFilterMetric': <class 'rubin_sim.maf.metrics.galactic_plane_metrics.GalPlaneTimePerFilterMetric'>, 'GalPlaneVisitIntervalsTimescaleMetric': <class 'rubin_sim.maf.metrics.galplane_time_sampling_metrics.GalPlaneVisitIntervalsTimescaleMetric'>, 'HighVelocityMetric': <class 'rubin_sim.maf.metrics.mo_metrics.HighVelocityMetric'>, 'HighVelocityNightsMetric': <class 'rubin_sim.maf.metrics.mo_metrics.HighVelocityNightsMetric'>, 'HistogramM5Metric': <class 'rubin_sim.maf.metrics.vector_metrics.HistogramM5Metric'>, 'HistogramMetric': <class 'rubin_sim.maf.metrics.vector_metrics.HistogramMetric'>, 'HourglassMetric': <class 'rubin_sim.maf.metrics.hourglass_metric.HourglassMetric'>, 'IdentityMetric': <class 'rubin_sim.maf.metrics.summary_metrics.IdentityMetric'>, 'InstantaneousColorMetric': <class 'rubin_sim.maf.metrics.mo_metrics.InstantaneousColorMetric'>, 'InterNightGapsMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.InterNightGapsMetric'>, 'IntraNightGapsMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.IntraNightGapsMetric'>, 'KnownObjectsMetric': <class 'rubin_sim.maf.metrics.mo_metrics.KnownObjectsMetric'>, 'KuiperMetric': <class 'rubin_sim.maf.metrics.kuiper_metrics.KuiperMetric'>, 'LightcurveColorOuterMetric': <class 'rubin_sim.maf.metrics.mo_metrics.LightcurveColorOuterMetric'>, 'LightcurveInversionAsteroidMetric': <class 'rubin_sim.maf.metrics.mo_metrics.LightcurveInversionAsteroidMetric'>, 'LongGapAGNMetric': <class 'rubin_sim.maf.metrics.long_gap_agn_metric.LongGapAGNMetric'>, 'MagicDiscoveryMetric': <class 'rubin_sim.maf.metrics.mo_metrics.MagicDiscoveryMetric'>, 'MaxGapMetric': <class 'rubin_sim.maf.metrics.tgaps.MaxGapMetric'>, 'MaxMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MaxMetric'>, 'MaxPercentMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MaxPercentMetric'>, 'MaxStateChangesWithinMetric': <class 'rubin_sim.maf.metrics.technical_metrics.MaxStateChangesWithinMetric'>, 'MeanAngleMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MeanAngleMetric'>, 'MeanCampaignFrequencyMetric': <class 'rubin_sim.maf.metrics.season_metrics.MeanCampaignFrequencyMetric'>, 'MeanMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MeanMetric'>, 'MeanValueAtHMetric': <class 'rubin_sim.maf.metrics.mo_summary_metrics.MeanValueAtHMetric'>, 'MedianMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MedianMetric'>, 'MinMetric': <class 'rubin_sim.maf.metrics.simple_metrics.MinMetric'>, 'MinTimeBetweenStatesMetric': <class 'rubin_sim.maf.metrics.technical_metrics.MinTimeBetweenStatesMetric'>, 'MoCompletenessAtTimeMetric': <class 'rubin_sim.maf.metrics.mo_summary_metrics.MoCompletenessAtTimeMetric'>, 'MoCompletenessMetric': <class 'rubin_sim.maf.metrics.mo_summary_metrics.MoCompletenessMetric'>, 'NChangesMetric': <class 'rubin_sim.maf.metrics.technical_metrics.NChangesMetric'>, 'NNightsMetric': <class 'rubin_sim.maf.metrics.mo_metrics.NNightsMetric'>, 'NObsMetric': <class 'rubin_sim.maf.metrics.mo_metrics.NObsMetric'>, 'NObsNoSinglesMetric': <class 'rubin_sim.maf.metrics.mo_metrics.NObsNoSinglesMetric'>, 'NRevisitsMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.NRevisitsMetric'>, 'NStateChangesFasterThanMetric': <class 'rubin_sim.maf.metrics.technical_metrics.NStateChangesFasterThanMetric'>, 'NVisitsPerNightMetric': <class 'rubin_sim.maf.metrics.tgaps.NVisitsPerNightMetric'>, 'NgalScaleMetric': <class 'rubin_sim.maf.metrics.scaling_metrics.NgalScaleMetric'>, 'NightPointingMetric': <class 'rubin_sim.maf.metrics.night_pointing_metric.NightPointingMetric'>, 'NightTimespanMetric': <class 'rubin_sim.maf.metrics.tgaps.NightTimespanMetric'>, 'NightgapsMetric': <class 'rubin_sim.maf.metrics.tgaps.NightgapsMetric'>, 'NlcPointsMetric': <class 'rubin_sim.maf.metrics.scaling_metrics.NlcPointsMetric'>, 'NormalizeMetric': <class 'rubin_sim.maf.metrics.summary_metrics.NormalizeMetric'>, 'NoutliersNsigmaMetric': <class 'rubin_sim.maf.metrics.simple_metrics.NoutliersNsigmaMetric'>, 'NstarsMetric': <class 'rubin_sim.maf.metrics.crowding_metric.NstarsMetric'>, 'ObsArcMetric': <class 'rubin_sim.maf.metrics.mo_metrics.ObsArcMetric'>, 'OpenShutterFractionMetric': <class 'rubin_sim.maf.metrics.technical_metrics.OpenShutterFractionMetric'>, 'OptimalM5Metric': <class 'rubin_sim.maf.metrics.optimal_m5_metric.OptimalM5Metric'>, 'PairFractionMetric': <class 'rubin_sim.maf.metrics.visit_groups_metric.PairFractionMetric'>, 'PairMetric': <class 'rubin_sim.maf.metrics.pair_metric.PairMetric'>, 'ParallaxCoverageMetric': <class 'rubin_sim.maf.metrics.calibration_metrics.ParallaxCoverageMetric'>, 'ParallaxDcrDegenMetric': <class 'rubin_sim.maf.metrics.calibration_metrics.ParallaxDcrDegenMetric'>, 'ParallaxMetric': <class 'rubin_sim.maf.metrics.calibration_metrics.ParallaxMetric'>, 'PassMetric': <class 'rubin_sim.maf.metrics.simple_metrics.PassMetric'>, 'PeakVMagMetric': <class 'rubin_sim.maf.metrics.mo_metrics.PeakVMagMetric'>, 'PercentileMetric': <class 'rubin_sim.maf.metrics.simple_metrics.PercentileMetric'>, 'PeriodicDetectMetric': <class 'rubin_sim.maf.metrics.periodic_detect_metric.PeriodicDetectMetric'>, 'PeriodicQualityMetric': <class 'rubin_sim.maf.metrics.phase_gap_metric.PeriodicQualityMetric'>, 'PhaseGapMetric': <class 'rubin_sim.maf.metrics.phase_gap_metric.PhaseGapMetric'>, 'ProperMotionMetric': <class 'rubin_sim.maf.metrics.calibration_metrics.ProperMotionMetric'>, 'QSONumberCountsMetric': <class 'rubin_sim.maf.metrics.qso_number_counts_metric.QSONumberCountsMetric'>, 'RIZDetectionCoaddExposureTime': <class 'rubin_sim.maf.metrics.weak_lensing_systematics_metric.RIZDetectionCoaddExposureTime'>, 'RadiusObsMetric': <class 'rubin_sim.maf.metrics.calibration_metrics.RadiusObsMetric'>, 'RapidRevisitMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.RapidRevisitMetric'>, 'RapidRevisitUniformityMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.RapidRevisitUniformityMetric'>, 'RealMeanMetric': <class 'rubin_sim.maf.metrics.simple_metrics.RealMeanMetric'>, 'RelRmsMetric': <class 'rubin_sim.maf.metrics.simple_metrics.RelRmsMetric'>, 'RmsAngleMetric': <class 'rubin_sim.maf.metrics.simple_metrics.RmsAngleMetric'>, 'RmsMetric': <class 'rubin_sim.maf.metrics.simple_metrics.RmsMetric'>, 'RobustRmsMetric': <class 'rubin_sim.maf.metrics.simple_metrics.RobustRmsMetric'>, 'SFUncertMetric': <class 'rubin_sim.maf.metrics.agnstructure.SFUncertMetric'>, 'SNCadenceMetric': <class 'rubin_sim.maf.metrics.sn_cadence_metric.SNCadenceMetric'>, 'SNNSNMetric': <class 'rubin_sim.maf.metrics.sn_n_sn_metric.SNNSNMetric'>, 'SNSLMetric': <class 'rubin_sim.maf.metrics.sn_sl_metric.SNSLMetric'>, 'SNSNRMetric': <class 'rubin_sim.maf.metrics.sn_snr_metric.SNSNRMetric'>, 'SeasonLengthMetric': <class 'rubin_sim.maf.metrics.season_metrics.SeasonLengthMetric'>, 'SkySaturationMetric': <class 'rubin_sim.maf.metrics.sky_sat_metric.SkySaturationMetric'>, 'SlewContributionMetric': <class 'rubin_sim.maf.metrics.slew_metrics.SlewContributionMetric'>, 'StarDensityMetric': <class 'rubin_sim.maf.metrics.star_density.StarDensityMetric'>, 'StaticProbesFoMEmulatorMetricSimple': <class 'rubin_sim.maf.metrics.summary_metrics.StaticProbesFoMEmulatorMetricSimple'>, 'StringCountMetric': <class 'rubin_sim.maf.metrics.string_count_metric.StringCountMetric'>, 'SumMetric': <class 'rubin_sim.maf.metrics.simple_metrics.SumMetric'>, 'SurfaceBrightLimitMetric': <class 'rubin_sim.maf.metrics.surfb_metric.SurfaceBrightLimitMetric'>, 'TdcMetric': <class 'rubin_sim.maf.metrics.season_metrics.TdcMetric'>, 'TeffMetric': <class 'rubin_sim.maf.metrics.technical_metrics.TeffMetric'>, 'TemplateExistsMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.TemplateExistsMetric'>, 'TgapsMetric': <class 'rubin_sim.maf.metrics.tgaps.TgapsMetric'>, 'TgapsPercentMetric': <class 'rubin_sim.maf.metrics.tgaps.TgapsPercentMetric'>, 'TotalNumberSSO': <class 'rubin_sim.maf.metrics.mo_summary_metrics.TotalNumberSSO'>, 'TotalPowerMetric': <class 'rubin_sim.maf.metrics.summary_metrics.TotalPowerMetric'>, 'TransientMetric': <class 'rubin_sim.maf.metrics.transient_metrics.TransientMetric'>, 'UniformityMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.UniformityMetric'>, 'UniqueRatioMetric': <class 'rubin_sim.maf.metrics.simple_metrics.UniqueRatioMetric'>, 'UseMetric': <class 'rubin_sim.maf.metrics.use_metrics.UseMetric'>, 'ValueAtHMetric': <class 'rubin_sim.maf.metrics.mo_summary_metrics.ValueAtHMetric'>, 'VectorMetric': <class 'rubin_sim.maf.metrics.vector_metrics.VectorMetric'>, 'VisitGapMetric': <class 'rubin_sim.maf.metrics.cadence_metrics.VisitGapMetric'>, 'VisitGroupsMetric': <class 'rubin_sim.maf.metrics.visit_groups_metric.VisitGroupsMetric'>, 'VolumeSumMetric': <class 'rubin_sim.maf.metrics.brown_dwarf_metric.VolumeSumMetric'>, 'WeakLensingNvisits': <class 'rubin_sim.maf.metrics.weak_lensing_systematics_metric.WeakLensingNvisits'>, 'YearCoverageMetric': <class 'rubin_sim.maf.metrics.coverage_metric.YearCoverageMetric'>, 'ZeropointMetric': <class 'rubin_sim.maf.metrics.summary_metrics.ZeropointMetric'>, 'rubin_sim.maf.maf_contrib.DepthLimitedNumGalMetric': <class 'rubin_sim.maf.maf_contrib.depth_limited_num_gal_metric.DepthLimitedNumGalMetric'>, 'rubin_sim.maf.maf_contrib.FilterPairTGapsMetric': <class 'rubin_sim.maf.maf_contrib.filter_pair_t_gaps_metric.FilterPairTGapsMetric'>, 'rubin_sim.maf.maf_contrib.GRBTransientMetric': <class 'rubin_sim.maf.maf_contrib.grb_transient_metric.GRBTransientMetric'>, 'rubin_sim.maf.maf_contrib.GW170817DetMetric': <class 'rubin_sim.maf.maf_contrib.gw170817_det_metric.GW170817DetMetric'>, 'rubin_sim.maf.maf_contrib.GalaxyCountsMetric': <class 'rubin_sim.maf.maf_contrib.lss_metrics.GalaxyCountsMetric'>, 'rubin_sim.maf.maf_contrib.KNePopMetric': <class 'rubin_sim.maf.maf_contrib.kne_metrics.KNePopMetric'>, 'rubin_sim.maf.maf_contrib.MicrolensingMetric': <class 'rubin_sim.maf.maf_contrib.microlensing_metric.MicrolensingMetric'>, 'rubin_sim.maf.maf_contrib.NYoungStarsMetric': <class 'rubin_sim.maf.maf_contrib.young_stellar_objects_metric.NYoungStarsMetric'>, 'rubin_sim.maf.maf_contrib.PeriodDeviationMetric': <class 'rubin_sim.maf.maf_contrib.var_metrics.PeriodDeviationMetric'>, 'rubin_sim.maf.maf_contrib.PeriodicMetric': <class 'rubin_sim.maf.maf_contrib.periodic_metric.PeriodicMetric'>, 'rubin_sim.maf.maf_contrib.PeriodicStarMetric': <class 'rubin_sim.maf.maf_contrib.periodic_star_metric.PeriodicStarMetric'>, 'rubin_sim.maf.maf_contrib.PeriodicStarModulationMetric': <class 'rubin_sim.maf.maf_contrib.periodic_star_modulation_metric.PeriodicStarModulationMetric'>, 'rubin_sim.maf.maf_contrib.PrestoColorKNePopMetric': <class 'rubin_sim.maf.maf_contrib.presto_color_kne_pop_metric.PrestoColorKNePopMetric'>, 'rubin_sim.maf.maf_contrib.RelRmsMetric': <class 'rubin_sim.maf.maf_contrib.phot_prec_metrics.RelRmsMetric'>, 'rubin_sim.maf.maf_contrib.SEDSNMetric': <class 'rubin_sim.maf.maf_contrib.phot_prec_metrics.SEDSNMetric'>, 'rubin_sim.maf.maf_contrib.SNMetric': <class 'rubin_sim.maf.maf_contrib.phot_prec_metrics.SNMetric'>, 'rubin_sim.maf.maf_contrib.StarCountMassMetric': <class 'rubin_sim.maf.maf_contrib.star_count_mass_metric.StarCountMassMetric'>, 'rubin_sim.maf.maf_contrib.StarCountMetric': <class 'rubin_sim.maf.maf_contrib.star_count_metric.StarCountMetric'>, 'rubin_sim.maf.maf_contrib.StaticProbesFoMEmulatorMetric': <class 'rubin_sim.maf.maf_contrib.static_probes_fom_summary_metric.StaticProbesFoMEmulatorMetric'>, 'rubin_sim.maf.maf_contrib.TdePopMetric': <class 'rubin_sim.maf.maf_contrib.tdes_pop_metric.TdePopMetric'>, 'rubin_sim.maf.maf_contrib.TdePopMetricQuality': <class 'rubin_sim.maf.maf_contrib.tdes_pop_metric.TdePopMetricQuality'>, 'rubin_sim.maf.maf_contrib.ThreshSEDSNMetric': <class 'rubin_sim.maf.maf_contrib.phot_prec_metrics.ThreshSEDSNMetric'>, 'rubin_sim.maf.maf_contrib.TransientAsciiSEDMetric': <class 'rubin_sim.maf.maf_contrib.transient_ascii_sed_metric.TransientAsciiSEDMetric'>, 'rubin_sim.maf.maf_contrib.TripletBandMetric': <class 'rubin_sim.maf.maf_contrib.triplet_metric.TripletBandMetric'>, 'rubin_sim.maf.maf_contrib.TripletMetric': <class 'rubin_sim.maf.maf_contrib.triplet_metric.TripletMetric'>, 'rubin_sim.maf.maf_contrib.VarDepth': <class 'rubin_sim.maf.maf_contrib.var_depth_metric.VarDepth'>, 'rubin_sim.maf.maf_contrib.XRBPopMetric': <class 'rubin_sim.maf.maf_contrib.xrb_metrics.XRBPopMetric'>, 'rubin_sim.maf.maf_contrib.lss_obs_strategy.GalaxyCountsMetricExtended': <class 'rubin_sim.maf.maf_contrib.lss_obs_strategy.galaxy_counts_metric_extended.GalaxyCountsMetricExtended'>, 'rubin_sim.maf.maf_contrib.lss_obs_strategy.NumObsMetric': <class 'rubin_sim.maf.maf_contrib.lss_obs_strategy.num_obs_metric.NumObsMetric'>, 'rubin_sim.maf.maf_contrib.lv_dwarfs.LVDwarfsMetric': <class 'rubin_sim.maf.maf_contrib.lv_dwarfs.lv_dwarfs_metrics.LVDwarfsMetric'>}

Methods Documentation

run(data_slice, slice_point=None)

Calculate metric values.

Parameters:

data_slicenumpy.recarray

Values passed to metric by the slicer, which the metric will use to calculate metric values at each slice_point.

slice_pointdict or None

Dictionary of slice_point metadata passed to each metric. E.g. the ra/dec of the healpix pixel or opsim fieldId.

Returns:

metricValue: int float or object

The metric value at each slice_point.