Component#

class scarlet2.Component(center, spectrum, morphology, bbox=None)[source]#

Bases: Module

Single component of a hyperspectral model

The parameterization of the 3D model (channel, height, width) is defined by the outer product of spectrum and morphology. That means that there is no variation of the spectrum in spatial direction. The center coordinate is only needed to define the bounding box and place the component in the model frame.

Parameters:

center (array, astropy.coordinates.SkyCoord) – Center position. If given as astropy sky coordinate, it will be transformed with the WCS of the model frame.
spectrum (Spectrum) – The spectrum of the component.
morphology (Morphology) – The morphology of the component.
bbox (Box, optional) – Bounding box of the component in pixel coordinates of the model frame.

Examples

To uniquely determine coordinates, the creation of components is restricted to a context defined by a Scene, which define the Frame of the model.

>>> with Scene(model_frame) as scene:
>>>    component = Component(center, spectrum, morphology)

__call__()[source]#: What to run when Component is called

bbox: Box#: Bounding box of the model, in sky coordinates or pixel coordinates of the model frame

center: Array#: Center position, in sky coordinates or pixel coordinates of the model frame

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

morphology: (<function array at 0x7fe56388e8e0>, <class 'scarlet2.morphology.Morphology'>)#: Morphology model

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)

Component

Contents

Component#