lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
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

pexConfig magLimit
 
pexConfig stampSize
 
pexConfig modelStampBuffer
 
pexConfig doRemoveDetected
 
pexConfig doApplyTransform
 
pexConfig warpingKernelName
 
pexConfig annularFluxRadii
 
pexConfig annularFluxStatistic
 
pexConfig numSigmaClip
 
pexConfig numIter
 
pexConfig badMaskPlanes
 
pexConfig minPixelsWithinFrame
 
pexConfig doApplySkyCorr
 
pexConfig discardNanFluxStars
 
pexConfig refObjLoader
 

Detailed Description

Configuration parameters for ProcessBrightStarsTask

Definition at line 82 of file processBrightStars.py.

Member Function Documentation

◆ setDefaults()

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

Definition at line 177 of file processBrightStars.py.

Member Data Documentation

◆ annularFluxRadii

pexConfig 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 124 of file processBrightStars.py.

◆ annularFluxStatistic

pexConfig 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 130 of file processBrightStars.py.

◆ badMaskPlanes

pexConfig 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 150 of file processBrightStars.py.

◆ discardNanFluxStars

pexConfig lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.discardNanFluxStars
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Should stars with NaN annular flux be discarded?",
default=False
)

Definition at line 167 of file processBrightStars.py.

◆ doApplySkyCorr

pexConfig 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 162 of file processBrightStars.py.

◆ doApplyTransform

pexConfig 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 108 of file processBrightStars.py.

◆ doRemoveDetected

pexConfig 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 102 of file processBrightStars.py.

◆ magLimit

pexConfig 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 86 of file processBrightStars.py.

◆ minPixelsWithinFrame

pexConfig 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 156 of file processBrightStars.py.

◆ modelStampBuffer

pexConfig 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 96 of file processBrightStars.py.

◆ numIter

pexConfig 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 145 of file processBrightStars.py.

◆ numSigmaClip

pexConfig 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 140 of file processBrightStars.py.

◆ refObjLoader

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

Definition at line 172 of file processBrightStars.py.

◆ stampSize

pexConfig 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 91 of file processBrightStars.py.

◆ warpingKernelName

pexConfig 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 113 of file processBrightStars.py.


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