LSST Applications g0603fd7c41+501e3db9f9,g0aad566f14+23d8574c86,g0dd44d6229+a1a4c8b791,g2079a07aa2+86d27d4dc4,g2305ad1205+a62672bbc1,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+23d8574c86,g487adcacf7+cb7fd919b2,g4be5004598+23d8574c86,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4a9e435310,g63cd9335cc+585e252eca,g858d7b2824+23d8574c86,g88963caddf+0cb8e002cc,g99cad8db69+43388bcaec,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb2522980b2+793639e996,gb3a676b8dc+b4feba26a1,gb4b16eec92+63f8520565,gba4ed39666+c2a2e4ac27,gbb8dafda3b+a5d255a82e,gc120e1dc64+d820f8acdb,gc28159a63d+047b288a59,gc3e9b769f7+f4f1cc6b50,gcf0d15dbbd+a1a4c8b791,gdaeeff99f8+f9a426f77a,gdb0af172c8+b6d5496702,ge79ae78c31+047b288a59,w.2024.19
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 | |
helpers | |
grad | |
prox | |
Protected Attributes | |
_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 ) |
Reimplemented in lsst.scarlet.lite.parameters.FixedParameter, lsst.scarlet.lite.parameters.AdaproxParameter, and lsst.scarlet.lite.parameters.FistaParameter.
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.FistaParameter, lsst.scarlet.lite.parameters.AdaproxParameter, 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 |
Definition at line 99 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.helpers |
Definition at line 91 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.prox |
Definition at line 100 of file parameters.py.
lsst.scarlet.lite.parameters.Parameter.x |
Definition at line 90 of file parameters.py.