get_search_model

sofia_redux.toolkit.fitting.fitpeaks1d.get_search_model(peak_model, box_class=None, box_width=None, min_width=None, xrange=None, **kwargs)[source]

Create the initial_search peak fitting model

This function is used to create the peak model that will be used during the initial peak search. This is a fairly simple function which adds an optional filtering (box) model to the peak_model and instantiates it with the necessary options.

Parameters:
peak_modelastropy.modeling.Fittable1DModel

Class for the peak model

box_classastropy.modeling.Fittable1DModel, optional

Convolve the peak model with this model, generally to reduce the range over which the model is fit.

box_width(float or int) or (2-tuple of (str, float)), optional

Used conjunction with box_model. See box_convolve for full details and usage.

min_width2-tuple of (str, (int or float))

If supplied will set the minimum bounds of the width parameter min_width[0] to min_width[1]. Overrides kwargs.

xrange2-tuple of float, optional

(minumum, maximum) xrange over which the model is applicable. Set to avoid extrapolation.

kwargsdict, optional

Extra keywords to pass into either the peak_model or box_convolve.

Returns:
resultinstance of astropy.modeling.Fittable1DModel

The model to be used for an initial peak-search.