lsst.ip_diffim¶

Python API reference¶

lsst.ip.diffim Package¶

Functions¶

`backgroundSubtract`(config, maskedImages)
`convolveAndSubtract`(args, *kwargs)	Overloaded function.
`generateAlardLuptonBasisList`(config[, …])	Generate an Alard-Lupton kernel basis based upon the Config and the input FWHM of the science and template images
`makeAlardLuptonBasisList`(halfWidth, nGauss, …)
`makeAssessSpatialKernelVisitor`(…)
`makeBuildSingleKernelVisitor`(args, *kwargs)	Overloaded function.
`makeBuildSpatialKernelVisitor`(basisList, …)
`makeCentralDifferenceMatrix`(width, height, …)
`makeDeltaFunctionBasisList`(width, height)
`makeForwardDifferenceMatrix`(width, height, …)
`makeKernelBasisList`(config[, targetFwhmPix, …])	Generate the appropriate Kernel basis based on the Config
`makeKernelCandidate`(args, *kwargs)	Overloaded function.
`makeKernelPcaVisitor`(imagePca)
`makeKernelSumVisitor`(policy)
`makeRegularizationMatrix`(policy)
`parseOptions`()	Parse the command line options.
`renormalizeKernelList`(kernelListIn)
`sourceToFootprintList`(candidateInList, …)	Takes an input list of Sources that were selected to constrain the Psf-matching Kernel and turns them into a List of Footprints, which are used to seed a set of KernelCandidates.
`writeKernelCellSet`(kernelCellSet, …)

Classes¶

`AssessSpatialKernelVisitorF`
`BuildSingleKernelVisitorF`
`BuildSpatialKernelVisitorF`
`ClassificationDipoleConfig`	Configuration for classification of detected diaSources as dipole or not
`ClassificationDipolePlugin`(config, name, …)	A plugin to classify whether a diaSource is a dipole.
`DecorrelateALKernelConfig`	!
`DecorrelateALKernelMapReduceConfig`	Configuration parameters for the ImageMapReduceTask to direct it to use DecorrelateALKernelMapper as its mapper for A&L decorrelation.
`DecorrelateALKernelMapper`(args, *kwargs)	Task to be used as an ImageMapper for performing A&L decorrelation on subimages on a grid across a A&L difference image.
`DecorrelateALKernelSpatialConfig`	Configuration parameters for the DecorrelateALKernelSpatialTask.
`DecorrelateALKernelSpatialTask`(args, *kwargs)	!
`DecorrelateALKernelTask`(args, *kwargs)	!
`DetectionConfig`	!Configuration for detecting sources on images for building a PSF-matching kernel
`DiaCatalogSourceSelectorConfig`
`DiaCatalogSourceSelectorTask`(**kwargs)	!Select sources for Kernel candidates
`DiaSourceAnalyst`(config)
`DiaSourceAnalystConfig`
`DipoleAnalysis`()	!Functor class that provides (S/N, position, orientation) of measured dipoles
`DipoleCentroidControl`
`DipoleDeblender`()	!Functor to deblend a source as a dipole, and return a new source with deblended footprints.
`DipoleFitPlugin`(config, name, schema, metadata)	!Subclass of SingleFramePlugin which fits dipoles to all merged (two-peak) diaSources
`DipoleFitPluginConfig`	!Configuration for DipoleFitPlugin
`DipoleFitTask`(schema[, algMetadata])	!Subclass of SingleFrameMeasurementTask which accepts up to three input images in its run() method.
`DipoleFitTaskConfig`	!Measurement of detected diaSources as dipoles
`DipoleFluxControl`
`DipoleMeasurementConfig`	!Measurement of detected diaSources as dipoles
`DipoleMeasurementTask`(schema[, algMetadata])	!
`FindSetBitsU`
`GetCalexpAsTemplateConfig`
`GetCalexpAsTemplateTask`([config, name, …])	Subtask to retrieve calexp of the same ccd number as the science image SensorRef for use as an image difference template.
`GetCoaddAsTemplateConfig`
`GetCoaddAsTemplateTask`([config, name, …])	Subtask to retrieve coadd for use as an image difference template.
`ImageMapReduceConfig`	Configuration parameters for the ImageMapReduceTask
`ImageMapReduceTask`(args, *kwargs)	Split an Exposure into subExposures (optionally on a grid) and perform the same operation on each.
`ImageMapper`([config, name, parentTask, log])	Abstract base class for any task that is to be used as `ImageMapReduceConfig.mapper`.
`ImageMapperConfig`	Configuration parameters for ImageMapper
`ImagePsfMatchConfig`	!Configuration for image-to-image Psf matching
`ImagePsfMatchTask`(args, *kwargs)	!
`ImageReducer`([config, name, parentTask, log])	Base class for any ‘reduce’ task that is to be used as `ImageMapReduceConfig.reducer`.
`ImageReducerConfig`	Configuration parameters for the ImageReducer
`ImageStatisticsD`
`ImageStatisticsF`
`ImageStatisticsI`
`KernelCandidateDetectionF`
`KernelCandidateF`
`KernelCandidateQa`(nKernelSpatial)	Quality Assessment class for Kernel Candidates
`KernelPcaD`
`KernelPcaVisitorF`
`KernelSolution`
`KernelSumVisitorF`
`MaskedKernelSolutionF`
`ModelPsfMatchConfig`	!Configuration for model-to-model Psf matching
`ModelPsfMatchTask`(args, *kwargs)	!
`NaiveDipoleCentroid`
`NaiveDipoleFlux`
`NbasisEvaluator`(psfMatchConfig, …)	A functor to evaluate the Bayesian Information Criterion for the number of basis sets going into the kernel fitting
`PsfDipoleFlux`
`PsfDipoleFluxControl`
`PsfMatchConfig`	!Base configuration for Psf-matching
`PsfMatchConfigAL`	!The parameters specific to the “Alard-Lupton” (sum-of-Gaussian) Psf-matching basis
`PsfMatchConfigDF`	!The parameters specific to the delta-function (one basis per-pixel) Psf-matching basis
`PsfMatchTask`(args, *kwargs)	!
`RegularizedKernelSolutionF`
`SnapPsfMatchConfig`
`SnapPsfMatchConfigAL`	Sum-of-Gaussian (Alard-Lupton) Psf-matching config optimized for snap subtraction
`SnapPsfMatchConfigDF`	Delta-function Psf-matching config optimized for snap subtraction
`SnapPsfMatchTask`(args, *kwargs)	!
`SourceFlagChecker`(sources[, badFlags])	!Functor class to check whether a diaSource has flags set that should cause it to be labeled bad.
`SpatialKernelSolution`
`StaticKernelSolutionF`
`ZogyConfig`	Configuration parameters for the ZogyTask
`ZogyImagePsfMatchConfig`	Config for the ZogyImagePsfMatchTask
`ZogyImagePsfMatchTask`(args, *kwargs)	Task to perform Zogy PSF matching and image subtraction.
`ZogyMapReduceConfig`	Config to be passed to ImageMapReduceTask
`ZogyMapper`(args, *kwargs)	Task to be used as an ImageMapper for performing ZOGY image subtraction on a grid of subimages.
`ZogyTask`([templateExposure, …])	Task to perform ZOGY proper image subtraction.

Class Inheritance Diagram¶