Skip to content

models

lmfit models

get_background_model(name)

Get background model by name.

Source code in mmg_toolbox/fitting/models.py 
84
85
86
87
88
89
90
91
92
def get_background_model(name: str) -> type[ModelType]:
    """Get background model by name."""
    model: type[ModelType] | None = None
    for model_name, names in BACKGROUND_MODELS.items():
        if name.lower() in names:
            model = MODELS[model_name]
    if model is None:
        raise ValueError(f"Background model '{name}' not found")
    return model

get_default_model(peak=DEFAULT_MODEL, background=DEFAULT_BACKGROUND)

Return a single peak lmfit model

Source code in mmg_toolbox/fitting/models.py 
95
96
97
98
99
def get_default_model(peak: str = DEFAULT_MODEL, background: str = DEFAULT_BACKGROUND) -> Model:
    """Return a single peak lmfit model"""
    model = get_peak_model(peak)
    bkg = get_background_model(background)
    return model() + bkg()

get_peak_model(name)

Get peak model by name.

Source code in mmg_toolbox/fitting/models.py 
73
74
75
76
77
78
79
80
81
def get_peak_model(name: str) -> type[ModelType]:
    """Get peak model by name."""
    model: type[ModelType] | None = None
    for model_name, names in PEAK_MODELS.items():
        if name.lower() in names:
            model = MODELS[model_name]
    if model is None:
        raise ValueError(f"Peak model '{name}' not found")
    return model