lsst.meas.algorithms¶
The lsst.meas.algorithms
module provides a variety of astronomical measurement algorithms.
LSST Reference Catalogs¶
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 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¶
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 |
|
AstrometrySourceSelectorTask (*args, **kwargs) |
Select sources that are useful for astrometry. |
BasePsfDeterminerConfig |
Configuration that is likely to be shared by all PSF determiners |
BasePsfDeterminerTask (config[, schema]) |
Base class for PSF determiners |
BaseSourceSelectorConfig |
|
BaseSourceSelectorTask (**kwargs) |
Base class for source selectors |
BaseStarSelectorConfig |
|
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 |
|
CoaddPsfControl |
|
ColorLimit |
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 |
|
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 |
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 |
Configuration for DynamicDetectionTask |
DynamicDetectionTask (*args, **kwargs) |
Detection of sources on an image with a dynamic threshold |
FindCosmicRaysConfig |
Config for the findCosmicRays function |
FlaggedSourceSelectorConfig |
|
FlaggedSourceSelectorTask (**kwargs) |
A trivial SourceSelector that simply uses an existing flag field to filter a SourceCatalog. |
GaussianPsfFactory |
Factory for simple Gaussian PSF models |
ImageCurve (wavelength, efficiency, metadata) |
|
ImagePsf |
|
IngestIndexedReferenceConfig |
For gen2 backwards compatibility. |
IngestIndexedReferenceTask (*args[, butler]) |
Class for producing and loading indexed reference catalogs (gen2 version). |
KernelPsf |
|
LoadIndexedReferenceObjectsConfig |
|
LoadIndexedReferenceObjectsTask (butler, …) |
Load reference objects from an indexed catalog ingested by IngestIndexReferenceTask. |
LoadReferenceObjectsConfig |
|
LoadReferenceObjectsTask ([butler]) |
Abstract base class to load objects from reference catalogs. |
MagnitudeErrorLimit |
Select sources using a magnitude error limit |
MagnitudeLimit |
Select sources using a magnitude limit |
MakePsfCandidatesConfig |
|
MakePsfCandidatesTask (**kwds) |
Create PSF candidates given an input catalog. |
MatcherSourceSelectorConfig |
|
MatcherSourceSelectorTask (*args, **kwargs) |
Select sources that are useful for matching. |
MeasureApCorrConfig |
Configuration for MeasureApCorrTask |
MeasureApCorrTask (schema, **kwds) |
Task to measure aperture correction |
ObjectSizeStarSelectorConfig |
|
ObjectSizeStarSelectorTask (**kwargs) |
A star selector that looks for a cluster of small objects in a size-magnitude plot. |
PcaPsf |
|
PcaPsfDeterminerConfig |
|
PcaPsfDeterminerTask (config[, schema]) |
A measurePsfTask psf estimator. |
PsfCandidateF |
|
ReadFitsCatalogConfig |
|
ReadFitsCatalogTask ([config, name, …]) |
Read an object catalog from a FITS table |
ReadTextCatalogConfig |
|
ReadTextCatalogTask ([config, name, …]) |
Read an object catalog from a text file |
ReferenceObjectLoader (dataIds, refCats, config) |
This class facilitates loading reference catalogs with gen 3 middleware |
ReferenceSourceSelectorConfig |
|
ReferenceSourceSelectorTask (**kwargs) |
Reference source selector |
RequireFlags |
Select sources using flags |
RequireUnresolved |
Select sources using star/galaxy separation |
ReserveSourcesConfig |
Configuration for reserving sources |
ReserveSourcesTask ([columnName, schema, doc]) |
Reserve sources from analysis |
ScienceSourceSelectorConfig |
Configuration for selecting science sources |
ScienceSourceSelectorTask (**kwargs) |
Science source selector |
SignalToNoiseLimit |
Select sources using a flux signal-to-noise limit |
SingleGaussianPsf |
|
SkyObjectsConfig |
Configuration for generating sky objects |
SkyObjectsTask ([config, name, parentTask, log]) |
Generate a list of Footprints of sky objects. |
SourceDetectionConfig |
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 |
Config for SubtractBackgroundTask |
SubtractBackgroundTask ([config, name, …]) |
Subtract the background from an exposure |
WarpedPsf |