splinebox.basis_functions.

basis_function_from_name#

splinebox.basis_functions.basis_function_from_name(name, **kwargs)#

Returns a basis function object based on the name of the basis function.

Parameters:
namestr

The name of the basis function (e.g. ‘B1’, ‘ExponentialHermite’, etc.)

kwargs

Additional keyword arguments that may be required to instantiate certain basis functions. For example, :code:`M`(the number of knots/control points) is required for exponential basis functions.

Returns:
basis_functionObject of one of the subcases of splinebox.basis_functions.BasisFunction.

An instance of a subclass of splinebox.basis_functions.BasisFunction, initialized according to the provided name and keyword arguments.

Examples

>>> splinebox.basis_functions.basis_function_from_name("B3")
splinebox.basis_functions.B3()