lsst.meas.base¶
lsst.meas.base provides core astronomical measurement algorithms and base classes.
Using lsst.meas.base¶
Contributing¶
lsst.meas.base is developed at https://github.com/lsst/meas_base.
You can find Jira issues for this module under the meas_base component.
Task reference¶
Pipeline tasks¶
- ForcedPhotCcdTask
- A pipeline task for performing forced measurement on CCD images. 
Tasks¶
- ApplyApCorrTask
- Apply aperture corrections. 
- BaseMeasurementTask
- Ultimate base class for all measurement tasks. 
- CatalogCalculationTask
- Run plugins which operate on a catalog of sources. 
- ForcedMeasurementTask
- Measure sources on an image, constrained by a reference catalog. 
- SingleFrameMeasurementTask
- A subtask for measuring the properties of sources on a single exposure. 
Configs¶
- BaseMeasurementPluginConfig
- Base config class for all measurement plugins. 
- BasePluginConfig
- Base class measurement plugin config classes. 
- CatalogCalculationClassificationConfig
- Configuration for catalog classification plugin. 
- CatalogCalculationFootprintAreaConfig
- Configuration for footprint area catalog calculation plugin. 
- CatalogCalculationPluginConfig
- Default configuration class for catalog calcuation plugins. 
- ForcedPluginConfig
- Base class for configs of forced measurement plugins. 
- NoiseReplacerConfig
- Noise replacement configuration. 
- SingleFramePluginConfig
- Base class for single-frame plugin configuration classes. 
- SourceSlotConfig
- Assign named plugins to measurement slots. 
Python API reference¶
lsst.meas.base Package¶
Functions¶
| 
 | Register an instrumental flux field name prefix for aperture correction. | 
| 
 | Generate a name for an algorithm. | 
| Get a copy of the field name prefixes which will be aperture corrected. | |
| 
 | |
| 
 | A decorator to register a plugin class in its base class's registry. | 
| 
 | Wrap a C++ algorithm class to create a measurement plugin. | 
| 
 | Wrap a C++ algorithm's control class into a Python config class. | 
| 
 | Expose a C++  | 
| 
 | Expose a C++  | 
| 
 | Expose a C++  | 
| 
 | Modify a C++ transform to accept either a  | 
Classes¶
| 
 | |
| 
 | Aperture correction configuration. | 
| 
 | Apply aperture corrections. | 
| 
 | Base class for configuration of  | 
| 
 | Base configuration for all measurement driver tasks. | 
| 
 | Base class for all measurement plugins. | 
| 
 | Base config class for all measurement plugins. | 
| 
 | Ultimate base class for all measurement tasks. | 
| 
 | Base class for measurement plugins. | 
| 
 | Base class measurement plugin config classes. | 
| Configuration for catalog classification plugin. | |
| Plugin which calculates a binary measure of source extendedness. | |
| 
 | Config class for the catalog calculation driver task. | 
| 
 | Configuration for footprint area catalog calculation plugin. | 
| Catalog calculation plugin to record the area of a source's footprint. | |
| 
 | Base class for catalog calculation plugins. | 
| 
 | Default configuration class for catalog calcuation plugins. | 
| 
 | Run plugins which operate on a catalog of sources. | 
| 
 | Compute chi2 of diaSource fluxes. | 
| 
 | |
| 
 | Configuration class for generating integer IDs from  | 
| 
 | Configuration class for generating integer IDs from  | 
| 
 | Config class for the catalog calculation driver task. | 
| 
 | Base class for DIA catalog calculation plugins. | 
| 
 | Default configuration class for DIA catalog calculation plugins. | 
| 
 | Run plugins which operate on a catalog of DIA sources. | 
| A noise replacer which does nothing. | |
| 
 | Compute the mean of the dia source errors. | 
| 
 | |
| 
 | Evaluate the local value of the Photometric Calibration in the exposure. | 
| 
 | Configuration for the variance calculation plugin. | 
| 
 | Evaluate the local, linear approximation of the Wcs. | 
| 
 | Configuration for the variance calculation plugin. | 
| alias of  | |
| 
 | Config class for forced measurement driver task. | 
| 
 | Measure sources on an image, constrained by a reference catalog. | 
| 
 | Configuration for the forced peak centroid algorithm. | 
| 
 | Record the highest peak in a source footprint as its centroid. | 
| 
 | Config class for forced measurement driver task. | 
| 
 | |
| 
 | Force Photometry on a per-detector exposure with coords from a DataFrame | 
| 
 | A pipeline task for performing forced measurement on CCD images. | 
| 
 | Base class for forced measurement plugins. | 
| 
 | Base class for configs of forced measurement plugins. | 
| 
 | Configuration for the forced transformed centroid algorithm. | 
| Configuration for the forced transformed coord algorithm. | |
| Record the transformation of the reference catalog coord. | |
| 
 | Record the transformation of the reference catalog centroid. | 
| 
 | Configuration for the forced transformed shape algorithm. | 
| 
 | Record the transformation of the reference catalog shape. | 
| alias of  | |
| 
 | The subclass of  | 
| 
 | |
| 
 | Abstract base class for a generic plugin. | 
| 
 | Compute the mean position of a DiaObject given a set of DiaSources. | 
| 
 | |
| A helper class for packing some combination of a data ID, a per-data-ID counter, and a release ID into a single 64-bit integer. | |
| 
 | Configuration for the input image counting plugin. | 
| 
 | Compute fit a linear model to flux vs time. | 
| 
 | |
| 
 | |
| 
 | Compute median absolute deviation of diaSource fluxes. | 
| 
 | |
| 
 | Compute the maximum ratio time ordered deltaFlux / deltaTime. | 
| 
 | |
| 
 | Compute the mean position of a DiaObject given a set of DiaSources. | 
| 
 | |
| 
 | Base class for measurement transformations. | 
| 
 | Compute min/max of diaSource fluxes. | 
| 
 | |
| 
 | |
| 
 | Replace sources with noise during measurement. | 
| 
 | Noise replacement configuration. | 
| 
 | Null transform which transfers no data from input to output. | 
| 
 | Compute the total number of DiaSources associated with this DiaObject. | 
| 
 | |
| 
 | Copy fields from input to output without transformation. | 
| 
 | |
| 
 | Compute percentiles of diaSource fluxes. | 
| 
 | |
| Map of plugins to be run for a given task. | |
| 
 | Base class for plugin registries. | 
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | Compute scatter of diaSource fluxes. | 
| 
 | |
| 
 | Compute scatter of diaSource fluxes. | 
| 
 | |
| 
 | Transform pixel centroid, without uncertainty, to celestial coordinates. | 
| 
 | Find if any DiaSource is flagged. | 
| 
 | |
| 
 | Configuration for the focal plane position measurment algorithm. | 
| 
 | Algorithm to calculate the position of a centroid on the focal plane. | 
| alias of  | |
| 
 | Configuration for the Jacobian calculation plugin. | 
| 
 | Compute the Jacobian and its ratio with a nominal pixel area. | 
| 
 | Config class for single frame measurement driver task. | 
| 
 | A subtask for measuring the properties of sources on a single exposure. | 
| 
 | Configuration for moments-based star-galaxy classifier. | 
| 
 | Classify objects by comparing their moments-based trace radius to PSF's. | 
| 
 | Configuration for the single frame peak centroiding algorithm. | 
| 
 | Record the highest peak in a source footprint as its centroid. | 
| 
 | Base class for single-frame measurement plugin. | 
| 
 | Base class for single-frame plugin configuration classes. | 
| 
 | Configuration for the sky coordinates algorithm. | 
| 
 | Record the sky position of an object based on its centroid slot and WCS. | 
| alias of  | |
| 
 | Compute the skew of diaSource fluxes. | 
| 
 | |
| 
 | Configuration class for generating integer IDs from  | 
| 
 | Compute the StetsonJ statistic on the DIA point source fluxes. | 
| 
 | |
| Members: | |
| 
 | Configuration for the variance calculation plugin. | 
| 
 | Compute the weighted mean and mean error on the point source fluxes of the DiaSource measured on the difference image. | 
| 
 | |
| 
 | Compute the weighted mean and mean error on the point source fluxes forced photometered at the DiaSource location in the calibrated image. | 
| 
 |