lsst.source.injection

Synthetic Source Injection

The lsst.source.injection package contains tools designed to assist in the injection of synthetic sources into scientific imaging. Source generation and subsequent source injection is powered by the GalSim software package.

An HSC i-band cutout from tract 9813, patch 42, showcasing the injection of a series of synthetic Sérsic sources. Images are ~100 arcseconds on the short axis, log scaled across the central 99.5% flux range, and smoothed with a Gaussian kernel of FWHM 3 pixels.

Before injection.

After injection.

Quick Reference Guide

References for each aspect of the synthetic source injection process.

• Make an Injection Pipeline
• Generate an Injection Catalog
• Ingest an Injection Catalog
• Inject Synthetic Sources
• Inspect Injected Outputs
• Match Injected Outputs

Frequently Asked Questions

A collection of Frequently Asked Questions, and answers.

• Frequently Asked Questions

Command Line Scripts

Utility scripts which may be called from the command line.

• generate_injection_catalog
• ingest_injection_catalog
• make_injection_pipeline

Pipeline Tasks

Documentation for lsst.source.injection pipeline tasks within this package.

CoaddInjectTask

Coadd-level class for injecting sources into images.

ExposureInjectTask

Exposure-level class for injecting sources into images.

VisitInjectTask

Visit-level class for injecting sources into images.

Contributing

The lsst.source.injection package is developed at github.com/lsst/source_injection.

Jira issues relating to this package can be found using the source_injection component.

Python API Reference

lsst.source.injection Package

The source_injection package provides functionality for injecting synthetic sources into astronomical images.

Modules

inject_base : Base classes for injection tasks. inject_exposure : Classes for injecting sources into individual exposures. inject_visit : Classes for injecting sources into individual visit images. inject_coadd : Classes for injecting sources into coadd images. inject_engine : Functions that assist in the manipulation of GalSim objects. utils : Utility functions for injection tasks.

Functions

consolidate_injected_deepCoadd_catalogs(...)	Consolidate all tables in catalog_dict into one table.
generate_galsim_objects(injection_catalog, ...)	Generate GalSim objects from an injection catalog.
generate_injection_catalog(ra_lim, dec_lim)	Generate a synthetic source injection catalog.
ingest_injection_catalog(writeable_butler, ...)	Ingest a source table into the butler.
inject_galsim_objects_into_exposure(...[, ...])	Inject sources into given exposure using GalSim.
make_injection_pipeline(dataset_type_name, ...)	Make an expanded source injection pipeline.

Classes

BaseInjectConfig(*args, **kw)	Base configuration for source injection tasks.
BaseInjectConnections(*[, config])	Base connections for source injection tasks.
BaseInjectTask(*[, config, log, initInputs])	Base class for injecting sources into images.
CoaddInjectConfig(*args, **kw)	Coadd-level configuration for source injection tasks.
CoaddInjectConnections(*[, config])	Coadd-level connections for source injection tasks.
CoaddInjectTask(*[, config, log, initInputs])	Coadd-level class for injecting sources into images.
ConsolidateInjectedCatalogsConfig(*args, **kw)	Base configuration for source injection tasks.
ConsolidateInjectedCatalogsConnections(*[, ...])	Base connections for source injection tasks.
ConsolidateInjectedCatalogsTask(*[, config, ...])	Class for combining all tables in a collection of input catalogs into one table.
ExposureInjectConfig(*args, **kw)	Exposure-level configuration for source injection tasks.
ExposureInjectConnections(*[, config])	Exposure-level connections for source injection tasks.
ExposureInjectTask(*[, config, log, initInputs])	Exposure-level class for injecting sources into images.
VisitInjectConfig(*args, **kw)	Visit-level configuration for source injection tasks.
VisitInjectConnections(*[, config])	Visit-level connections for source injection tasks.
VisitInjectTask(*[, config, log, initInputs])	Visit-level class for injecting sources into images.

Class Inheritance Diagram

digraph inheritance2934b43a31 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseInjectConfig" [URL="../../../py-api/lsst.source.injection.BaseInjectConfig.html#lsst.source.injection.BaseInjectConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base configuration for source injection tasks."]; "PipelineTaskConfig" -> "BaseInjectConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseInjectConnections" [URL="../../../py-api/lsst.source.injection.BaseInjectConnections.html#lsst.source.injection.BaseInjectConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base connections for source injection tasks."]; "PipelineTaskConnections" -> "BaseInjectConnections" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseInjectTask" [URL="../../../py-api/lsst.source.injection.BaseInjectTask.html#lsst.source.injection.BaseInjectTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for injecting sources into images."]; "PipelineTask" -> "BaseInjectTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CoaddInjectConfig" [URL="../../../py-api/lsst.source.injection.CoaddInjectConfig.html#lsst.source.injection.CoaddInjectConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Coadd-level configuration for source injection tasks."]; "BaseInjectConfig" -> "CoaddInjectConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CoaddInjectConnections" [URL="../../../py-api/lsst.source.injection.CoaddInjectConnections.html#lsst.source.injection.CoaddInjectConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Coadd-level connections for source injection tasks."]; "BaseInjectConnections" -> "CoaddInjectConnections" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CoaddInjectTask" [URL="../../../py-api/lsst.source.injection.CoaddInjectTask.html#lsst.source.injection.CoaddInjectTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Coadd-level class for injecting sources into images."]; "BaseInjectTask" -> "CoaddInjectTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "ConsolidateInjectedCatalogsConfig" [URL="../../../py-api/lsst.source.injection.ConsolidateInjectedCatalogsConfig.html#lsst.source.injection.ConsolidateInjectedCatalogsConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base configuration for source injection tasks."]; "PipelineTaskConfig" -> "ConsolidateInjectedCatalogsConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConsolidateInjectedCatalogsConnections" [URL="../../../py-api/lsst.source.injection.ConsolidateInjectedCatalogsConnections.html#lsst.source.injection.ConsolidateInjectedCatalogsConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base connections for source injection tasks."]; "PipelineTaskConnections" -> "ConsolidateInjectedCatalogsConnections" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConsolidateInjectedCatalogsTask" [URL="../../../py-api/lsst.source.injection.ConsolidateInjectedCatalogsTask.html#lsst.source.injection.ConsolidateInjectedCatalogsTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class for combining all tables in a collection of input catalogs"]; "PipelineTask" -> "ConsolidateInjectedCatalogsTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ExposureInjectConfig" [URL="../../../py-api/lsst.source.injection.ExposureInjectConfig.html#lsst.source.injection.ExposureInjectConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exposure-level configuration for source injection tasks."]; "VisitInjectConfig" -> "ExposureInjectConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ExposureInjectConnections" [URL="../../../py-api/lsst.source.injection.ExposureInjectConnections.html#lsst.source.injection.ExposureInjectConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exposure-level connections for source injection tasks."]; "VisitInjectConnections" -> "ExposureInjectConnections" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ExposureInjectTask" [URL="../../../py-api/lsst.source.injection.ExposureInjectTask.html#lsst.source.injection.ExposureInjectTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exposure-level class for injecting sources into images."]; "VisitInjectTask" -> "ExposureInjectTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTask" [URL="../../../py-api/lsst.pipe.base.PipelineTask.html#lsst.pipe.base.PipelineTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all pipeline tasks."]; "Task" -> "PipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTaskConfig" [URL="../../../py-api/lsst.pipe.base.PipelineTaskConfig.html#lsst.pipe.base.PipelineTaskConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration class for `PipelineTask`."]; "Config" -> "PipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTaskConnections" [URL="../../../py-api/lsst.pipe.base.PipelineTaskConnections.html#lsst.pipe.base.PipelineTaskConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="PipelineTaskConnections is a class used to declare desired IO when a"]; "Task" [URL="../../../py-api/lsst.pipe.base.Task.html#lsst.pipe.base.Task",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for data processing tasks."]; "VisitInjectConfig" [URL="../../../py-api/lsst.source.injection.VisitInjectConfig.html#lsst.source.injection.VisitInjectConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Visit-level configuration for source injection tasks."]; "BaseInjectConfig" -> "VisitInjectConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "VisitInjectConnections" [URL="../../../py-api/lsst.source.injection.VisitInjectConnections.html#lsst.source.injection.VisitInjectConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Visit-level connections for source injection tasks."]; "BaseInjectConnections" -> "VisitInjectConnections" [arrowsize=0.5,style="setlinewidth(0.5)"]; "VisitInjectTask" [URL="../../../py-api/lsst.source.injection.VisitInjectTask.html#lsst.source.injection.VisitInjectTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Visit-level class for injecting sources into images."]; "BaseInjectTask" -> "VisitInjectTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; }