lsst.meas.algorithms

The lsst.meas.algorithms module provides a variety of astronomical measurement algorithms.

LSST Reference Catalogs

• How to generate an LSST reference catalog

Task reference

Tasks

BasePsfDeterminerTask

Base class for PSF determiners

ConvertReferenceCatalogTask

Class for producing HTM-indexed reference catalogs from external catalog data.

DynamicDetectionTask

Detection of sources on an image with a dynamic threshold

FlaggedSourceSelectorTask

A trivial SourceSelector that simply uses an existing flag field to filter a SourceCatalog.

InstallGaussianPsfTask

Install a Gaussian PSF model in an exposure.

LoadIndexedReferenceObjectsTask

Load reference objects from an indexed catalog ingested by IngestIndexReferenceTask.

LoadReferenceObjectsTask

Abstract gen2 base class to load objects from reference catalogs.

MakePsfCandidatesTask

Create PSF candidates given an input catalog.

MatcherSourceSelectorTask

Select sources that are useful for matching.

MeasureApCorrTask

Task to measure aperture correction

ObjectSizeStarSelectorTask

A star selector that looks for a cluster of small objects in a size-magnitude plot.

PcaPsfDeterminerTask

A measurePsfTask psf estimator.

ReadFitsCatalogTask

Read an object catalog from a FITS table

ReadTextCatalogTask

Read an object catalog from a text file

ReferenceSourceSelectorTask

Reference source selector

ReserveSourcesTask

Reserve sources from analysis

ScienceSourceSelectorTask

Science source selector

SkyObjectsTask

Generate a list of Footprints of sky objects.

SourceDetectionTask

Create the detection task. Most arguments are simply passed onto pipe.base.Task.

SubtractBackgroundTask

Subtract the background from an exposure

Command-line tasks

No topics.

Script reference

• convertReferenceCatalog

Contributing

lsst.meas.algorithms is developed at https://github.com/lsst/meas_algorithms. You can find Jira issues for this module under the meas_algorithms component.

Python API reference

lsst.meas.algorithms Package

Functions

addExposures(exposureList)	Add a set of exposures together.
countPsfCandidates(psfCells[, nStarPerCell])
createKernelFromPsfCandidates(psfCells, ...)
findCosmicRays(image, psf, bkgd, policy[, keep])
fitKernelParamsToImage(kernel, image, pos)
fitKernelToImage(kernel, image, pos)
fitSpatialKernelFromPsfCandidates(*args, ...)	Overloaded function.
generateSkyObjects(mask, seed, config)	Generate a list of Footprints of sky objects
getRefFluxField(schema, filterName)	Get the name of a flux field from a schema.
getRefFluxKeys(schema, filterName)	Return keys for flux and flux error.
interpolateOverDefects(image, psf, badList)
makeCoaddApCorrMap(catalog, coaddBox, coaddWcs)	Construct an ApCorrMap for a coadd
makeCoaddTransmissionCurve(coaddWcs, ...)
makePsfCandidate(source, image)
readFitsWithOptions(filename, stamp_factory, ...)	Read stamps from FITS file, allowing for only a subregion of the stamps to be read.
subtractPsf(psf, data, x, y[, psfFlux])
writeFits(filename, stamps, metadata, ...[, ...])	Write a single FITS file containing all stamps.

Classes

AccumulatorMeanStack(shape, bit_mask_value)	Stack masked images.
AmpCurve(amp_name_list, wavelength, ...)	Subclass of Curve that represents a curve per amp.
AstrometrySourceSelectorConfig(*args, **kw)
AstrometrySourceSelectorTask(*args, **kwargs)	Select sources that are useful for astrometry.
BasePsfDeterminerConfig(*args, **kw)	Configuration that is likely to be shared by all PSF determiners
BasePsfDeterminerTask(config[, schema])	Base class for PSF determiners
BaseSourceSelectorConfig(*args, **kw)
BaseSourceSelectorTask(**kwargs)	Base class for source selectors
BaseStarSelectorConfig(*args, **kw)
BaseStarSelectorTask(schema, **kwds)	Base class for star selectors
BrightStarStamp(stamp_im, gaiaGMag, gaiaId, ...)	Single stamp centered on a bright star, normalized by its annularFlux.
BrightStarStamps(starStamps[, innerRadius, ...])	Collection of bright star stamps and associated metadata.
CoaddBoundedField
CoaddBoundedFieldElement
CoaddPsf
CoaddPsfConfig(*args, **kw)
CoaddPsfControl
ColorLimit(*args, **kw)	Select sources using a color limit
ConvertGaiaManager(filenames, config, ...)	Special-case convert manager to deal with Gaia fluxes.
ConvertRefcatManager(filenames, config, ...)	Convert a reference catalog from external files into the LSST HTM sharded format, using a multiprocessing Pool to speed up the work.
ConvertReferenceCatalogBase(*args, **kwargs)	Base class for producing and loading indexed reference catalogs, shared between gen2 and gen3.
ConvertReferenceCatalogConfig(*args, **kw)
ConvertReferenceCatalogTask(*[, output_dir])	Class for producing HTM-indexed reference catalogs from external catalog data.
Curve(wavelength, efficiency, metadata)	An abstract class to represent an arbitrary curve with interpolation.
DatasetConfig(*args, **kw)	The description of the on-disk storage format for the persisted reference catalog.
Defect
DetectorCurve(wavelength, efficiency, metadata)	Subclass of Curve that represents a single curve per detector.
DoubleGaussianPsf
DynamicDetectionConfig(*args, **kw)	Configuration for DynamicDetectionTask
DynamicDetectionTask(*args, **kwargs)	Detection of sources on an image with a dynamic threshold
FindCosmicRaysConfig(*args, **kw)	Config for the findCosmicRays function
FlaggedSourceSelectorConfig(*args, **kw)
FlaggedSourceSelectorTask(**kwargs)	A trivial SourceSelector that simply uses an existing flag field to filter a SourceCatalog.
GaussianPsfFactory(*args, **kw)	Factory for simple Gaussian PSF models
ImageCurve(wavelength, efficiency, metadata)
ImagePsf
IngestIndexedReferenceConfig(*args, **kw)	For gen2 backwards compatibility.
IngestIndexedReferenceTask(*args[, butler])	Class for producing and loading indexed reference catalogs (gen2 version).
KernelPsf
LoadIndexedReferenceObjectsConfig(*args, **kw)
LoadIndexedReferenceObjectsTask(butler, ...)	Load reference objects from an indexed catalog ingested by IngestIndexReferenceTask.
LoadReferenceObjectsConfig(*args, **kw)
LoadReferenceObjectsTask([butler])	Abstract gen2 base class to load objects from reference catalogs.
MagnitudeErrorLimit(*args, **kw)	Select sources using a magnitude error limit
MagnitudeLimit(*args, **kw)	Select sources using a magnitude limit
MakePsfCandidatesConfig(*args, **kw)
MakePsfCandidatesTask(**kwds)	Create PSF candidates given an input catalog.
MatcherSourceSelectorConfig(*args, **kw)
MatcherSourceSelectorTask(*args, **kwargs)	Select sources that are useful for matching.
MeasureApCorrConfig(*args, **kw)	Configuration for MeasureApCorrTask
MeasureApCorrTask(schema, **kwds)	Task to measure aperture correction
ObjectSizeStarSelectorConfig(*args, **kw)
ObjectSizeStarSelectorTask(**kwargs)	A star selector that looks for a cluster of small objects in a size-magnitude plot.
PcaPsf
PcaPsfDeterminerConfig(*args, **kw)
PcaPsfDeterminerTask(config[, schema])	A measurePsfTask psf estimator.
PsfCandidateF
ReadFitsCatalogConfig(*args, **kw)
ReadFitsCatalogTask([config, name, ...])	Read an object catalog from a FITS table
ReadTextCatalogConfig(*args, **kw)
ReadTextCatalogTask([config, name, ...])	Read an object catalog from a text file
ReferenceObjectLoader(dataIds, refCats[, ...])	This class facilitates loading reference catalogs with gen 3 middleware.
ReferenceObjectLoaderBase([config])	Base class for reference object loaders, to facilitate gen2/gen3 code sharing.
ReferenceSourceSelectorConfig(*args, **kw)
ReferenceSourceSelectorTask(**kwargs)	Reference source selector
RequireFlags(*args, **kw)	Select sources using flags
RequireUnresolved(*args, **kw)	Select sources using star/galaxy separation
ReserveSourcesConfig(*args, **kw)	Configuration for reserving sources
ReserveSourcesTask([columnName, schema, doc])	Reserve sources from analysis
ScaleVarianceConfig(*args, **kw)
ScaleVarianceTask(*args, **kwargs)	Scale the variance in a MaskedImage
ScienceSourceSelectorConfig(*args, **kw)	Configuration for selecting science sources
ScienceSourceSelectorTask(**kwargs)	Science source selector
SignalToNoiseLimit(*args, **kw)	Select sources using a flux signal-to-noise limit
SingleGaussianPsf
SkyObjectsConfig(*args, **kw)	Configuration for generating sky objects
SkyObjectsTask([config, name, parentTask, log])	Generate a list of Footprints of sky objects.
SourceDetectionConfig(*args, **kw)	Configuration parameters for the SourceDetectionTask
SourceDetectionTask([schema])	Create the detection task.
Stamp(stamp_im[, archive_element, position])	Single stamp
Stamps(stamps[, metadata, use_mask, ...])
StampsBase(stamps[, metadata, use_mask, ...])	Collection of stamps and associated metadata.
SubtractBackgroundConfig(*args, **kw)	Config for SubtractBackgroundTask
SubtractBackgroundTask([config, name, ...])	Subtract the background from an exposure
WarpedPsf