Skip to content

registry

registry

Fitter registry for osipy.

Standard registry for BaseFitter subclasses. Follows the same pattern as all other osipy registries (DSC deconvolution, DCE models, etc.).

register_fitter

register_fitter(name)

Register a fitter class.

PARAMETER DESCRIPTION
name

Registry key for the fitter (e.g., 'lm').

TYPE: str

get_fitter

get_fitter(name)

Get a fitter instance by name.

PARAMETER DESCRIPTION
name

Registry key for the fitter.

TYPE: str

RETURNS DESCRIPTION
BaseFitter

A new fitter instance.

RAISES DESCRIPTION
DataValidationError

If the fitter name is not recognized.

list_fitters

list_fitters()

List registered canonical fitter names.

RETURNS DESCRIPTION
list[str]

Sorted list of registered fitter names (excludes aliases).