LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, np.ndarray x, dict[str, np.ndarray] helpers, Callable|float step, Callable|None grad=None, Callable|None prox=None) | |
float | step (self) |
tuple[int,...] | shape (self) |
npt.DTypeLike | dtype (self) |
Parameter | copy (self) |
update (self, int it, np.ndarray input_grad, *args) | |
resize (self, Box old_box, Box new_box) | |
Public Attributes | |
x = x | |
helpers = helpers | |
grad = grad | |
prox = prox | |
Protected Attributes | |
_step = _step | |
A parameter in a `Component` Parameters ---------- x: The array of values that is being fit. helpers: A dictionary of helper arrays that are used by an optimizer to persist values like the gradient of `x`, the Hessian of `x`, etc. step: A numerical step value or function to calculate the step for a given `x``. grad: A function to calculate the gradient of `x`. prox: A function to take the proximal operator of `x`.
Definition at line 63 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.__init__ | ( | self, | |
np.ndarray | x, | ||
dict[str, np.ndarray] | helpers, | ||
Callable | float | step, | ||
Callable | None | grad = None, | ||
Callable | None | prox = None ) |
Definition at line 82 of file parameters.py.
Parameter lsst.scarlet.lite.parameters.Parameter.copy | ( | self | ) |
Copy this parameter, including all of the helper arrays.
Definition at line 123 of file parameters.py.
npt.DTypeLike lsst.scarlet.lite.parameters.Parameter.dtype | ( | self | ) |
The numpy dtype of the array that is being fit.
Definition at line 119 of file parameters.py.
Grow the parameter and all of the helper parameters Parameters ---------- old_box: The old bounding box for the parameter. new_box: The new bounding box for the parameter.
Definition at line 144 of file parameters.py.
tuple[int, ...] lsst.scarlet.lite.parameters.Parameter.shape | ( | self | ) |
The shape of the array that is being fit.
Definition at line 114 of file parameters.py.
float lsst.scarlet.lite.parameters.Parameter.step | ( | self | ) |
Calculate the step Return ------ step: The numerical step if no iteration is given.
Definition at line 103 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.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 in lsst.scarlet.lite.parameters.AdaproxParameter, lsst.scarlet.lite.parameters.FistaParameter, and lsst.scarlet.lite.parameters.FixedParameter.
Definition at line 128 of file parameters.py.
|
protected |
Definition at line 98 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.grad = grad |
Definition at line 99 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.helpers = helpers |
Definition at line 91 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.prox = prox |
Definition at line 100 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.x = x |
Definition at line 90 of file parameters.py.