lsst.skymap.baseSkyMap.BaseSkyMapConfig Class Reference
Inheritance diagram for lsst.skymap.baseSkyMap.BaseSkyMapConfig:
Public Member Functions | |
| getPatchInnerDimensions (self) | |
| setPatchInnerDimensions (self, value) | |
| getPatchBorder (self) | |
| setPatchBorder (self, value) | |
Static Public Attributes | |
| tractBuilder | |
| tractOverlap | |
| pixelScale | |
| projection | |
| rotation | |
Properties | |
| patchInnerDimensions = property(getPatchInnerDimensions, setPatchInnerDimensions) | |
| patchBorder = property(getPatchBorder, setPatchBorder) | |
Detailed Description
Definition at line 39 of file baseSkyMap.py.
Member Function Documentation
◆ getPatchBorder()
| lsst.skymap.baseSkyMap.BaseSkyMapConfig.getPatchBorder | ( | self | ) |
Get the patch border, for backwards compatibility. This value is only used with the ``legacy`` tract builder, and is ignored otherwise. In general, the config should be accessed directly with config.tractBuilder["legacy"].patchBorder. Returns ------- border: `int`
Definition at line 101 of file baseSkyMap.py.
101 def getPatchBorder(self):
102 """Get the patch border, for backwards compatibility.
103
104 This value is only used with the ``legacy`` tract builder,
105 and is ignored otherwise. In general, the config should be
106 accessed directly with config.tractBuilder["legacy"].patchBorder.
107
108 Returns
109 -------
110 border: `int`
111 """
112 return self.tractBuilder["legacy"].patchBorder
113
◆ getPatchInnerDimensions()
| lsst.skymap.baseSkyMap.BaseSkyMapConfig.getPatchInnerDimensions | ( | self | ) |
Get the patch inner dimensions, for backwards compatibility. This value is only used with the ``legacy`` tract builder, and is ignored otherwise. In general, the config should be accessed directly with ``config.tractBuilder["legacy"].patchInnerDimensions``. Returns ------- innerDimensions : `list` [`int`, `int`]
Definition at line 71 of file baseSkyMap.py.
71 def getPatchInnerDimensions(self):
72 """Get the patch inner dimensions, for backwards compatibility.
73
74 This value is only used with the ``legacy`` tract builder,
75 and is ignored otherwise. In general, the config should be
76 accessed directly with
77 ``config.tractBuilder["legacy"].patchInnerDimensions``.
78
79 Returns
80 -------
81 innerDimensions : `list` [`int`, `int`]
82 """
83 return self.tractBuilder["legacy"].patchInnerDimensions
84
◆ setPatchBorder()
| lsst.skymap.baseSkyMap.BaseSkyMapConfig.setPatchBorder | ( | self, | |
| value ) |
Set the patch border, for backwards compatibility. This value is only used with the ``legacy`` tract builder, and is ignored otherwise. In general, the config should be accessed directly with config.tractBuilder["legacy"].patchBorder. Parameters ---------- border: `int`
Definition at line 114 of file baseSkyMap.py.
114 def setPatchBorder(self, value):
115 """Set the patch border, for backwards compatibility.
116
117 This value is only used with the ``legacy`` tract builder,
118 and is ignored otherwise. In general, the config should be
119 accessed directly with config.tractBuilder["legacy"].patchBorder.
120
121 Parameters
122 ----------
123 border: `int`
124 """
125 self.tractBuilder["legacy"].patchBorder = value
126
◆ setPatchInnerDimensions()
| lsst.skymap.baseSkyMap.BaseSkyMapConfig.setPatchInnerDimensions | ( | self, | |
| value ) |
Set the patch inner dimensions, for backwards compatibility. This value is only used with the ``legacy`` tract builder, and is ignored otherwise. In general, the config should be accessed directly with ``config.tractBuilder["legacy"].patchInnerDimensions``. Parameters ---------- value : `list` [`int`, `int`]
Definition at line 85 of file baseSkyMap.py.
85 def setPatchInnerDimensions(self, value):
86 """Set the patch inner dimensions, for backwards compatibility.
87
88 This value is only used with the ``legacy`` tract builder,
89 and is ignored otherwise. In general, the config should be
90 accessed directly with
91 ``config.tractBuilder["legacy"].patchInnerDimensions``.
92
93 Parameters
94 ----------
95 value : `list` [`int`, `int`]
96 """
97 self.tractBuilder["legacy"].patchInnerDimensions = value
98
Member Data Documentation
◆ pixelScale
|
static |
Initial value:
= pexConfig.Field(
doc="nominal pixel scale (arcsec/pixel)",
dtype=float,
default=0.333
)
Definition at line 50 of file baseSkyMap.py.
◆ projection
|
static |
Initial value:
= pexConfig.Field(
doc="one of the FITS WCS projection codes, such as:"
"- STG: stereographic projection"
"- MOL: Molleweide's projection"
"- TAN: tangent-plane projection",
dtype=str,
default="STG",
)
Definition at line 55 of file baseSkyMap.py.
◆ rotation
|
static |
Initial value:
= pexConfig.Field(
doc="Rotation for WCS (deg)",
dtype=float,
default=0,
)
Definition at line 63 of file baseSkyMap.py.
◆ tractBuilder
|
static |
Initial value:
= tractBuilderRegistry.makeField(
doc="Algorithm for creating patches within the tract.",
default="legacy"
)
Definition at line 40 of file baseSkyMap.py.
◆ tractOverlap
|
static |
Initial value:
= pexConfig.Field(
doc="minimum overlap between adjacent sky tracts, on the sky (deg)",
dtype=float,
default=1.0,
)
Definition at line 45 of file baseSkyMap.py.
Property Documentation
◆ patchBorder
|
static |
Definition at line 127 of file baseSkyMap.py.
◆ patchInnerDimensions
|
static |
Definition at line 99 of file baseSkyMap.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/skymap/g1fd858c14a+470a99fdf4/python/lsst/skymap/baseSkyMap.py
Generated on Fri Apr 25 2025 08:04:03 for LSST Applications by
1.13.2