scarlet2

scarlet2#

Main namespace for scarlet2

Classes

ArrayPSF(morphology)

PSF defined by an image array

Box(shape[, origin])

Bounding Box for data array

Component(center, spectrum, morphology[, bbox])

Single component of a hyperspectral model

CorrelatedObservation(data[, psf, wcs, ...])

Content and definition of an observation with pixel correlations

DustComponent(center, spectrum, morphology)

Component with negative exponential model

Frame(bbox[, psf, wcs, channels])

Definition of a view of the sky

GaussianMorphology(size[, ellipticity, shape])

Gaussian radial profile

GaussianPSF(sigma)

Gaussian-shaped PSF

Module()

Scarlet2 base module

Morphology()

Morphology base class

Observation(data, weights[, psf, wcs, ...])

Content and definition of an observation

PairSimilarity(weight[, eps])

Configuration for the pair-similarity regularizer used by fit().

Parameter(node[, name, constraint, prior, ...])

Class representing a single optimizable parameter

Parameterization()

Class to hold the context for the current parameter set

Parameters(base)

Collection class that contains parameters

PointSource(center, spectrum)

Point source model

ProfileMorphology(size[, ellipticity, shape])

Base class for morphologies based on a radial profile

PSF()

PSF base class

Scene(frame)

Model of the celestial scene

Scenery()

Class to hold the context for the current scene

SersicMorphology(n, size[, ellipticity, shape])

Sersic radial profile

Source(center, spectrum, morphology[, bbox])

Source model

Spectrum()

Spectrum base class

Starlet(image, coefficients, generation, ...)

Wavelet transform of a images (2D or 3D) with the 'a trou' algorithm.

StarletMorphology(coeffs)

Morphology in the starlet basis

StaticArraySpectrum(data, bands[, band_selector])

Static (non-variable) source in a transient scene

TransientArraySpectrum(data[, epochs, ...])

Variable source in a transient scene with possible quiescent periods

Functions

stack_observations(observations, model_frame)

Stack observations into a single one on the grid of model_frame

relative_step(x, *args[, factor, minimum])

Step size set at factor times the norm of x

set_validation([state])

Set the global validation mode.