lsst.ip.isr ged8ae655b3+88b164628e
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
lsst.ip.isr.vignette.VignetteConfig Class Reference
Inheritance diagram for lsst.ip.isr.vignette.VignetteConfig:

Static Public Attributes

 xCenter
 
 yCenter
 
 radius
 
 numPolygonPoints
 
 doWriteVignettePolygon
 

Detailed Description

Settings to define vignetting pattern.

Definition at line 36 of file vignette.py.

Member Data Documentation

◆ doWriteVignettePolygon

lsst.ip.isr.vignette.VignetteConfig.doWriteVignettePolygon
static
Initial value:
= Field(
dtype=bool,
doc="Persist polygon used to define vignetted region?",
default=False,
deprecated=("Vignetted polygon is added to the exposure by default."
" This option is no longer used, and will be removed after v24.")
)

Definition at line 60 of file vignette.py.

◆ numPolygonPoints

lsst.ip.isr.vignette.VignetteConfig.numPolygonPoints
static
Initial value:
= Field(
dtype=int,
doc="Number of points used to define the vignette polygon.",
default=100,
)

Definition at line 55 of file vignette.py.

◆ radius

lsst.ip.isr.vignette.VignetteConfig.radius
static
Initial value:
= Field(
dtype=float,
doc="Radius of vignetting pattern, in focal plane coordinates.",
default=100.0,
check=lambda x: x >= 0
)

Definition at line 49 of file vignette.py.

◆ xCenter

lsst.ip.isr.vignette.VignetteConfig.xCenter
static
Initial value:
= Field(
dtype=float,
doc="Center of vignetting pattern, in focal plane x coordinates.",
default=0.0,
)

Definition at line 39 of file vignette.py.

◆ yCenter

lsst.ip.isr.vignette.VignetteConfig.yCenter
static
Initial value:
= Field(
dtype=float,
doc="Center of vignetting pattern, in focal plane y coordinates.",
default=0.0,
)

Definition at line 44 of file vignette.py.


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