LSSTApplications  19.0.0-14-gb0260a2+c4152221ba,20.0.0+428775a0ef,20.0.0+7c6b12c2f9,20.0.0+ae956f52c5,20.0.0+c388114e2c,20.0.0+e2e26847c2,20.0.0+e5529315c6,20.0.0-1-g04bee24+7c6b12c2f9,20.0.0-1-g10df615+cc9679e3e4,20.0.0-1-g253301a+7c6b12c2f9,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g4d801e7+9b3155b620,20.0.0-1-g5b95a8c+3d35cd64b7,20.0.0-1-gb058bd0+46a6078777,20.0.0-1-gb88604f+acecce4127,20.0.0-1-gc96f8cb+f5ea1f6730,20.0.0-1-gedffbd8+57e6df9186,20.0.0-10-g0891cd99+21712b8dc8,20.0.0-10-g9a20bd332+576ca7b471,20.0.0-17-gcdbda88+f8ebf1b2ab,20.0.0-2-g4dae9ad+f5ea1f6730,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-20-g7966b28+f5ea1f6730,20.0.0-21-g1f5da01+74cacf985d,20.0.0-23-g8900aa8+dfd6ff4ddf,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+3a91ba9410,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-32-g15a0e07c+fb20712e7c,20.0.0-4-g97dc21a+dfd6ff4ddf,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-59-gb502cbb+701042a847,20.0.0-6-g9a5b7a1+3980549e0d,20.0.0-7-gcda7bf1+ddb9d7f898,w.2020.43
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig:
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig

Public Member Functions

def validate (self)
 

Static Public Attributes

 pixelMargin
 
 defaultFilter
 
 anyFilterMapsToThis
 
 filterMap
 
 requireProperMotion
 

Detailed Description

Definition at line 773 of file loadReferenceObjects.py.

Member Function Documentation

◆ validate()

def lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.validate (   self)

Definition at line 811 of file loadReferenceObjects.py.

811  def validate(self):
812  super().validate()
813  if self.filterMap != {} and self.anyFilterMapsToThis is not None:
814  msg = "`filterMap` and `anyFilterMapsToThis` are mutually exclusive"
815  raise pexConfig.FieldValidationError(LoadReferenceObjectsConfig.anyFilterMapsToThis,
816  self, msg)
817 
818 
819 # The following comment block adds a link to this task from the Task Documentation page.

Member Data Documentation

◆ anyFilterMapsToThis

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.anyFilterMapsToThis
static
Initial value:
= pexConfig.Field(
doc=("Always use this reference catalog filter, no matter whether or what filter name is "
"supplied to the loader. Effectively a trivial filterMap: map all filter names to this filter."
" This can be set for purely-astrometric catalogs (e.g. Gaia DR2) where there is only one "
"reasonable choice for every camera filter->refcat mapping, but not for refcats used for "
"photometry, which need a filterMap and/or colorterms/transmission corrections."),
dtype=str,
default=None,
optional=True
)

Definition at line 786 of file loadReferenceObjects.py.

◆ defaultFilter

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.defaultFilter
static
Initial value:
= pexConfig.Field(
doc=("Default reference catalog filter to use if filter not specified in exposure;"
" if blank then filter must be specified in exposure."),
dtype=str,
default="",
)

Definition at line 780 of file loadReferenceObjects.py.

◆ filterMap

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.filterMap
static
Initial value:
= pexConfig.DictField(
doc=("Mapping of camera filter name: reference catalog filter name; "
"each reference filter must exist in the refcat."
" Note that this does not perform any bandpass corrections: it is just a lookup."),
keytype=str,
itemtype=str,
default={},
)

Definition at line 796 of file loadReferenceObjects.py.

◆ pixelMargin

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.pixelMargin
static
Initial value:
= pexConfig.RangeField(
doc="Padding to add to 4 all edges of the bounding box (pixels)",
dtype=int,
default=300,
min=0,
)

Definition at line 774 of file loadReferenceObjects.py.

◆ requireProperMotion

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.requireProperMotion
static
Initial value:
= pexConfig.Field(
doc="Require that the fields needed to correct proper motion "
"(epoch, pm_ra and pm_dec) are present?",
dtype=bool,
default=False,
)

Definition at line 804 of file loadReferenceObjects.py.


The documentation for this class was generated from the following file:
lsst.pex.config.wrap.validate
validate
Definition: wrap.py:295