StarletMorphology#

class scarlet2.StarletMorphology(coeffs: Array)[source]#

Bases: Morphology

Morphology in the starlet basis

Notes

The starlet basis is overcomplete, which means it can exactly represent the same image in multiple ways. If used without constraints or priors on the starlet coefficients, this morphology model is functionally indistinguishable from a 2D pixel array, while using more operations.

See also

scarlet2.wavelets.Starlet

__call__(**kwargs)[source]#: Evaluate the model

coeffs: Array#: Starlet coefficients

static from_image(image, min_value=None, max_value=None)[source]#

Create starlet morphology from image

Parameters:

image (array) – 2D image array to determine coefficients from.
min_value ((float, None):) – Minimum value threshold for coefficients
max_value ((float, None):) – Minimum value threshold for coefficients

Return type:

StarletMorphology

get(name=None)#

Get parameter(s) from this module

Parameters:: name (str, optional) – Name of parameter. If not set, returns all parameters.
Returns:: requested data arrays for parameters
Return type:: dict

property parameters#

Parameters defined for this module

Returns:: name: (node, param) mapping for all parameters
Return type:: dict

replace(name, value)#

Replace member attribuge name with value

Parameters:

name (str) – Name of member to replace
value (any) – Value to replace member with

Returns:

The modified module.

Return type:

Module

replace_subtree(where, value, parameters=None)#

Replace the subtree where(self) with value and carry over all other parameters

Unlike replace(), value does not need to have the same structure as the subtree it replaces, e.g. an array morphology can be replaced by a SersicMorphology. Parameters defined for this module remain attached to the same nodes, except those inside the replaced subtree, which are dropped.

Parameters:

where (callable) – Function module -> node that selects the subtree to replace, as in equinox.tree_at()
value (any) – Replacement for the subtree. If this module has a frame, attributes of value given in sky coordinates are converted to pixel coordinates of that frame.
parameters (callable, optional) – Function module -> None that is called with the new module inside of a Parameters context to define parameters for the replacement, e.g. by calling Parameter on nodes of value.

Returns:

The modified module.

Return type:

Module

Examples

>>> sersic = SersicMorphology(n=jnp.array(2.), size=jnp.array(2.), shape=morph.shape)
>>> def sersic_parameters(morph):
>>>     Parameter(morph.n, name="n:0", prior=dist.Uniform(0.5, 6))
>>>     Parameter(morph.size, name="size:0", constraint=constraints.positive, stepsize=0.1)
>>>
>>> scene_ = scene.replace_subtree(lambda sc: sc.sources[0].morphology, sersic, sersic_parameters)

StarletMorphology

Contents

StarletMorphology#