lsst.skymap 22.0.1-7-g833eef2+94992c29d7
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

def getPatchInnerDimensions (self)
 
def setPatchInnerDimensions (self, value)
 
def getPatchBorder (self)
 
def 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()

def 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 99 of file baseSkyMap.py.

◆ getPatchInnerDimensions()

def 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.

◆ setPatchBorder()

def 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 112 of file baseSkyMap.py.

◆ setPatchInnerDimensions()

def 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 84 of file baseSkyMap.py.

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 125 of file baseSkyMap.py.

◆ patchInnerDimensions

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

Definition at line 97 of file baseSkyMap.py.


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