MaskStreaksTask

Python API summary

from lsst.pipe.tasks.maskStreaks import MaskStreaksTask

classMaskStreaksTask(config: Optional[Config] = None, name: Optional[str] = None, parentTask: Optional[Task] = None, log: Optional[Union[logging.Logger, lsst.utils.logging.LsstLogAdapter]] = 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

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

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

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