resins.models

Package containing the implementation of the various models.

All classes within are exposed for reference only and should not be instantiated directly. For obtaining the resolution function of an instrument, please use the resins.instrument.Instrument.get_resolution_function method.

Advanced Use

For work with custom models, see the model_base module, but do consider contributing any work.

resins.models.MODELS: dict[str, type[InstrumentModel]] = {'boxcar': <class 'resins.models.ideal.GenericBoxcar1DModel'>, 'discontinuous_polynomial': <class 'resins.models.polynomial.DiscontinuousPolynomialModel1D'>, 'gaussian': <class 'resins.models.ideal.GenericGaussian1DModel'>, 'lorentzian': <class 'resins.models.ideal.GenericLorentzian1DModel'>, 'panther_abins_polynomial': <class 'resins.models.panther_abins.PantherAbINSModel'>, 'polynomial_1d': <class 'resins.models.polynomial.PolynomialModel1D'>, 'pychop_fit_cncs': <class 'resins.models.pychop.PyChopModelCNCS'>, 'pychop_fit_fermi': <class 'resins.models.pychop.PyChopModelFermi'>, 'pychop_fit_let': <class 'resins.models.pychop.PyChopModelLET'>, 'tosca_book': <class 'resins.models.tosca_book.ToscaBookModel'>, 'trapezoid': <class 'resins.models.ideal.GenericTrapezoid1DModel'>, 'triangle': <class 'resins.models.ideal.GenericTriangle1DModel'>, 'vision_paper': <class 'resins.models.vision_paper.VisionPaperModel'>}

A dictionary mapping the unique name of a model to the corresponding class.

Contents