icecube.ml_suite.EventFeatureFactory module

class icecube.ml_suite.EventFeatureFactory.EventFeatureFactory(config: str | dict)

Bases: object

Reads a yaml config file and builds an Event Feature Extractor

Parameters:

config –

str or dict Path to yaml file or a dictionary with specified settings Config with example values:

{
    'pulse_key': 'InIceDSTPulses',

    # set to None if not applicable
    'dom_exclusions': {
        'exclusions': ['SaturationWindows','BadDomsList',
                       'CalibrationErrata'],
        'partial_exclusion': True,
    },

    # set to None if not applicable
    'pulse_modifier': {
        'class': 'ChargeWeightedMeanTimePulseModifier',
        'kwargs': {},
    },

    'feature_config': {
        'features': [
            {
                'class': 'TotalCharge',
                'kwargs': {},
            },
            {
                'class': 'ChargeUntilT',
                'kwargs': {'times': [10, 20]},
            },
        ]
    },
}

make_feature_extractor()