lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig:

Static Public Attributes
	refObjLoader
	applyColorTerms
	colorterms
	photoCatName
	raKey
	decKey
	angleMargin
	magnitudeThreshold
	diffractAngle
	spikeAspectRatio
	magSlope
	magOffset
	fallbackMagnitude
	fallbackFluxField
	spikeMask
	saturatedMaskPlane

Detailed Description

Config for BrightStarMaskTask.

Definition at line 41 of file diffractionSpikeMask.py.

Member Data Documentation

angleMargin

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.angleMargin

static

Initial value:

=  Field(
        dtype=float,
        default=60.,
        doc="Margin outside the exposure bounding box to include bright "
            "sources. In arcseconds.",
    )

Definition at line 76 of file diffractionSpikeMask.py.

applyColorTerms

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.applyColorTerms

static

Initial value:

=  Field(
        dtype=bool,
        default=False,
        doc=("Apply photometric color terms to reference stars?\n"
             "`True`: attempt to apply color terms; fail if color term data is "
             "not available for the specified reference catalog and filter.\n"
             "`False`: do not apply color terms."),
        optional=True,
    )

Definition at line 46 of file diffractionSpikeMask.py.

colorterms

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.colorterms

static

Initial value:

=  ConfigField(
        dtype=ColortermLibrary,
        doc="Library of photometric reference catalog name: color term dict"
            " (see also applyColorTerms).",
    )

Definition at line 55 of file diffractionSpikeMask.py.

decKey

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.decKey

static

Initial value:

=  Field(
        dtype=str,
        default="coord_dec",
        doc="Declination column name in the reference catalog.",
    )

Definition at line 71 of file diffractionSpikeMask.py.

diffractAngle

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.diffractAngle

static

Initial value:

=  Field(
        dtype=float,
        default=45,
        doc="Angle in degrees of the location of diffraction spikes with "
            "respect to camera at 0 rotation angle.",
    )

Definition at line 88 of file diffractionSpikeMask.py.

fallbackFluxField

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.fallbackFluxField

static

Initial value:

=  Field(
        dtype=str,
        default="phot_g_mean",
        doc="Fallback flux field in the reference catalog to use for sources"
            " that don't have measurements in the science image's band.",
    )

Definition at line 118 of file diffractionSpikeMask.py.

fallbackMagnitude

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.fallbackMagnitude

static

Initial value:

=  Field(
        dtype=float,
        default=12.,
        doc="Default magnitude to use for sources in the reference catalog"
            " with missing magnitudes that land in regions of saturated pixels.",
    )

Definition at line 112 of file diffractionSpikeMask.py.

magnitudeThreshold

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.magnitudeThreshold

static

Initial value:

=  Field(
        dtype=float,
        default=15,
        doc="Threshold magnitude for treating a star from the reference catalog"
            " as bright.",
    )

Definition at line 82 of file diffractionSpikeMask.py.

magOffset

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.magOffset

static

Initial value:

=  Field(
        dtype=float,
        default=3.8,
        doc="Intercept of the fit for the log(spike length) as a function of"
            " magnitude.",
    )

Definition at line 106 of file diffractionSpikeMask.py.

magSlope

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.magSlope

static

Initial value:

=  Field(
        dtype=float,
        default=-0.12,
        doc="Slope of the fit for the log(spike length) as a function of"
            " magnitude.",
    )

Definition at line 100 of file diffractionSpikeMask.py.

photoCatName

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.photoCatName

static

Initial value:

=  Field(
        dtype=str,
        optional=True,
        doc=("Name of photometric reference catalog; used to select a color"
             " term dict in colorterms. See also applyColorTerms."),
    )

Definition at line 60 of file diffractionSpikeMask.py.

raKey

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.raKey

static

Initial value:

=  Field(
        dtype=str,
        default="coord_ra",
        doc="RA column name in the reference catalog.",
    )

Definition at line 66 of file diffractionSpikeMask.py.

refObjLoader

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.refObjLoader

static

Initial value:

=  ConfigField(dtype=LoadReferenceObjectsConfig,
                               doc="Configuration of reference object loader")

Definition at line 44 of file diffractionSpikeMask.py.

saturatedMaskPlane

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.saturatedMaskPlane

static

Initial value:

=  Field(
        dtype=str,
        default="SAT",
        doc="Name of the mask plane indicating a saturated pixel.",
    )

Definition at line 130 of file diffractionSpikeMask.py.

spikeAspectRatio

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.spikeAspectRatio

static

Initial value:

=  Field(
        dtype=float,
        default=10,
        doc="Ratio of the length of a diffraction spike to it's width in the"
            " core of the star.",
    )

Definition at line 94 of file diffractionSpikeMask.py.

spikeMask

lsst.pipe.tasks.diffractionSpikeMask.DiffractionSpikeMaskConfig.spikeMask

static

Initial value:

=  Field(
        dtype=str,
        default="SPIKE",
        doc="Name of the mask plane indicating likely contamination from"
            " a diffraction spike.",
    )

Definition at line 124 of file diffractionSpikeMask.py.

---

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

• python/lsst/pipe/tasks/diffractionSpikeMask.py