lsst.meas.algorithms.maskStreaks.MaskStreaksConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.maskStreaks.MaskStreaksConfig:

Static Public Attributes
	minimumKernelHeight
	absMinimumKernelHeight
	clusterMinimumSize
	clusterMinimumDeviation
	delta
	nSigma
	nSigmaMask
	rhoBinSize
	thetaBinSize
	invSigma
	footprintThreshold
	dChi2Tolerance
	maxFitIter
	detectedMaskPlane
	onlyMaskDetected
	streaksMaskPlane
	badMaskPlanes
	maxStreakWidth
	saturatedDetectionsDilation

Detailed Description

Configuration parameters for `MaskStreaksTask`.

Definition at line 522 of file maskStreaks.py.

Member Data Documentation

absMinimumKernelHeight

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.absMinimumKernelHeight

static

Initial value:

=  pexConfig.Field(
        doc="Minimum absolute height of the streak-finding kernel",
        dtype=float,
        default=5,
    )

Definition at line 531 of file maskStreaks.py.

badMaskPlanes

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.badMaskPlanes

static

Initial value:

=  pexConfig.ListField(
        doc=("Names of mask plane regions to ignore entirely when doing streak"
             " detection"),
        dtype=str,
        default=("NO_DATA", "INTRP", "BAD", "SAT", "EDGE"),
    )

Definition at line 616 of file maskStreaks.py.

clusterMinimumDeviation

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.clusterMinimumDeviation

static

Initial value:

=  pexConfig.Field(
        doc="Allowed deviation (in pixels) from a straight line for a detected "
            "line",
        dtype=int,
        default=2,
    )

Definition at line 541 of file maskStreaks.py.

clusterMinimumSize

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.clusterMinimumSize

static

Initial value:

=  pexConfig.Field(
        doc="Minimum size in pixels of detected clusters",
        dtype=int,
        default=50,
    )

Definition at line 536 of file maskStreaks.py.

dChi2Tolerance

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.dChi2Tolerance

static

Initial value:

=  pexConfig.Field(
        doc="Absolute difference in Chi2 between iterations of line profile"
            "fitting that is acceptable for convergence",
        dtype=float,
        default=0.1
    )

Definition at line 587 of file maskStreaks.py.

delta

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.delta

static

Initial value:

=  pexConfig.Field(
        doc="Stepsize in angle-radius parameter space",
        dtype=float,
        default=0.2,
    )

Definition at line 547 of file maskStreaks.py.

detectedMaskPlane

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.detectedMaskPlane

static

Initial value:

=  pexConfig.Field(
        doc="Name of mask with pixels above detection threshold, used for first"
            "estimate of streak locations",
        dtype=str,
        default="DETECTED"
    )

Definition at line 599 of file maskStreaks.py.

footprintThreshold

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.footprintThreshold

static

Initial value:

=  pexConfig.Field(
        doc="Threshold at which to determine edge of line, in units of "
            "nanoJanskys",
        dtype=float,
        default=0.01
    )

Definition at line 581 of file maskStreaks.py.

invSigma

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.invSigma

static

Initial value:

=  pexConfig.Field(
        doc="Inverse of the Moffat sigma parameter (in units of pixels)"
            "describing the profile of the streak",
        dtype=float,
        default=10.**-1,
    )

Definition at line 575 of file maskStreaks.py.

maxFitIter

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.maxFitIter

static

Initial value:

=  pexConfig.Field(
        doc="Maximum number of line profile fitting iterations that is "
            "acceptable for convergence",
        dtype=int,
        default=100
    )

Definition at line 593 of file maskStreaks.py.

maxStreakWidth

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.maxStreakWidth

static

Initial value:

=  pexConfig.Field(
        doc="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.",
        dtype=float,
        default=0.,
    )

Definition at line 622 of file maskStreaks.py.

minimumKernelHeight

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.minimumKernelHeight

static

Initial value:

=  pexConfig.Field(
        doc="Minimum height of the streak-finding kernel relative to the tallest kernel",
        dtype=float,
        default=0.0,
    )

Definition at line 526 of file maskStreaks.py.

nSigma

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.nSigma

static

Initial value:

=  pexConfig.Field(
        doc="Number of sigmas from center of kernel to include in voting "
            "procedure",
        dtype=float,
        default=2,
    )

Definition at line 552 of file maskStreaks.py.

nSigmaMask

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.nSigmaMask

static

Initial value:

=  pexConfig.Field(
        doc="Number of sigmas from center of kernel to mask",
        dtype=float,
        default=5,
    )

Definition at line 558 of file maskStreaks.py.

onlyMaskDetected

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.onlyMaskDetected

static

Initial value:

=  pexConfig.Field(
        doc=("If true, only propagate the part of the streak mask that "
             "overlaps with the detection mask."),
        dtype=bool,
        default=True,
    )

Definition at line 605 of file maskStreaks.py.

rhoBinSize

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.rhoBinSize

static

Initial value:

=  pexConfig.Field(
        doc="Binsize in pixels for position parameter rho when finding "
            "clusters of detected lines",
        dtype=float,
        default=40,
    )

Definition at line 563 of file maskStreaks.py.

saturatedDetectionsDilation

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.saturatedDetectionsDilation

static

Initial value:

=  pexConfig.Field(
        doc="Mask out the region around saturated detections by dilating the "
            "existing mask by this number of pixels.",
        dtype=int,
        default=250,
    )

Definition at line 630 of file maskStreaks.py.

streaksMaskPlane

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.streaksMaskPlane

static

Initial value:

=  pexConfig.Field(
        doc="Name of mask plane holding detected streaks",
        dtype=str,
        default="STREAK"
    )

Definition at line 611 of file maskStreaks.py.

thetaBinSize

lsst.meas.algorithms.maskStreaks.MaskStreaksConfig.thetaBinSize

static

Initial value:

=  pexConfig.Field(
        doc="Binsize in degrees for angle parameter theta when finding "
            "clusters of detected lines",
        dtype=float,
        default=2,
    )

Definition at line 569 of file maskStreaks.py.

---

The documentation for this class was generated from the following file:

• python/lsst/meas/algorithms/maskStreaks.py