LSST Applications g034a557a3c+dd8dd8f11d,g0afe43252f+b86e4b8053,g11f7dcd041+017865fdd3,g1cd03abf6b+8446defddb,g1ce3e0751c+f991eae79d,g28da252d5a+ca8a1a9fb3,g2bbee38e9b+b6588ad223,g2bc492864f+b6588ad223,g2cdde0e794+8523d0dbb4,g347aa1857d+b6588ad223,g35bb328faa+b86e4b8053,g3a166c0a6a+b6588ad223,g461a3dce89+b86e4b8053,g52b1c1532d+b86e4b8053,g7f3b0d46df+ad13c1b82d,g80478fca09+f29c5d6c70,g858d7b2824+293f439f82,g8cd86fa7b1+af721d2595,g965a9036f2+293f439f82,g979bb04a14+51ed57f74c,g9ddcbc5298+f24b38b85a,gae0086650b+b86e4b8053,gbb886bcc26+b97e247655,gc28159a63d+b6588ad223,gc30aee3386+a2f0f6cab9,gcaf7e4fdec+293f439f82,gcd45df26be+293f439f82,gcdd4ae20e8+70b5def7e6,gce08ada175+da9c58a417,gcf0d15dbbd+70b5def7e6,gdaeeff99f8+006e14e809,gdbce86181e+6a170ce272,ge3d4d395c2+224150c836,ge5f7162a3a+bb2241c923,ge6cb8fbbf7+d119aed356,ge79ae78c31+b6588ad223,gf048a9a2f4+40ffced2b8,gf0baf85859+b4cca3d10f,w.2024.30
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.