|
def | validateTarget (self, target, ConfigClass) |
|
def | __init__ (self, doc, target, ConfigClass=None, default=None, check=None, deprecated=None) |
|
def | __get__ (self, instance, owner=None, at=None, label="default") |
|
def | __set__ (self, instance, value, at=None, label="assignment") |
|
def | rename (self, instance) |
|
def | save (self, outfile, instance) |
|
def | freeze (self, instance) |
|
def | toDict (self, instance) |
|
def | validate (self, instance) |
|
def | __deepcopy__ (self, memo) |
|
def | __init__ (self, doc, dtype, default=None, check=None, optional=False, deprecated=None) |
|
def | rename (self, instance) |
|
def | validate (self, instance) |
|
def | freeze (self, instance) |
|
def | save (self, outfile, instance) |
|
def | toDict (self, instance) |
|
def | __get__ (self, instance, owner=None, at=None, label="default") |
|
def | __set__ (self, instance, value, at=None, label='assignment') |
|
def | __delete__ (self, instance, at=None, label='deletion') |
|
A configuration field (`~lsst.pex.config.Field` subclass) that can be
can be retargeted towards a different configurable (often a
`lsst.pipe.base.Task` subclass).
The ``ConfigurableField`` is often used to configure subtasks, which are
tasks (`~lsst.pipe.base.Task`) called by a parent task.
Parameters
----------
doc : `str`
A description of the configuration field.
target : configurable class
The configurable target. Configurables have a ``ConfigClass``
attribute. Within the task framework, configurables are
`lsst.pipe.base.Task` subclasses)
ConfigClass : `lsst.pex.config.Config`-type, optional
The subclass of `lsst.pex.config.Config` expected as the configuration
class of the ``target``. If ``ConfigClass`` is unset then
``target.ConfigClass`` is used.
default : ``ConfigClass``-type, optional
The default configuration class. Normally this parameter is not set,
and defaults to ``ConfigClass`` (or ``target.ConfigClass``).
check : callable, optional
Callable that takes the field's value (the ``target``) as its only
positional argument, and returns `True` if the ``target`` is valid (and
`False` otherwise).
deprecated : None or `str`, optional
A description of why this Field is deprecated, including removal date.
If not None, the string is appended to the docstring for this Field.
See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
DictField
Field
ListField
RangeField
RegistryField
Notes
-----
You can use the `ConfigurableInstance.apply` method to construct a
fully-configured configurable.