PropertyMapRegistry¶
- class lsst.pipe.tasks.healSparseMappingProperties.PropertyMapRegistry(configBaseType=<class 'lsst.pex.config.config.Config'>)¶
Bases:
Registry
Class for property map registry.
Notes
This code is based on
lsst.meas.base.PluginRegistry
.Methods Summary
get
(k[,d])items
()keys
()makeField
(doc[, default, optional, multi, ...])Create a
RegistryField
configuration field from this registry.register
(name, PropertyMapClass)Register a property map class with the given name.
values
()Methods Documentation
- get(k[, d]) D[k] if k in D, else d. d defaults to None. ¶
- items() a set-like object providing a view on D's items ¶
- keys() a set-like object providing a view on D's keys ¶
- makeField(doc, default=None, optional=False, multi=False, on_none=None)¶
Create a
RegistryField
configuration field from this registry.- Parameters:
- doc
str
A description of the field.
- defaultobject, optional
The default target for the field.
- optional
bool
, optional When
False
,lsst.pex.config.Config.validate
fails if the field’s value isNone
.- multi
bool
, optional A flag to allow multiple selections in the
RegistryField
ifTrue
.- on_none: `Callable`, optional
A callable that should be invoked when
apply
is called but the selected name or names isNone
. Will be passed the field attribute proxy (RegistryInstanceDict
) and then all positional and keyword arguments passed toapply
.
- doc
- Returns:
- field
lsst.pex.config.RegistryField
RegistryField
Configuration field.
- field
- register(name, PropertyMapClass)¶
Register a property map class with the given name.
- Parameters:
- name
str
The name of the property map.
- PropertyMapClasssubclass of
BasePropertyMap
- name
- values() an object providing a view on D's values ¶