API Documentation¶

scarlet.bbox
- Box
- overlapped_slices()
scarlet.blend
- Blend
scarlet.cache
- Cache
  - Cache.check()
  - Cache.set()
scarlet.component
- CombinedComponent
  - CombinedComponent.get_model()
  - CombinedComponent.update()
- Component
- CubeComponent
  - CubeComponent.get_model()
- FactorizedComponent
scarlet.constraint
- CenterOnConstraint
- Constraint
- ConstraintChain
- L0Constraint
- L1Constraint
- LeakyConstraint
- MonotonicMaskConstraint
- MonotonicityConstraint
- NormalizationConstraint
- PositivityConstraint
- SymmetryConstraint
- ThresholdConstraint
  - ThresholdConstraint.threshold()
scarlet.detect
- QuadTreeRegion
- SingleScaleStructure
- bounds_to_bbox()
- box_intersect()
- draw_box()
- draw_footprint_box()
- draw_region()
- footprint_intersect()
- get_blend_structures()
- get_blend_trees()
- get_detect_wavelets()
- get_peaks()
- get_wavelets()
scarlet.display
- AsinhPercentileNorm
- LinearPercentileNorm
- channels_to_rgb()
- get_extent()
- img_to_3channel()
- img_to_rgb()
- show_likelihood()
- show_observation()
- show_scene()
- show_sources()
scarlet.fft
- Fourier
- convolve()
- match_psf()
- shift()
scarlet.frame
- Frame
scarlet.initialization
- build_initialization_image()
- get_minimal_boxsize()
- get_pixel_spectrum()
- get_psf_spectrum()
- init_all_sources()
- init_source()
- set_spectra_to_match()
- trim_morphology()
scarlet.interpolation
- apply_2D_trapezoid_rule()
- bilinear()
- catmull_rom()
- common_projections()
- cubic_spline()
- get_affine()
- get_angles()
- get_common_padding()
- get_filter_bounds()
- get_filter_coords()
- get_pixel_size()
- get_projection_slices()
- get_psf_size()
- get_separable_kernel()
- interpolate_observation()
- lanczos()
- mitchel_netravali()
- mk_shifter()
- project_image()
- quintic_spline()
- sinc2D()
- sinc_interp()
- sinc_interp_inplace()
- subsample_function()
scarlet.measure
- centroid()
- flux()
- max_pixel()
- moments()
- snr()
scarlet.model
- Model
- UpdateException
scarlet.morphology
- ExtendedSourceMorphology
  - ExtendedSourceMorphology.center
- GaussianMorphology
  - GaussianMorphology.integral
- ImageMorphology
  - ImageMorphology.get_model()
  - ImageMorphology.update()
- Morphology
  - Morphology.shrink_box()
- PointSourceMorphology
  - PointSourceMorphology.get_model()
  - PointSourceMorphology.integral
- ProfileMorphology
- SpergelMorphology
  - SpergelMorphology.integral
- StarletMorphology
  - StarletMorphology.get_model()
  - StarletMorphology.update()
scarlet.observation
- Observation
scarlet.operator
- diagonalizeArray()
- diagonalsToSparse()
- find_Q()
- find_relevant_dim()
- getOffsets()
- getRadialMonotonicWeights()
- get_center()
- proj()
- proj_dist()
- project_disk_sed()
- project_disk_sed_mean()
- prox_cone()
- prox_kspace_symmetry()
- prox_monotonic_mask()
- prox_sdss_symmetry()
- prox_soft_symmetry()
- prox_uncentered_symmetry()
- prox_weighted_monotonic()
- proximal_disk_sed()
- sort_by_radius()
- uncentered_operator()
- use_relevant_dim()
scarlet.parameter
- Parameter
  - Parameter.is_finite
- prepare_param()
- relative_step()
scarlet.prior
- Prior
  - Prior.grad()
scarlet.psf
- FunctionPSF
  - FunctionPSF.expand_dims()
- GaussianPSF
  - GaussianPSF.get_model()
- ImagePSF
  - ImagePSF.get_model()
- MoffatPSF
  - MoffatPSF.get_model()
- PSF
  - PSF.get_model()
- normalize()
scarlet.renderer
- ConvolutionRenderer
- NullRenderer
  - NullRenderer.get_model()
- Renderer
  - Renderer.get_channel_map()
  - Renderer.map_channels()
- ResolutionRenderer
scarlet.source
- CompactExtendedSource
  - CompactExtendedSource.init_morph()
- ExtendedSource()
- GaussianSource
- MultiExtendedSource
  - MultiExtendedSource.init_morphs()
- NullSource
  - NullSource.get_model()
- PointSource
- RandomSource
- SingleExtendedSource
  - SingleExtendedSource.init_morph()
- SpergelSource
- StarletSource
  - StarletSource.from_source()
- append_docs_from()
scarlet.spectrum
- Spectrum
- TabulatedSpectrum
  - TabulatedSpectrum.get_model()
scarlet.wavelet
- InputError
- Starlet
- apply_wavelet_denoising()
- get_multiresolution_support()
- get_scales()
- multiband_starlet_reconstruction()
- multiband_starlet_transform()
- starlet_reconstruction()
- starlet_transform()