LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
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

lsst.skymap.baseSkyMap.BaseSkyMapConfig.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

lsst.skymap.baseSkyMap.BaseSkyMapConfig.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

lsst.skymap.baseSkyMap.BaseSkyMapConfig.rotation
static
Initial value:
= pexConfig.Field(
doc="Rotation for WCS (deg)",
dtype=float,
default=0,
)

Definition at line 63 of file baseSkyMap.py.

◆ tractBuilder

lsst.skymap.baseSkyMap.BaseSkyMapConfig.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

lsst.skymap.baseSkyMap.BaseSkyMapConfig.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

lsst.skymap.baseSkyMap.BaseSkyMapConfig.patchBorder = property(getPatchBorder, setPatchBorder)
static

Definition at line 127 of file baseSkyMap.py.

◆ patchInnerDimensions

lsst.skymap.baseSkyMap.BaseSkyMapConfig.patchInnerDimensions = property(getPatchInnerDimensions, setPatchInnerDimensions)
static

Definition at line 99 of file baseSkyMap.py.


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