ObjectSizeStarSelectorTask

ObjectSizeStarSelectorTask selects likely stars by looking for a cluster of small objects in a size-magnitude plot.

Python API summary

from lsst.meas.algorithms.objectSizeStarSelector import ObjectSizeStarSelectorTask
classObjectSizeStarSelectorTask(**kwargs)

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

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(sourceCat, sourceSelectedField=None, matches=None, exposure=None)

Select sources and return them...

See also

See the ObjectSizeStarSelectorTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

badFlags

Default
['base_PixelFlags_flag_edge', 'base_PixelFlags_flag_interpolatedCenter', 'base_PixelFlags_flag_saturatedCenter', 'base_PixelFlags_flag_crCenter', 'base_PixelFlags_flag_bad', 'base_PixelFlags_flag_interpolated']
Field type
str ListField
List of flags which cause a source to be rejected as bad

doFluxLimit

Default
True
Field type
bool Field
Apply flux limit to Psf Candidate selection?

doSignalToNoiseLimit

Default
False
Field type
bool Field
Apply signal-to-noise (i.e. flux/fluxErr) limit to Psf Candidate selection?

fluxMax

Default
0.0
Field type
float Field
specify the maximum psfFlux for good Psf Candidates (ignored if == 0)

fluxMin

Default
12500.0
Field type
float Field
specify the minimum psfFlux for good Psf Candidates

nSigmaClip

Default
2.0
Field type
float Field
Keep objects within this many sigma of cluster 0’s median

signalToNoiseMax

Default
0.0
Field type
float Field
specify the maximum signal-to-noise for good Psf Candidates (ignored if == 0)

signalToNoiseMin

Default
20.0
Field type
float Field
specify the minimum signal-to-noise for good Psf Candidates

sourceFluxField

Default
'base_GaussianFlux_instFlux'
Field type
str Field
Name of field in Source to use for flux measurement

widthMax

Default
10.0
Field type
float Field
maximum width to include in histogram

widthMin

Default
0.0
Field type
float Field
minimum width to include in histogram

widthStdAllowed

Default
0.15
Field type
float Field
Standard deviation of width allowed to be interpreted as good stars

Debugging

ObjectSizeStarSelectorTask has a debug dictionary with the following boolean keys:

display
bool; if True display debug information
displayExpsoure
bool; if True display the exposure and spatial cells
plotMagSize
bool; if True display the magnitude-size relation using matplotlib
dumpData
bool; if True dump data to a pickle file

More information can be found in lsstDebug.