lsst.scarlet.lite gee10cc3b42+585e252eca
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.scarlet.lite.parameters.FixedParameter Class Reference
Inheritance diagram for lsst.scarlet.lite.parameters.FixedParameter:
lsst.scarlet.lite.parameters.Parameter

Public Member Functions

 __init__ (self, np.ndarray x)
 
 update (self, int it, np.ndarray input_grad, *args)
 
- Public Member Functions inherited from lsst.scarlet.lite.parameters.Parameter
float step (self)
 
tuple[int,...] shape (self)
 
npt.DTypeLike dtype (self)
 
Parameter copy (self)
 
 resize (self, Box old_box, Box new_box)
 

Additional Inherited Members

- Public Attributes inherited from lsst.scarlet.lite.parameters.Parameter
 x
 
 helpers
 
 grad
 
 prox
 
- Protected Attributes inherited from lsst.scarlet.lite.parameters.Parameter
 _step
 

Detailed Description

A parameter that is not updated

Constructor & Destructor Documentation

◆ __init__()

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

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.


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