LSSTApplications  19.0.0-14-gb0260a2+6db932c395,20.0.0+235c3eae2c,20.0.0+448775ce90,20.0.0+5f56aa8f28,20.0.0+b40eaeb6a0,20.0.0+d006f05c5d,20.0.0+dbd2281351,20.0.0+dc1acf7baf,20.0.0+e2e26847c2,20.0.0+f48bb53858,20.0.0-1-g10df615+4b67200b40,20.0.0-1-g253301a+d006f05c5d,20.0.0-1-g2b7511a+f48bb53858,20.0.0-1-g4d801e7+68c50072dc,20.0.0-1-g5b95a8c+d1beabf16b,20.0.0-1-g660595b+f45b7d88f4,20.0.0-1-gc96f8cb+4df7bab894,20.0.0-1-gd1c87d7+add1f556b4,20.0.0-1-gedffbd8+eb23c4e4f2,20.0.0-11-g13aeee2+1a7c0f1887,20.0.0-14-g199c894+e853f797a7,20.0.0-15-gf5872d0+4df7bab894,20.0.0-16-g6fe20a1+b7072f60df,20.0.0-2-g4dae9ad+4df7bab894,20.0.0-2-g5ad0983+1a7c0f1887,20.0.0-2-g7818986+add1f556b4,20.0.0-2-gb095acb+63636aeed8,20.0.0-2-gdaeb0e8+7d7ca508c5,20.0.0-2-gec03fae+de92faa26f,20.0.0-23-g8d4de91b+950b69a445,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-46-g00fa051+1467b54e00,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-5-gfcebe35+a6a1a2f802,20.0.0-7-gc818c6e6+57cf537add,20.0.0-7-gcda7bf1+738fa57269,20.0.0-9-g61a2a9a3d+7fa50e000d,w.2020.38
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig:
lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig

Public Member Functions

def validate (self)
 

Static Public Attributes

 ref_dataset_name
 
 pixelMargin
 
 defaultFilter
 
 anyFilterMapsToThis
 
 filterMap
 
 requireProperMotion
 

Detailed Description

Definition at line 35 of file loadIndexedReferenceObjects.py.

Member Function Documentation

◆ validate()

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

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

◆ ref_dataset_name

lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsConfig.ref_dataset_name
static
Initial value:
= pexConfig.Field(
dtype=str,
default='cal_ref_cat',
doc='Name of the ingested reference dataset'
)

Definition at line 36 of file loadIndexedReferenceObjects.py.

◆ requireProperMotion

lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig.requireProperMotion
staticinherited
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