Inheritance diagram for lsst.pex.config.registry.Registry:
Public Member Functions | |
| def | __init__ |
| def | register |
| def | __getitem__ |
| def | __len__ |
| def | __iter__ |
| def | __contains__ |
| def | makeField |
Private Attributes | |
| _configBaseType | |
| _dict | |
Detailed Description
A base class for global registries, mapping names to configurables.
There are no hard requirements on configurable, but they typically create an algorithm
or are themselves the algorithm, and typical usage is as follows:
- configurable is a callable whose call signature is (config, ...extra arguments...)
- All configurables added to a particular registry will have the same call signature
- All configurables in a registry will typically share something important in common.
For example all configurables in psfMatchingRegistry return a psf matching
class that has a psfMatch method with a particular call signature.
A registry acts like a read-only dictionary with an additional register method to add items.
The dict contains configurables and each configurable has an instance ConfigClass.
Example:
registry = Registry()
class FooConfig(Config):
val = Field(dtype=int, default=3, doc="parameter for Foo")
class Foo(object):
ConfigClass = FooConfig
def __init__(self, config):
self.config = config
def addVal(self, num):
return self.config.val + num
registry.register("foo", Foo)
names = registry.keys() # returns ("foo",)
fooConfigurable = registry["foo"]
fooConfig = fooItem.ConfigClass()
foo = fooConfigurable(fooConfig)
foo.addVal(5) # returns config.val + 5
Definition at line 44 of file registry.py.
Constructor & Destructor Documentation
| def lsst.pex.config.registry.Registry.__init__ | ( | self, | |
configBaseType = Config |
|||
| ) |
Construct a registry of name: configurables @param configBaseType: base class for config classes in registry
Definition at line 76 of file registry.py.
