lsst.pipe.tasks

lsst.pipe.tasks provides many of the Task classes that drive the LSST Science Pipelines. The pipeline tasks listed here are useful data processing entry points for most users.

lsst.pipe.tasks does not provide all the tasks and pipeline tasks in the LSST Science Pipelines. For a complete list of all available tasks, see Task index and for an introduction to processing data see Getting started with the LSST Science Pipelines.

Using lsst.pipe.tasks

• Deblending Flags Overview

Contributing

lsst.pipe.tasks is developed at https://github.com/lsst/pipe_tasks. You can find Jira issues for this module under the pipe_tasks component.

Task reference

Pipeline tasks

CalibrateImageTask

Compute the PSF, aperture corrections, astrometric and photometric calibrations, and summary statistics for a single science exposure, and produce a catalog of brighter stars that were used to calibrate it.

CalibrateTask

Calibrate an exposure: measure sources and perform astrometric and photometric calibration.

CharacterizeImageTask

Measure bright sources and use this to estimate background and PSF of an exposure.

ConsolidateHealSparsePropertyMapTask

Task to consolidate HealSparse property maps.

ConsolidateSourceTableTask

Concatenate sourceTable list into a per-visit sourceTable_visit

ConsolidateVisitSummaryTask

Task to consolidate per-detector visit metadata.

DetectCoaddSourcesTask

Detect sources on a single filter coadd.

FinalizeCharacterizationTask

Run final characterization on exposures.

HealSparsePropertyMapTask

Task to compute Healsparse property maps.

HighResolutionHipsTask

Task for making high resolution HiPS images.

IsolatedStarAssociationTask

Associate sources into isolated star catalogs.

MakeWarpTask

Warp and optionally PSF-Match calexps onto an a common projection.

MeasureMergedCoaddSourcesTask

Deblend sources from main catalog in each coadd seperately and measure.

MergeDetectionsTask

Merge sources detected in coadds of exposures obtained with different filters.

MergeMeasurementsTask

Merge measurements from multiple bands.

NumberDeblendChildSourcesMetricTask

Task that computes the number of science sources created through deblending.

NumberDeblendedSourcesMetricTask

Task that computes the number of science sources that have been deblended.

TransformSourceTableTask

Transform/standardize a source catalog

WriteSourceTableTask

Write source table to DataFrame Parquet format.

Tasks

CoaddInputRecorderTask

Subtask that handles filling a CoaddInputs object for a coadd exposure, tracking the CCDs and visits that went into a coadd.

ComputeExposureSummaryStatsTask

Task to compute exposure summary statistics.

ExampleSigmaClippedStatsTask

Example task to compute sigma-clipped mean and standard deviation of an image.

ExampleSimpleStatsTask

Example task to compute mean and standard deviation of an image.

HealSparseInputMapTask

Task for making a HealSparse input map.

InterpImageTask

Interpolate over bad image pixels

LoadReferenceCatalogTask

Load multi-band reference objects from a reference catalog.

MakeDiscreteSkyMapTask

Make a DiscreteSkyMap in a repository, using the bounding box of a set of calexps.

MatchBackgroundsTask

Base class for data processing tasks.

MeasurePsfTask

A task that selects stars from a catalog of sources and uses those to measure the PSF.

PhotoCalTask

Calculate an Exposure's zero-point given a set of flux measurements of stars matched to an input catalogue.

PropagateSourceFlagsTask

Task to propagate source flags to coadd objects.

PropagateVisitFlagsTask

Task to propagate flags from single-frame measurements to coadd measurements.

PsfWcsSelectImagesTask

Select images using their Wcs and cuts on the PSF properties.

RegisterTask

Task to register (align) multiple images.

RepairTask

Repair an exposures defects and cosmic rays via interpolation.

ReserveIsolatedStarsTask

Reserve isolated stars with repeatable hash.

ScaleVarianceTask

Scale the variance in a MaskedImage

ScaleZeroPointTask

Compute scale factor to scale exposures to a desired photometric zero point.

SetPrimaryFlagsTask

Deprecated since version v27.0: This class has been moved to meas_algorithms. Will be removed after v27.

SnapCombineTask

Combine two snaps into a single visit image.

WarpAndPsfMatchTask

A task to warp and PSF-match an exposure

WcsSelectImagesTask

Select images using their Wcs.

Configurations

Colorterm

Colorterm correction for one pair of filters

ColortermDict

A mapping of physical filter label to Colorterm

ColortermLibrary

A mapping of photometric reference catalog name or glob to ColortermDict

CullPeaksConfig

Configuration for culling garbage peaks after merging footprints.

DatabaseSelectImagesConfig

Base configuration for subclasses of BaseSelectImagesTask that use a database.

Python API reference

lsst.pipe.tasks.associationUtils Module

Utilities for interfacing with hpgeom. Originally implemented in http://github.com/LSSTDESC/dia_pipe and then translated to hpgeom.

Functions

toIndex(nside, ra, dec)	Return healpix index given ra, dec in degrees
toRaDec(nside, index)	Convert from healpix index to ra,dec in degrees
eq2xyz(ra, dec)	Convert from equatorial ra,dec in degrees to x,y,z on unit sphere.
eq2xyzVec(ra, dec)	Convert equatorial ra,dec in degrees to x,y,z on the unit sphere parameters
convert_spherical(ra, dec)	Convert from ra,dec to spherical coordinates.
convert_spherical_array(array)	Convert from and a array ra,dec to spherical coordinates.
query_disc(nside, ra, dec, max_rad[, min_rad])	Get the list of healpix indices within max_rad, min_rad given in radians around ra,dec given in degrees

lsst.pipe.tasks.background Module

Classes

BackgroundConfig(*args, **kw)	Configuration for background measurement
FocalPlaneBackground(config, dims, transform)	Background model for a focal plane camera
FocalPlaneBackgroundConfig(*args, **kw)	Configuration for FocalPlaneBackground
MaskObjectsConfig(*args, **kw)	Configuration for MaskObjectsTask
MaskObjectsTask(*args, **kwargs)	Iterative masking of objects on an Exposure
SkyMeasurementConfig(*args, **kw)	Configuration for SkyMeasurementTask
SkyMeasurementTask([config, name, ...])	Task for creating, persisting and using sky frames
SkyStatsConfig(*args, **kw)	Parameters controlling the measurement of sky statistics

lsst.pipe.tasks.calexpCutout Module

Classes

CalexpCutoutTaskConfig(*args, **kw)	Configuration for CalexpCutoutTask
CalexpCutoutTask(*[, config, log, initInputs])	Task for computing cutouts on a specific calexp given positions, xspans, and yspans of the stamps.

lsst.pipe.tasks.calibrateImage Module

Classes

CalibrateImageConfig(*args, **kw)
CalibrateImageConnections(*[, config])
CalibrateImageTask([initial_stars_schema])	Compute the PSF, aperture corrections, astrometric and photometric calibrations, and summary statistics for a single science exposure, and produce a catalog of brighter stars that were used to calibrate it.

lsst.pipe.tasks.calibrate Module

Classes

CalibrateConfig(*args, **kw)	Config for CalibrateTask.
CalibrateTask([astromRefObjLoader, ...])	Calibrate an exposure: measure sources and perform astrometric and photometric calibration.

lsst.pipe.tasks.characterizeImage Module

Classes

CharacterizeImageConfig(*args, **kw)	Config for CharacterizeImageTask.
CharacterizeImageTask([schema])	Measure bright sources and use this to estimate background and PSF of an exposure.

lsst.pipe.tasks.coaddBase Module

Functions

makeSkyInfo(skyMap, tractId, patchId)

Constructs SkyInfo used by coaddition tasks for multiple patchId formats.

Classes

CoaddBaseTask(**kwargs)

Base class for coaddition.

lsst.pipe.tasks.coaddInputRecorder Module

Classes

CoaddInputRecorderTask(*args, **kwargs)

Subtask that handles filling a CoaddInputs object for a coadd exposure, tracking the CCDs and visits that went into a coadd.

lsst.pipe.tasks.colorterms Module

Classes

ColortermNotFoundError	Exception class indicating we couldn't find a colorterm
Colorterm(*args, **kw)	Colorterm correction for one pair of filters
ColortermDict(*args, **kw)	A mapping of physical filter label to Colorterm
ColortermLibrary(*args, **kw)	A mapping of photometric reference catalog name or glob to ColortermDict

lsst.pipe.tasks.computeExposureSummaryStats Module

Classes

ComputeExposureSummaryStatsTask(**kwargs)	Task to compute exposure summary statistics.
ComputeExposureSummaryStatsConfig(*args, **kw)	Config for ComputeExposureSummaryTask

lsst.pipe.tasks.cosmicRayPostDiff Module

Classes

CosmicRayPostDiffConfig(*args, **kw)	Config for CosmicRayPostDiffTask
CosmicRayPostDiffTask(**kwargs)	Detect and repair cosmic rays on an image difference. Given an output image from image differencing: - detect and repair cosmic rays - At the moment this task does NOT recompute the PSF or re-do source detection. To invoke the task, Call the run method.

lsst.pipe.tasks.deblendCoaddSourcesPipeline Module

Classes

DeblendCoaddSourcesSingleConfig(*args, **kw)
DeblendCoaddSourcesSingleTask(initInputs, ...)
DeblendCoaddSourcesMultiConfig(*args, **kw)
DeblendCoaddSourcesMultiTask(initInputs, ...)

lsst.pipe.tasks.diff_matched_tract_catalog Module

Classes

DiffMatchedTractCatalogConfig(*args, **kw)
DiffMatchedTractCatalogTask(*[, config, ...])	Load subsets of matched catalogs and output a merged catalog of matched sources.
MatchedCatalogFluxesConfig(*args, **kw)
MatchType(value[, names, module, qualname, ...])
MeasurementType(value[, names, module, ...])
SourceType(value[, names, module, qualname, ...])
Statistic()	A statistic that can be applied to a set of values.
Median()	The median of a set of values.
SigmaIQR()	The re-scaled interquartile range (sigma equivalent).
SigmaMAD()	The re-scaled median absolute deviation (sigma equivalent).
Percentile(percentile)	An arbitrary percentile.

lsst.pipe.tasks.drpAssociationPipe Module

Pipeline for running DiaSource association in a DRP context.

Classes

DrpAssociationPipeTask(**kwargs)	Driver pipeline for loading DiaSource catalogs in a patch/tract region and associating them.
DrpAssociationPipeConfig(*args, **kw)
DrpAssociationPipeConnections(*[, config])

lsst.pipe.tasks.drpDiaCalculationPipe Module

Pipeline for computing DiaObject summary/light curve values.

Classes

DrpDiaCalculationPipeTask(**kwargs)	Driver pipeline for loading DiaSource catalogs in a patch/tract region and associating them.
DrpDiaCalculationPipeConfig(*args, **kw)
DrpDiaCalculationPipeConnections(*[, config])

lsst.pipe.tasks.exampleStatsTasks Module

Classes

ExampleSigmaClippedStatsConfig(*args, **kw)	Configuration for ExampleSigmaClippedStatsTask
ExampleSigmaClippedStatsTask(*args, **kwargs)	Example task to compute sigma-clipped mean and standard deviation of an image.
ExampleSimpleStatsTask([config, name, ...])	Example task to compute mean and standard deviation of an image.

lsst.pipe.tasks.extended_psf Module

Read preprocessed bright stars and stack to build an extended PSF model.

Classes

FocalPlaneRegionExtendedPsf(...)	Single extended PSF over a focal plane region.
ExtendedPsf([default_extended_psf])	Extended PSF model.
StackBrightStarsConfig(*args, **kw)	Configuration parameters for StackBrightStarsTask.
StackBrightStarsTask([config, name, ...])	Stack bright stars together to build an extended PSF model.
MeasureExtendedPsfConfig(*args, **kw)	Configuration parameters for MeasureExtendedPsfTask.
MeasureExtendedPsfTask([initInputs])	Build and save extended PSF model.
DetectorsInRegion(*args, **kw)	Provides a list of detectors that define a region.

lsst.pipe.tasks.finalizeCharacterization Module

Task to run a finalized image characterization, using additional data.

Classes

FinalizeCharacterizationConnections(*[, config])
FinalizeCharacterizationConfig(*args, **kw)	Configuration for FinalizeCharacterizationTask.
FinalizeCharacterizationTask([initInputs])	Run final characterization on exposures.

lsst.pipe.tasks.fit_multiband Module

Classes

CatalogExposure(*, dataId, catalog, ...)

A class to store a catalog, exposure, and metadata for a given dataId.

lsst.pipe.tasks.functors Module

Functions

init_fromDict(initDict[, basePath, typeKey, ...])	Initialize an object defined in a dictionary.
mag_aware_eval(df, expr, log)	Evaluate an expression on a DataFrame, knowing what the 'mag' function means.
fluxName(col)	Append _instFlux to the column name if it doesn't have it already.
fluxErrName(col)	Append _instFluxErr to the column name if it doesn't have it already.

Classes

Functor([filt, dataset, noDup])	Define and execute a calculation on a DataFrame or Handle holding a DataFrame.
CompositeFunctor(funcs, **kwargs)	Perform multiple calculations at once on a catalog.
CustomFunctor(expr, **kwargs)	Arbitrary computation on a catalog.
Column(col, **kwargs)	Get column with a specified name.
Index([filt, dataset, noDup])	Return the value of the index for each object.
CoordColumn(col, **kwargs)	Base class for coordinate column, in degrees.
RAColumn(**kwargs)	Right Ascension, in degrees.
DecColumn(**kwargs)	Declination, in degrees.
HtmIndex20(ra, dec, **kwargs)	Compute the level 20 HtmIndex for the catalog.
Mag(col, **kwargs)	Compute calibrated magnitude.
MagErr(*args, **kwargs)	Compute calibrated magnitude uncertainty.
MagDiff(col1, col2, **kwargs)	Functor to calculate magnitude difference.
Color(col, filt2, filt1, **kwargs)	Compute the color between two filters.
DeconvolvedMoments([filt, dataset, noDup])	This functor subtracts the trace of the PSF second moments from the trace of the second moments of the source.
SdssTraceSize([filt, dataset, noDup])	Functor to calculate the SDSS trace radius size for sources.
PsfSdssTraceSizeDiff([filt, dataset, noDup])	Functor to calculate the SDSS trace radius size difference (%) between the object and the PSF model.
HsmTraceSize([filt, dataset, noDup])	Functor to calculate the HSM trace radius size for sources.
PsfHsmTraceSizeDiff([filt, dataset, noDup])	Functor to calculate the HSM trace radius size difference (%) between the object and the PSF model.
HsmFwhm([filt, dataset, noDup])	Functor to calculate the PSF FWHM with second moments measured from the HsmShapeAlgorithm plugin.
E1(colXX, colXY, colYY, **kwargs)	Calculate \(e_1\) ellipticity component for sources, defined as:
E2(colXX, colXY, colYY, **kwargs)	Calculate \(e_2\) ellipticity component for sources, defined as:
RadiusFromQuadrupole(colXX, colXY, colYY, ...)	Calculate the radius from the quadrupole moments.
LocalWcs(colCD_1_1, colCD_1_2, colCD_2_1, ...)	Computations using the stored localWcs.
ComputePixelScale(colCD_1_1, colCD_1_2, ...)	Compute the local pixel scale from the stored CDMatrix.
ConvertPixelToArcseconds(col, colCD_1_1, ...)	Convert a value in units of pixels to units of arcseconds.
ConvertPixelSqToArcsecondsSq(col, colCD_1_1, ...)	Convert a value in units of pixels squared to units of arcseconds squared.
ReferenceBand([filt, dataset, noDup])	Return the band used to seed multiband forced photometry.
Photometry(colFlux[, colFluxErr])	Base class for Object table calibrated fluxes and magnitudes.
NanoJansky(colFlux[, colFluxErr])	Convert instrumental flux to nanojanskys.
NanoJanskyErr(colFlux[, colFluxErr])	Convert instrumental flux error to nanojanskys.
LocalPhotometry(instFluxCol, instFluxErrCol, ...)	Base class for calibrating the specified instrument flux column using the local photometric calibration.
LocalNanojansky(instFluxCol, instFluxErrCol, ...)	Compute calibrated fluxes using the local calibration value.
LocalNanojanskyErr(instFluxCol, ...)	Compute calibrated flux errors using the local calibration value.
LocalDipoleMeanFlux(instFluxPosCol, ...)	Compute absolute mean of dipole fluxes.
LocalDipoleMeanFluxErr(instFluxPosCol, ...)	Compute the error on the absolute mean of dipole fluxes.
LocalDipoleDiffFlux(instFluxPosCol, ...)	Compute the absolute difference of dipole fluxes.
LocalDipoleDiffFluxErr(instFluxPosCol, ...)	Compute the error on the absolute difference of dipole fluxes.
Ebv(**kwargs)	Compute E(B-V) from dustmaps.sfd.

lsst.pipe.tasks.healSparseMapping Module

Classes

HealSparseInputMapTask(**kwargs)	Task for making a HealSparse input map.
HealSparseInputMapConfig(*args, **kw)	Configuration parameters for HealSparseInputMapTask
HealSparseMapFormatter(fileDescriptor, dataId)	Interface for reading and writing healsparse.HealSparseMap files.
HealSparsePropertyMapConnections(*[, config])
HealSparsePropertyMapConfig(*args, **kw)	Configuration parameters for HealSparsePropertyMapTask
HealSparsePropertyMapTask(**kwargs)	Task to compute Healsparse property maps.
ConsolidateHealSparsePropertyMapConnections(*)
ConsolidateHealSparsePropertyMapConfig(...)	Configuration parameters for ConsolidateHealSparsePropertyMapTask
ConsolidateHealSparsePropertyMapTask(**kwargs)	Task to consolidate HealSparse property maps.

lsst.pipe.tasks.healSparseMappingProperties Module

Functions

register_property_map(name)	A decorator to register a property map class in its base class's registry.
compute_approx_psf_size_and_shape(ccd_row, ...)	Compute the approximate psf size and shape.

Classes

BasePropertyMapConfig(*args, **kw)
PropertyMapRegistry([configBaseType])	Class for property map registry.
PropertyMapMap	Map of property maps to be run for a given task.
BasePropertyMap(config, name)	Base class for property maps.
ExposureTimePropertyMap(config, name)	Exposure time property map.
PsfSizePropertyMap(config, name)	PSF size property map.
PsfE1PropertyMap(config, name)	PSF shape e1 property map.
PsfE2PropertyMap(config, name)	PSF shape e2 property map.
NExposurePropertyMap(config, name)	Number of exposures property map.
PsfMaglimPropertyMapConfig(*args, **kw)	Configuration for the PsfMaglim property map.
PsfMaglimPropertyMap(config, name)	PSF magnitude limit property map.
SkyBackgroundPropertyMap(config, name)	Sky background property map.
SkyNoisePropertyMap(config, name)	Sky noise property map.
DcrDraPropertyMap(config, name)	Effect of DCR on delta-RA property map.
DcrDdecPropertyMap(config, name)	Effect of DCR on delta-Dec property map.
DcrE1PropertyMap(config, name)	Effect of DCR on psf shape e1 property map.
DcrE2PropertyMap(config, name)	Effect of DCR on psf shape e2 property map.
EpochPropertyMap(config, name)	Observation epoch (mjd) property map.

lsst.pipe.tasks.hips Module

Tasks for making and manipulating HIPS images.

Classes

HighResolutionHipsTask(**kwargs)	Task for making high resolution HiPS images.
HighResolutionHipsConfig(*args, **kw)	Configuration parameters for HighResolutionHipsTask.
HighResolutionHipsConnections(*[, config])
HighResolutionHipsQuantumGraphBuilder(...[, ...])	A custom a lsst.pipe.base.QuantumGraphBuilder for running HighResolutionHipsTask only.
GenerateHipsTask(*[, config, log, initInputs])	Task for making a HiPS tree with FITS and grayscale PNGs.
GenerateHipsConfig(*args, **kw)	Configuration parameters for GenerateHipsTask.
GenerateColorHipsTask(*[, config, log, ...])	Task for making a HiPS tree with color pngs.
GenerateColorHipsConfig(*args, **kw)	Configuration parameters for GenerateColorHipsTask.

lsst.pipe.tasks.insertFakes Module

Insert fakes into deepCoadds

Classes

InsertFakesConfig(*args, **kw)	Config for inserting fake sources
InsertFakesTask(*[, config, log, initInputs])	Insert fake objects into images.

lsst.pipe.tasks.interpImage Module

Classes

InterpImageConfig(*args, **kw)	Config for InterpImageTask
InterpImageTask([config, name, parentTask, log])	Interpolate over bad image pixels

lsst.pipe.tasks.isolatedStarAssociation Module

Classes

IsolatedStarAssociationConnections(*[, config])
IsolatedStarAssociationConfig(*args, **kw)	Configuration for IsolatedStarAssociationTask.
IsolatedStarAssociationTask(**kwargs)	Associate sources into isolated star catalogs.

lsst.pipe.tasks.loadReferenceCatalog Module

Load a full reference catalog in numpy/table/dataframe format.

This task will load multi-band reference objects, apply a reference selector, and apply color terms.

Classes

LoadReferenceCatalogConfig(*args, **kw)	Config for LoadReferenceCatalogTask
LoadReferenceCatalogTask(*, dataIds, ...)	Load multi-band reference objects from a reference catalog.

lsst.pipe.tasks.makeDiscreteSkyMap Module

Classes

MakeDiscreteSkyMapConfig(*args, **kw)	Config for MakeDiscreteSkyMapTask.
MakeDiscreteSkyMapTask([config, name, ...])	Make a DiscreteSkyMap in a repository, using the bounding box of a set of calexps.

lsst.pipe.tasks.makeWarp Module

Classes

MakeWarpTask(**kwargs)	Warp and optionally PSF-Match calexps onto an a common projection.
MakeWarpConfig(*args, **kw)	Config for MakeWarpTask.

lsst.pipe.tasks.matchBackgrounds Module

Classes

MatchBackgroundsConfig(*args, **kw)
MatchBackgroundsTask(*args, **kwargs)

lsst.pipe.tasks.matchFakes Module

Classes

MatchFakesTask(*[, config, log, initInputs])	Match a pre-existing catalog of fakes to a catalog of detections on a difference image.
MatchFakesConfig(*args, **kw)	Config for MatchFakesTask.
MatchVariableFakesConfig(*args, **kw)	Config for MatchFakesTask.
MatchVariableFakesTask(*[, config, log, ...])	Match injected fakes to their detected sources in the catalog and compute their expected brightness in a difference image assuming perfect subtraction.

lsst.pipe.tasks.match_tract_catalog Module

Classes

MatchTractCatalogSubConfig(*args, **kw)	Config class for the MatchTractCatalogSubTask to define methods returning values that depend on multiple config settings.
MatchTractCatalogSubTask(**kwargs)	An abstract interface for subtasks of MatchTractCatalogTask to match two tract object catalogs.
MatchTractCatalogConfig(*args, **kw)	Configure a MatchTractCatalogTask, including a configurable matching subtask.
MatchTractCatalogTask(initInputs, **kwargs)	Match sources in a reference tract catalog with those in a target catalog.

lsst.pipe.tasks.match_tract_catalog_probabilistic Module

Classes

MatchTractCatalogProbabilisticConfig(*args, **kw)	Config class for the MatchTractCatalogSubTask to define methods returning values that depend on multiple config settings.
MatchTractCatalogProbabilisticTask(**kwargs)	An abstract interface for subtasks of MatchTractCatalogTask to match two tract object catalogs.

lsst.pipe.tasks.measurePsf Module

Classes

MeasurePsfConfig(*args, **kw)
MeasurePsfTask([schema])	A task that selects stars from a catalog of sources and uses those to measure the PSF.

lsst.pipe.tasks.mergeDetections Module

Classes

MergeDetectionsConfig(*args, **kw)	Configuration parameters for the MergeDetectionsTask.
MergeDetectionsTask([schema, initInputs])	Merge sources detected in coadds of exposures obtained with different filters.

lsst.pipe.tasks.mergeMeasurements Module

Classes

MergeMeasurementsConfig(*args, **kw)	Configuration parameters for the MergeMeasurementsTask.
MergeMeasurementsTask([schema, initInputs])	Merge measurements from multiple bands.

lsst.pipe.tasks.metrics Module

Classes

NumberDeblendedSourcesMetricTask(**kwargs)	Task that computes the number of science sources that have been deblended.
NumberDeblendedSourcesMetricConfig(*args, **kw)
NumberDeblendChildSourcesMetricTask(**kwargs)	Task that computes the number of science sources created through deblending.
NumberDeblendChildSourcesMetricConfig(*args, ...)

lsst.pipe.tasks.multiBand Module

Classes

DetectCoaddSourcesConfig(*args, **kw)	Configuration parameters for the DetectCoaddSourcesTask
DetectCoaddSourcesTask([schema])	Detect sources on a single filter coadd.

lsst.pipe.tasks.multiBandUtils Module

Classes

CullPeaksConfig(*args, **kw)

Configuration for culling garbage peaks after merging footprints.

lsst.pipe.tasks.objectMasks Module

Classes

ObjectMaskCatalog()	Class to support bright object masks
RegionFileFormatter(fileDescriptor, dataId)	Plugin for reading DS9 region file catalogs with Gen3 Butler.

lsst.pipe.tasks.photoCal Module

Classes

PhotoCalTask([refObjLoader, schema])	Calculate an Exposure's zero-point given a set of flux measurements of stars matched to an input catalogue.
PhotoCalConfig(*args, **kw)	Config for PhotoCal.

lsst.pipe.tasks.postprocess Module

Classes

WriteObjectTableConfig(*args, **kw)
WriteObjectTableTask(*[, config, log, ...])	Write filter-merged source tables as a DataFrame in parquet format.
WriteSourceTableConfig(*args, **kw)
WriteSourceTableTask(*[, config, log, ...])	Write source table to DataFrame Parquet format.
WriteRecalibratedSourceTableConfig(*args, **kw)
WriteRecalibratedSourceTableTask(*[, ...])	Write source table to DataFrame Parquet format.
PostprocessAnalysis(handles, functors[, ...])	Calculate columns from DataFrames or handles storing DataFrames.
TransformCatalogBaseConfig(*args, **kw)
TransformCatalogBaseTask(*args, **kwargs)	Base class for transforming/standardizing a catalog by applying functors that convert units and apply calibrations.
TransformObjectCatalogConfig(*args, **kw)
TransformObjectCatalogTask(*args, **kwargs)	Produce a flattened Object Table to match the format specified in sdm_schemas.
ConsolidateObjectTableConfig(*args, **kw)
ConsolidateObjectTableTask(*[, config, log, ...])	Write patch-merged source tables to a tract-level DataFrame Parquet file.
TransformSourceTableConfig(*args, **kw)
TransformSourceTableTask(*args, **kwargs)	Transform/standardize a source catalog
ConsolidateVisitSummaryConfig(*args, **kw)	Config for ConsolidateVisitSummaryTask
ConsolidateVisitSummaryTask(**kwargs)	Task to consolidate per-detector visit metadata.
ConsolidateSourceTableConfig(*args, **kw)
ConsolidateSourceTableTask(*[, config, log, ...])	Concatenate sourceTable list into a per-visit sourceTable_visit
MakeCcdVisitTableConfig(*args, **kw)
MakeCcdVisitTableTask(*[, config, log, ...])	Produce a ccdVisitTable from the visit summary exposure catalogs.
MakeVisitTableConfig(*args, **kw)
MakeVisitTableTask(*[, config, log, initInputs])	Produce a visitTable from the visit summary exposure catalogs.
WriteForcedSourceTableConfig(*args, **kw)
WriteForcedSourceTableTask(*[, config, log, ...])	Merge and convert per-detector forced source catalogs to DataFrame Parquet format.
TransformForcedSourceTableConfig(*args, **kw)
TransformForcedSourceTableTask(*args, **kwargs)	Transform/standardize a ForcedSource catalog
ConsolidateTractConfig(*args, **kw)
ConsolidateTractTask(*[, config, log, ...])	Concatenate any per-patch, dataframe list into a single per-tract DataFrame.

lsst.pipe.tasks.processBrightStars Module

Extract bright star cutouts; normalize and warp to the same pixel grid.

Classes

ProcessBrightStarsConnections(*[, config])	Connections for ProcessBrightStarsTask.
ProcessBrightStarsConfig(*args, **kw)	Configuration parameters for ProcessBrightStarsTask.
ProcessBrightStarsTask([initInputs])	Extract bright star cutouts; normalize and warp to the same pixel grid.

lsst.pipe.tasks.processCcdWithFakes Module

Insert fake sources into calexps

Classes

ProcessCcdWithFakesConfig(*args, **kw)	Config for inserting fake sources
ProcessCcdWithFakesTask([schema])	Insert fake objects into calexps.
ProcessCcdWithVariableFakesConfig(*args, **kw)
ProcessCcdWithVariableFakesTask([schema])	As ProcessCcdWithFakes except add variablity to the fakes catalog magnitude in the observed band for this ccdVisit.

lsst.pipe.tasks.propagateSourceFlags Module

Classes

PropagateSourceFlagsConfig(*args, **kw)	Configuration for propagating source flags to coadd objects.
PropagateSourceFlagsTask(schema, **kwargs)	Task to propagate source flags to coadd objects.

lsst.pipe.tasks.propagateVisitFlags Module

Classes

PropagateVisitFlagsConfig(*args, **kw)	Configuration for propagating flags to coadd.
PropagateVisitFlagsTask(*args, **kwargs)	Task to propagate flags from single-frame measurements to coadd measurements.

lsst.pipe.tasks.quickFrameMeasurement Module

Classes

QuickFrameMeasurementTaskConfig(*args, **kw)	Config class for the QuickFrameMeasurementTask.
QuickFrameMeasurementTask(config, *[, display])	WARNING: An experimental new task with changable API! Do not rely on yet!

lsst.pipe.tasks.read_curated_calibs Module

Functions

read_all(root, camera)

Read all data from the standard format at a particular root.

lsst.pipe.tasks.registerImage Module

This module contains a Task to register (align) multiple images.

Classes

RegisterTask([config, name, parentTask, log])	Task to register (align) multiple images.
RegisterConfig(*args, **kw)	Configuration for RegisterTask.

lsst.pipe.tasks.repair Module

Classes

RepairConfig(*args, **kw)
RepairTask(**kwargs)	Repair an exposures defects and cosmic rays via interpolation.

lsst.pipe.tasks.reserveIsolatedStars Module

Task to make a flexible and repeatable selection of reserve stars.

Classes

ReserveIsolatedStarsConfig(*args, **kw)	Configuration for ReserveIsolatedStarsTask.
ReserveIsolatedStarsTask([config, name, ...])	Reserve isolated stars with repeatable hash.

lsst.pipe.tasks.scaleZeroPoint Module

Classes

ImageScaler([scale])	A class that scales an image.
SpatialImageScaler(interpStyle, xList, ...)	Multiplicative image scaler using interpolation over a grid of points.
ScaleZeroPointTask(*args, **kwargs)	Compute scale factor to scale exposures to a desired photometric zero point.

lsst.pipe.tasks.selectImages Module

Classes

BaseSelectImagesTask([config, name, ...])	Base task for selecting images suitable for coaddition.
BaseExposureInfo(dataId, coordList)	Data about a selected exposure.
WcsSelectImagesTask([config, name, ...])	Select images using their Wcs.
PsfWcsSelectImagesTask([config, name, ...])	Select images using their Wcs and cuts on the PSF properties.
DatabaseSelectImagesConfig(*args, **kw)	Base configuration for subclasses of BaseSelectImagesTask that use a database.
BestSeeingSelectVisitsTask(*[, config, log, ...])	Select up to a maximum number of the best-seeing visits.
BestSeeingQuantileSelectVisitsTask(*[, ...])	Select a quantile of the best-seeing visits.

lsst.pipe.tasks.setPrimaryFlags Module

Classes

SetPrimaryFlagsConfig(*args, **kwargs)	Deprecated since version v27.0.
SetPrimaryFlagsTask(*args, **kwargs)	Deprecated since version v27.0.

lsst.pipe.tasks.simpleAssociation Module

Simple association algorithm for DRP. Adapted from http://github.com/LSSTDESC/dia_pipe

Classes

SimpleAssociationConfig(*args, **kw)	Configuration parameters for the SimpleAssociationTask
SimpleAssociationTask([config, name, ...])	Construct DiaObjects from a DataFrame of DIASources by spatially associating the sources.

lsst.pipe.tasks.skyCorrection Module

Classes

SkyCorrectionTask(*args, **kwargs)	Perform a full focal plane sky correction.
SkyCorrectionConfig(*args, **kw)

lsst.pipe.tasks.snapCombine Module

Classes

SnapCombineConfig(*args, **kw)
SnapCombineTask(*args, **kwargs)	Combine two snaps into a single visit image.

lsst.pipe.tasks.statistic Module

Classes

Statistic()	Compute a statistic from a list of values.
Count()
Median()
Percentile(percentile)	An arbitrary percentile.
StandardDeviation()	The standard deviation (sigma).
SigmaIQR()	The re-scaled inter-quartile range (sigma equivalent).
SigmaMAD()	The re-scaled median absolute deviation (sigma equivalent).

lsst.pipe.tasks.visualizeVisit Module

Classes

VisualizeBinExpConfig(*args, **kw)	Configuration for focal plane visualization.
VisualizeBinExpTask(*[, config, log, initInputs])	Bin the detectors of an exposure.
VisualizeMosaicExpConfig(*args, **kw)	Configuration for focal plane visualization.
VisualizeMosaicExpTask(*[, config, log, ...])	Task to mosaic binned products.

lsst.pipe.tasks.warpAndPsfMatch Module

Classes

WarpAndPsfMatchTask(*args, **kwargs)

A task to warp and PSF-match an exposure