make_injection_pipeline

lsst.source.injection.make_injection_pipeline(dataset_type_name: str, reference_pipeline: Pipeline | str, injection_pipeline: Pipeline | str | None = None, exclude_subsets: bool = False, excluded_tasks: set[str] | str = {'fgcmBuildFromIsolatedStars', 'fgcmFitCycle', 'fgcmOutputProducts', 'gbdesAstrometricFit', 'jointcal'}, prefix: str = 'injected_', instrument: str | None = None, config: str | list[str] | None = None, log_level: int = 20) → Pipeline

Make an expanded source injection pipeline.

This function takes a reference pipeline definition file in YAML format and prefixes all post-injection dataset type names with the injected prefix. If an optional injection pipeline definition YAML file is also provided, the injection task will be merged into the pipeline.

Unless explicitly excluded, all subsets from the reference pipeline containing the task which generates the injection dataset type will also be updated to include the injection task. A series of new injected subsets will also be created. These new subsets are copies of existent subsets, but containing only the tasks which are affected by source injection. New injected subsets will be the original subset name with the prefix ‘injected_’ prepended.

Parameters:

dataset_type_namestr

Name of the dataset type being injected into.

reference_pipelinePipeline | str

Location of a reference pipeline definition YAML file.

injection_pipelinePipeline | str, optional

Location of an injection pipeline definition YAML file stub. If not provided, an attempt to infer the injection pipeline will be made based on the injected dataset type name.

exclude_subsetsbool, optional

If True, do not update pipeline subsets to include the injection task.

excluded_tasksset [str] | str

Set or comma-separated string of task labels to exclude from the injection pipeline.

prefixstr, optional

Prefix to prepend to each affected post-injection dataset type name.

instrumentstr, optional

Add instrument overrides. Must be a fully qualified class name.

configstr | list [str], optional

Config override for a task, in the format ‘label:key=value’.

log_levelint, optional

The log level to use for logging.

Returns:

pipelinelsst.pipe.base.Pipeline

An expanded source injection pipeline.