MaskStreaksTask

Python API summary

from lsst.meas.algorithms.maskStreaks import MaskStreaksTask
classMaskStreaksTask(config=None, *, name=None, parentTask=None, log=None)

Find streaks or other straight lines in image data...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(maskedImage)

Find and mask streaks in a masked image...

See also

See the MaskStreaksTask API reference for complete details.

Retargetable subtasks

No subtasks.

Configuration fields

absMinimumKernelHeight

Default
5
Field type

float Field

Minimum absolute height of the streak-finding kernel

badMaskPlanes

Default
('NO_DATA', 'INTRP', 'BAD', 'SAT', 'EDGE')
Field type

str ListField

Names of mask plane regions to ignore entirely when doing streak detection

clusterMinimumDeviation

Default
2
Field type

int Field

Allowed deviation (in pixels) from a straight line for a detected line

clusterMinimumSize

Default
50
Field type

int Field

Minimum size in pixels of detected clusters

dChi2Tolerance

Default
0.1
Field type

float Field

Absolute difference in Chi2 between iterations of line profilefitting that is acceptable for convergence

delta

Default
0.2
Field type

float Field

Stepsize in angle-radius parameter space

detectedMaskPlane

Default
'DETECTED'
Field type

str Field

Name of mask with pixels above detection threshold, used for firstestimate of streak locations

footprintThreshold

Default
0.01
Field type

float Field

Threshold at which to determine edge of line, in units of nanoJanskys

invSigma

Default
0.1
Field type

float Field

Inverse of the Moffat sigma parameter (in units of pixels)describing the profile of the streak

maxFitIter

Default
100
Field type

int Field

Maximum number of line profile fitting iterations that is acceptable for convergence

maxStreakWidth

Default
0.0
Field type

float Field

Maximum width in pixels to allow for masking a streak.The fit streak parameters will not be modified, and a warning will be issued if the fitted width is larger than this value.Set to 0 to disable.

minimumKernelHeight

Default
0.0
Field type

float Field

Minimum height of the streak-finding kernel relative to the tallest kernel

nSigma

Default
2
Field type

float Field

Number of sigmas from center of kernel to include in voting procedure

nSigmaMask

Default
5
Field type

float Field

Number of sigmas from center of kernel to mask

onlyMaskDetected

Default
True
Field type

bool Field

If true, only propagate the part of the streak mask that overlaps with the detection mask.

rhoBinSize

Default
30
Field type

float Field

Binsize in pixels for position parameter rho when finding clusters of detected lines

streaksMaskPlane

Default
'STREAK'
Field type

str Field

Name of mask plane holding detected streaks

thetaBinSize

Default
2
Field type

float Field

Binsize in degrees for angle parameter theta when finding clusters of detected lines