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...

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: False
Field type: bool Field

Apply flux limit to Psf Candidate selection?

doSignalToNoiseLimit¶

Default: True
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

Maximum flux value for good Psf Candidates (ignored if == 0).

fluxMin¶

Default: 12500.0
Field type: float Field

Minimum flux value 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

Maximum signal-to-noise for good Psf Candidates (ignored if == 0).

signalToNoiseMin¶

Default: 50.0
Field type: float Field

Minimum signal-to-noise for good Psf Candidates (value should take into consideration the detection thresholds set for the catalog of interest).

sourceFluxField¶

Default: 'base_PsfFlux_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.9
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.

Navigation