A star selector that looks for a cluster of small objects in a size-magnitude plot.
More...
A star selector that looks for a cluster of small objects in a size-magnitude plot.
@anchor ObjectSizeStarSelectorTask_
@section meas_algorithms_objectSizeStarSelector_Contents Contents
- @ref meas_algorithms_objectSizeStarSelector_Purpose
- @ref meas_algorithms_objectSizeStarSelector_Initialize
- @ref meas_algorithms_objectSizeStarSelector_IO
- @ref meas_algorithms_objectSizeStarSelector_Config
- @ref meas_algorithms_objectSizeStarSelector_Debug
@section meas_algorithms_objectSizeStarSelector_Purpose Description
A star selector that looks for a cluster of small objects in a size-magnitude plot.
@section meas_algorithms_objectSizeStarSelector_Initialize Task initialisation
@copydoc \_\_init\_\_
@section meas_algorithms_objectSizeStarSelector_IO Invoking the Task
Like all star selectors, the main method is `run`.
@section meas_algorithms_objectSizeStarSelector_Config Configuration parameters
See @ref ObjectSizeStarSelectorConfig
@section meas_algorithms_objectSizeStarSelector_Debug Debug variables
ObjectSizeStarSelectorTask has a debug dictionary with the following keys:
<dl>
<dt>display
<dd>bool; if True display debug information
<dt>displayExposure
<dd>bool; if True display the exposure and spatial cells
<dt>plotMagSize
<dd>bool: if True display the magnitude-size relation using matplotlib
<dt>dumpData
<dd>bool; if True dump data to a pickle file
</dl>
For example, put something like:
@code{.py}
import lsstDebug
def DebugInfo(name):
di = lsstDebug.getInfo(name) # N.b. lsstDebug.Info(name) would call us recursively
if name.endswith("objectSizeStarSelector"):
di.display = True
di.displayExposure = True
di.plotMagSize = True
return di
lsstDebug.Info = DebugInfo
@endcode
into your `debug.py` file and run your task with the `--debug` flag.
Definition at line 319 of file objectSizeStarSelector.py.
def lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.run |
( |
|
self, |
|
|
|
sourceCat, |
|
|
|
sourceSelectedField = None , |
|
|
|
matches = None , |
|
|
|
exposure = None |
|
) |
| |
|
inherited |
Select sources and return them.
The input catalog must be contiguous in memory.
Parameters:
-----------
sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
or `astropy.table.Table`
Catalog of sources to select from.
sourceSelectedField : `str` or None
Name of flag field in sourceCat to set for selected sources.
If set, will modify sourceCat in-place.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
List of matches to use for source selection.
If usesMatches is set in source selector this field is required.
If not, it is ignored.
exposure : `lsst.afw.image.Exposure` or None
The exposure the catalog was built from; used for debug display.
Return
------
struct : `lsst.pipe.base.Struct`
The struct contains the following data:
- sourceCat : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
or `astropy.table.Table`
The catalog of sources that were selected.
(may not be memory-contiguous)
- selected : `numpy.ndarray` of `bool``
Boolean array of sources that were selected, same length as
sourceCat.
Raises
------
RuntimeError
Raised if ``sourceCat`` is not contiguous.
Definition at line 71 of file sourceSelector.py.
def lsst.meas.algorithms.objectSizeStarSelector.ObjectSizeStarSelectorTask.selectSources |
( |
|
self, |
|
|
|
sourceCat, |
|
|
|
matches = None , |
|
|
|
exposure = None |
|
) |
| |
Return a selection of PSF candidates that represent likely stars.
A list of PSF candidates may be used by a PSF fitter to construct a PSF.
Parameters:
-----------
sourceCat : `lsst.afw.table.SourceCatalog`
Catalog of sources to select from.
This catalog must be contiguous in memory.
matches : `list` of `lsst.afw.table.ReferenceMatch` or None
Ignored in this SourceSelector.
exposure : `lsst.afw.image.Exposure` or None
The exposure the catalog was built from; used to get the detector
to transform to TanPix, and for debug display.
Return
------
struct : `lsst.pipe.base.Struct`
The struct contains the following data:
- selected : `array` of `bool``
Boolean array of sources that were selected, same length as
sourceCat.
Reimplemented from lsst.meas.algorithms.sourceSelector.BaseSourceSelectorTask.
Definition at line 381 of file objectSizeStarSelector.py.