lsst.scarlet.lite.parameters.FixedParameter Class Reference

Inheritance diagram for lsst.scarlet.lite.parameters.FixedParameter:

Public Member Functions
	__init__ (self, np.ndarray x)
	update (self, int it, np.ndarray input_grad, *args)

Detailed Description

A parameter that is not updated

Definition at line 454 of file parameters.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.parameters.FixedParameter.__init__	(		self,
		np.ndarray	x )

Reimplemented from lsst.scarlet.lite.parameters.Parameter.

Definition at line 457 of file parameters.py.

    def __init__(self, x: np.ndarray):
        super().__init__(x, {}, 0)
 

Member Function Documentation

update()

lsst.scarlet.lite.parameters.FixedParameter.update	(		self,
		int	it,
		np.ndarray	input_grad,
		*	args )

Update the parameter in one iteration.

This includes the gradient update, proximal update,
and any meta parameters that are stored as class
attributes to update the parameter.

Parameters
----------
it:
    The current iteration
input_grad:
    The gradient from the full model, passed to the parameter.

Reimplemented from lsst.scarlet.lite.parameters.Parameter.

Definition at line 460 of file parameters.py.

    def update(self, it: int, input_grad: np.ndarray, *args):
        pass
 
 

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/scarlet_lite/gee10cc3b42+a6fc98d2e7/python/lsst/scarlet/lite/parameters.py