lsst.pipe.tasks  21.0.0-65-g9ea87ca1+87d0d175cc
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig:
lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConnections

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 magLimit
 
 stampSize
 
 modelStampBuffer
 
 doRemoveDetected
 
 doApplyTransform
 
 warpingKernelName
 
 annularFluxRadii
 
 annularFluxStatistic
 
 numSigmaClip
 
 numIter
 
 badMaskPlanes
 
 minPixelsWithinFrame
 
 doApplySkyCorr
 
 refObjLoader
 
 inputExposure
 
 skyCorr
 
 refCat
 
 brightStarStamps
 

Detailed Description

Configuration parameters for ProcessBrightStarsTask

Definition at line 81 of file processBrightStars.py.

Member Function Documentation

◆ setDefaults()

def lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.setDefaults (   self)

Definition at line 171 of file processBrightStars.py.

Member Data Documentation

◆ annularFluxRadii

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.annularFluxRadii
static
Initial value:
= pexConfig.ListField(
dtype=int,
doc="Inner and outer radii of the annulus used to compute the AnnularFlux for normalization, "
"in pixels.",
default=(40, 50)
)

Definition at line 123 of file processBrightStars.py.

◆ annularFluxStatistic

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.annularFluxStatistic
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Type of statistic to use to compute annular flux.",
default="MEANCLIP",
allowed={
"MEAN": "mean",
"MEDIAN": "median",
"MEANCLIP": "clipped mean",
}
)

Definition at line 129 of file processBrightStars.py.

◆ badMaskPlanes

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.badMaskPlanes
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask planes that, if set, lead to associated pixels not being included in the computation of the"
" annular flux.",
default=('BAD', 'CR', 'CROSSTALK', 'EDGE', 'NO_DATA', 'SAT', 'SUSPECT', 'UNMASKEDNAN')
)

Definition at line 149 of file processBrightStars.py.

◆ brightStarStamps

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConnections.brightStarStamps
staticinherited
Initial value:
= cT.Output(
doc="Set of preprocessed postage stamps, each centered on a single bright star.",
name="brightStarStamps",
storageClass="BrightStarStamps",
dimensions=("visit", "detector")
)

Definition at line 68 of file processBrightStars.py.

◆ doApplySkyCorr

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doApplySkyCorr
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply full focal plane sky correction before extracting stars?",
default=True
)

Definition at line 161 of file processBrightStars.py.

◆ doApplyTransform

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doApplyTransform
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Apply transform to bright star stamps to correct for optical distortions?",
default=True
)

Definition at line 107 of file processBrightStars.py.

◆ doRemoveDetected

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doRemoveDetected
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Whether DETECTION footprints, other than that for the central object, should be changed to "
"BAD",
default=True
)

Definition at line 101 of file processBrightStars.py.

◆ inputExposure

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConnections.inputExposure
staticinherited
Initial value:
= cT.Input(
doc="Input exposure from which to extract bright star stamps",
name="calexp",
storageClass="ExposureF",
dimensions=("visit", "detector")
)

Definition at line 48 of file processBrightStars.py.

◆ magLimit

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.magLimit
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Magnitude limit, in Gaia G; all stars brighter than this value will be processed",
default=18
)

Definition at line 85 of file processBrightStars.py.

◆ minPixelsWithinFrame

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.minPixelsWithinFrame
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Minimum number of pixels that must fall within the stamp boundary for the bright star to be"
" saved when its center is beyond the exposure boundary.",
default=50
)

Definition at line 155 of file processBrightStars.py.

◆ modelStampBuffer

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.modelStampBuffer
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="'Buffer' factor to be applied to determine the size of the stamp the processed stars will "
"be saved in. This will also be the size of the extended PSF model.",
default=1.1
)

Definition at line 95 of file processBrightStars.py.

◆ numIter

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.numIter
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of iterations of outlier rejection; ignored if annularFluxStatistic != 'MEANCLIP'.",
default=3
)

Definition at line 144 of file processBrightStars.py.

◆ numSigmaClip

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.numSigmaClip
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma for outlier rejection; ignored if annularFluxStatistic != 'MEANCLIP'.",
default=4
)

Definition at line 139 of file processBrightStars.py.

◆ refCat

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConnections.refCat
staticinherited
Initial value:
= cT.PrerequisiteInput(
doc="Reference catalog that contains bright star positions",
name="gaia_dr2_20200414",
storageClass="SimpleCatalog",
dimensions=("skypix",),
multiple=True,
deferLoad=True
)

Definition at line 60 of file processBrightStars.py.

◆ refObjLoader

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.refObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target=LoadIndexedReferenceObjectsTask,
doc="Reference object loader for astrometric calibration.",
)

Definition at line 166 of file processBrightStars.py.

◆ skyCorr

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConnections.skyCorr
staticinherited
Initial value:
= cT.Input(
doc="Input Sky Correction to be subtracted from the calexp if doApplySkyCorr=True",
name="skyCorr",
storageClass="Background",
dimensions=("instrument", "visit", "detector")
)

Definition at line 54 of file processBrightStars.py.

◆ stampSize

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.stampSize
static
Initial value:
= pexConfig.ListField(
dtype=int,
doc="Size of the stamps to be extracted, in pixels",
default=(250, 250)
)

Definition at line 90 of file processBrightStars.py.

◆ warpingKernelName

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.warpingKernelName
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Warping kernel",
default="lanczos5",
allowed={
"bilinear": "bilinear interpolation",
"lanczos3": "Lanczos kernel of order 3",
"lanczos4": "Lanczos kernel of order 4",
"lanczos5": "Lanczos kernel of order 5",
}
)

Definition at line 112 of file processBrightStars.py.


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