Inheritance diagram for lsst.fgcmcal.sedterms.Sedterm:

Public Member Functions
def	validate (self)

def	__iter__ (self)

def	keys (self)

def	values (self)

def	items (self)

def	iteritems (self)

def	itervalues (self)

def	iterkeys (self)

def	__contains__ (self, name)
	Return True if the specified field exists in this config. More...

def	__new__ (cls, args, *kw)

def	__reduce__ (self)

def	setDefaults (self)

def	update (self, **kw)

def	load (self, filename, root="config")

def	loadFromStream (self, stream, root="config", filename=None)

def	save (self, filename, root="config")

def	saveToStream (self, outfile, root="config", skipImports=False)

def	freeze (self)

def	toDict (self)

def	names (self)

def	formatHistory (self, name, **kwargs)

def	__setattr__ (self, attr, value, at=None, label="assignment")

def	__setattr__ (cls, name, value)

def	__delattr__ (self, attr, at=None, label="deletion")

def	__eq__ (self, other)

def	__ne__ (self, other)

def	__str__ (self)

def	__repr__ (self)

def	compare (self, other, shortcut=True, rtol=1E-8, atol=1E-8, output=None)

def	__init_subclass__ (cls, **kwargs)

Static Public Attributes
	primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")

	secondaryTerm

	extrapolated = Field(dtype=bool, default=False, doc="Extrapolate to compute SED slope")

	constant = Field(dtype=float, default=1.0, doc="Adjustment constant for SED slope")

	primaryBand

	secondaryBand

	tertiaryBand

Properties
	history = property(lambda x: x._history)

Detailed Description

SED term for a single band.

The SED slope (in flux units) in the middle of a band is computed either
as an "interpolated" or "extrapolated" computation.  See Burke et al. 2018
Appendix A (https://ui.adsabs.harvard.edu/abs/2018AJ....155...41B).

For interpolation, with a secondary term::

   F'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0

For interpolation, without a secondary term::

   F'_nu ~ constant * primaryTerm

For extrapolation::

   F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
                                     (lambda_primaryBand - lambda_tertiaryBand)) *
                                     (primaryTerm - secondaryTerm))

where primaryTerm and secondaryTerm are names from a `SedboundarytermDict`, and
primaryBand, secondaryBand, and tertiaryBand are band names.

To construct a Sedterm, use keyword arguments::

    Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
            extrapolated=False, constant=1.0)

or::

    Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
            extrapolated=True, constant=1.0, primaryBand=primaryBandName,
            secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)

This is a subclass of Config.  This follows the form of
`lsst.pipe.tasks.Colorterm`.

Definition at line 71 of file sedterms.py.

Member Function Documentation

◆ contains()

def lsst.pex.config.config.Config.__contains__	(	self,
		name
	)

inherited

Return True if the specified field exists in this config.

    @param[in] name  field name to test for

Definition at line 886 of file config.py.

     def __contains__(self, name):
         """!Return True if the specified field exists in this config
  
         @param[in] name  field name to test for
         """
         return self._storage.__contains__(name)
  

◆ delattr()

def lsst.pex.config.config.Config.__delattr__	(	self,
		attr,
		at = `None`,
		label = `"deletion"`
	)

inherited

Definition at line 1369 of file config.py.

     def __delattr__(self, attr, at=None, label="deletion"):
         if attr in self._fields:
             if at is None:
                 at = getCallStack()
             self._fields[attr].__delete__(self, at=at, label=label)
         else:
             object.__delattr__(self, attr)
  

◆ eq()

def lsst.pex.config.config.Config.__eq__	(	self,
		other
	)

inherited

Definition at line 1377 of file config.py.

     def __eq__(self, other):
         if type(other) == type(self):
             for name in self._fields:
                 thisValue = getattr(self, name)
                 otherValue = getattr(other, name)
                 if isinstance(thisValue, float) and math.isnan(thisValue):
                     if not math.isnan(otherValue):
                         return False
                 elif thisValue != otherValue:
                     return False
             return True
         return False
  

◆ __init_subclass__()

def lsst.pex.config.config.Config.__init_subclass__	(		cls,
		**	kwargs
	)

inherited

Run initialization for every subclass.

Specifically registers the subclass with a YAML representer
and YAML constructor (if pyyaml is available)

Reimplemented in lsst.pipe.tasks.dataFrameActions._baseDataFrameActions.DataFrameAction.

Definition at line 1447 of file config.py.

     def __init_subclass__(cls, **kwargs):
         """Run initialization for every subclass.
  
         Specifically registers the subclass with a YAML representer
         and YAML constructor (if pyyaml is available)
         """
         super().__init_subclass__(**kwargs)
  
         if not yaml:
             return
  
         yaml.add_representer(cls, _yaml_config_representer)
  

◆ iter()

def lsst.pex.config.config.Config.__iter__ ( self )

inherited

Iterate over fields.

Definition at line 791 of file config.py.

     def __iter__(self):
         """Iterate over fields.
         """
         return self._fields.__iter__()
  

◆ ne()

def lsst.pex.config.config.Config.__ne__	(	self,
		other
	)

inherited

Definition at line 1390 of file config.py.

     def __ne__(self, other):
         return not self.__eq__(other)
  

◆ new()

def lsst.pex.config.config.Config.__new__	(		cls,
		*	args,
		**	kw
	)

inherited

Allocate a new `lsst.pex.config.Config` object.

In order to ensure that all Config object are always in a proper state
when handed to users or to derived `~lsst.pex.config.Config` classes,
some attributes are handled at allocation time rather than at
initialization.

This ensures that even if a derived `~lsst.pex.config.Config` class
implements ``__init__``, its author does not need to be concerned about
when or even the base ``Config.__init__`` should be called.

Definition at line 893 of file config.py.

     def __new__(cls, *args, **kw):
         """Allocate a new `lsst.pex.config.Config` object.
  
         In order to ensure that all Config object are always in a proper state
         when handed to users or to derived `~lsst.pex.config.Config` classes,
         some attributes are handled at allocation time rather than at
         initialization.
  
         This ensures that even if a derived `~lsst.pex.config.Config` class
         implements ``__init__``, its author does not need to be concerned about
         when or even the base ``Config.__init__`` should be called.
         """
         name = kw.pop("__name", None)
         at = kw.pop("__at", getCallStack())
         # remove __label and ignore it
         kw.pop("__label", "default")
  
         instance = object.__new__(cls)
         instance._frozen = False
         instance._name = name
         instance._storage = {}
         instance._history = {}
         instance._imports = set()
         # load up defaults
         for field in instance._fields.values():
             instance._history[field.name] = []
             field.__set__(instance, field.default, at=at + [field.source], label="default")
         # set custom default-overides
         instance.setDefaults()
         # set constructor overides
         instance.update(__at=at, **kw)
         return instance
  

◆ reduce()

def lsst.pex.config.config.Config.__reduce__ ( self )

inherited

Reduction for pickling (function with arguments to reproduce).

We need to condense and reconstitute the `~lsst.pex.config.Config`,
since it may contain lambdas (as the ``check`` elements) that cannot
be pickled.

Definition at line 926 of file config.py.

     def __reduce__(self):
         """Reduction for pickling (function with arguments to reproduce).
  
         We need to condense and reconstitute the `~lsst.pex.config.Config`,
         since it may contain lambdas (as the ``check`` elements) that cannot
         be pickled.
         """
         # The stream must be in characters to match the API but pickle
         # requires bytes
         stream = io.StringIO()
         self.saveToStream(stream)
         return (unreduceConfig, (self.__class__, stream.getvalue().encode()))
  

◆ repr()

def lsst.pex.config.config.Config.__repr__ ( self )

inherited

Definition at line 1396 of file config.py.

     def __repr__(self):
         return "%s(%s)" % (
             _typeStr(self),
             ", ".join("%s=%r" % (k, v) for k, v in self.toDict().items() if v is not None)
         )
  

◆ setattr() [1/2]

def lsst.pex.config.config.ConfigMeta.__setattr__	(	cls,
		name,
		value
	)

inherited

Definition at line 189 of file config.py.

     def __setattr__(cls, name, value):
         if isinstance(value, Field):
             value.name = name
             cls._fields[name] = value
         type.__setattr__(cls, name, value)
  
  

◆ setattr() [2/2]

def lsst.pex.config.config.Config.__setattr__	(	self,
		attr,
		value,
		at = `None`,
		label = `"assignment"`
	)

inherited

Set an attribute (such as a field's value).

Notes
-----
Unlike normal Python objects, `~lsst.pex.config.Config` objects are
locked such that no additional attributes nor properties may be added
to them dynamically.

Although this is not the standard Python behavior, it helps to protect
users from accidentally mispelling a field name, or trying to set a
non-existent field.

Definition at line 1337 of file config.py.

     def __setattr__(self, attr, value, at=None, label="assignment"):
         """Set an attribute (such as a field's value).
  
         Notes
         -----
         Unlike normal Python objects, `~lsst.pex.config.Config` objects are
         locked such that no additional attributes nor properties may be added
         to them dynamically.
  
         Although this is not the standard Python behavior, it helps to protect
         users from accidentally mispelling a field name, or trying to set a
         non-existent field.
         """
         if attr in self._fields:
             if self._fields[attr].deprecated is not None:
                 fullname = _joinNamePath(self._name, self._fields[attr].name)
                 warnings.warn(f"Config field {fullname} is deprecated: {self._fields[attr].deprecated}",
                               FutureWarning, stacklevel=2)
             if at is None:
                 at = getCallStack()
             # This allows Field descriptors to work.
             self._fields[attr].__set__(self, value, at=at, label=label)
         elif hasattr(getattr(self.__class__, attr, None), '__set__'):
             # This allows properties and other non-Field descriptors to work.
             return object.__setattr__(self, attr, value)
         elif attr in self.__dict__ or attr in ("_name", "_history", "_storage", "_frozen", "_imports"):
             # This allows specific private attributes to work.
             self.__dict__[attr] = value
         else:
             # We throw everything else.
             raise AttributeError("%s has no attribute %s" % (_typeStr(self), attr))
  

◆ str()

def lsst.pex.config.config.Config.__str__ ( self )

inherited

Definition at line 1393 of file config.py.

     def __str__(self):
         return str(self.toDict())
  

◆ compare()

def lsst.pex.config.config.Config.compare	(	self,
		other,
		shortcut = `True`,
		rtol = `1E-8`,
		atol = `1E-8`,
		output = `None`
	)

inherited

Compare this configuration to another `~lsst.pex.config.Config` for
equality.

Parameters
----------
other : `lsst.pex.config.Config`
    Other `~lsst.pex.config.Config` object to compare against this
    config.
shortcut : `bool`, optional
    If `True`, return as soon as an inequality is found. Default is
    `True`.
rtol : `float`, optional
    Relative tolerance for floating point comparisons.
atol : `float`, optional
    Absolute tolerance for floating point comparisons.
output : callable, optional
    A callable that takes a string, used (possibly repeatedly) to
    report inequalities.

Returns
-------
isEqual : `bool`
    `True` when the two `lsst.pex.config.Config` instances are equal.
    `False` if there is an inequality.

See also
--------
lsst.pex.config.compareConfigs

Notes
-----
Unselected targets of `~lsst.pex.config.RegistryField` fields and
unselected choices of `~lsst.pex.config.ConfigChoiceField` fields
are not considered by this method.

Floating point comparisons are performed by `numpy.allclose`.

Definition at line 1402 of file config.py.

     def compare(self, other, shortcut=True, rtol=1E-8, atol=1E-8, output=None):
         """Compare this configuration to another `~lsst.pex.config.Config` for
         equality.
  
         Parameters
         ----------
         other : `lsst.pex.config.Config`
             Other `~lsst.pex.config.Config` object to compare against this
             config.
         shortcut : `bool`, optional
             If `True`, return as soon as an inequality is found. Default is
             `True`.
         rtol : `float`, optional
             Relative tolerance for floating point comparisons.
         atol : `float`, optional
             Absolute tolerance for floating point comparisons.
         output : callable, optional
             A callable that takes a string, used (possibly repeatedly) to
             report inequalities.
  
         Returns
         -------
         isEqual : `bool`
             `True` when the two `lsst.pex.config.Config` instances are equal.
             `False` if there is an inequality.
  
         See also
         --------
         lsst.pex.config.compareConfigs
  
         Notes
         -----
         Unselected targets of `~lsst.pex.config.RegistryField` fields and
         unselected choices of `~lsst.pex.config.ConfigChoiceField` fields
         are not considered by this method.
  
         Floating point comparisons are performed by `numpy.allclose`.
         """
         name1 = self._name if self._name is not None else "config"
         name2 = other._name if other._name is not None else "config"
         name = getComparisonName(name1, name2)
         return compareConfigs(name, self, other, shortcut=shortcut,
                               rtol=rtol, atol=atol, output=output)
  

◆ formatHistory()

def lsst.pex.config.config.Config.formatHistory	(		self,
			name,
		**	kwargs
	)

inherited

Format a configuration field's history to a human-readable format.

Parameters
----------
name : `str`
    Name of a `~lsst.pex.config.Field` in this config.
kwargs
    Keyword arguments passed to `lsst.pex.config.history.format`.

Returns
-------
history : `str`
    A string containing the formatted history.

See also
--------
lsst.pex.config.history.format

Definition at line 1311 of file config.py.

     def formatHistory(self, name, **kwargs):
         """Format a configuration field's history to a human-readable format.
  
         Parameters
         ----------
         name : `str`
             Name of a `~lsst.pex.config.Field` in this config.
         kwargs
             Keyword arguments passed to `lsst.pex.config.history.format`.
  
         Returns
         -------
         history : `str`
             A string containing the formatted history.
  
         See also
         --------
         lsst.pex.config.history.format
         """
         import lsst.pex.config.history as pexHist
         return pexHist.format(self, name, **kwargs)
  

◆ freeze()

def lsst.pex.config.config.Config.freeze ( self )

inherited

Make this config, and all subconfigs, read-only.

Definition at line 1177 of file config.py.

     def freeze(self):
         """Make this config, and all subconfigs, read-only.
         """
         self._frozen = True
         for field in self._fields.values():
             field.freeze(self)
  

◆ items()

def lsst.pex.config.config.Config.items ( self )

inherited

Get configurations as ``(field name, field value)`` pairs.

Returns
-------
items : `list`
    List of tuples for each configuration. Tuple items are:

    0. Field name.
    1. Field value.

See also
--------
lsst.pex.config.Config.iteritems

Definition at line 824 of file config.py.

     def items(self):
         """Get configurations as ``(field name, field value)`` pairs.
  
         Returns
         -------
         items : `list`
             List of tuples for each configuration. Tuple items are:
  
             0. Field name.
             1. Field value.
  
         See also
         --------
         lsst.pex.config.Config.iteritems
         """
         return list(self._storage.items())
  

◆ iteritems()

def lsst.pex.config.config.Config.iteritems ( self )

inherited

Iterate over (field name, field value) pairs.

Yields
------
item : `tuple`
    Tuple items are:

    0. Field name.
    1. Field value.

See also
--------
lsst.pex.config.Config.items

Definition at line 841 of file config.py.

     def iteritems(self):
         """Iterate over (field name, field value) pairs.
  
         Yields
         ------
         item : `tuple`
             Tuple items are:
  
             0. Field name.
             1. Field value.
  
         See also
         --------
         lsst.pex.config.Config.items
         """
         return iter(self._storage.items())
  

◆ iterkeys()

def lsst.pex.config.config.Config.iterkeys ( self )

inherited

Iterate over field names

Yields
------
key : `str`
    A field's key (attribute name).

See also
--------
lsst.pex.config.Config.values

Definition at line 872 of file config.py.

     def iterkeys(self):
         """Iterate over field names
  
         Yields
         ------
         key : `str`
             A field's key (attribute name).
  
         See also
         --------
         lsst.pex.config.Config.values
         """
         return iter(self.storage.keys())
  

◆ itervalues()

def lsst.pex.config.config.Config.itervalues ( self )

inherited

Iterate over field values.

Yields
------
value : obj
    A field value.

See also
--------
lsst.pex.config.Config.values

Definition at line 858 of file config.py.

     def itervalues(self):
         """Iterate over field values.
  
         Yields
         ------
         value : obj
             A field value.
  
         See also
         --------
         lsst.pex.config.Config.values
         """
         return iter(self.storage.values())
  

◆ keys()

def lsst.pex.config.config.Config.keys ( self )

inherited

Get field names.

Returns
-------
names : `list`
    List of `lsst.pex.config.Field` names.

See also
--------
lsst.pex.config.Config.iterkeys

Definition at line 796 of file config.py.

     def keys(self):
         """Get field names.
  
         Returns
         -------
         names : `list`
             List of `lsst.pex.config.Field` names.
  
         See also
         --------
         lsst.pex.config.Config.iterkeys
         """
         return list(self._storage.keys())
  

◆ load()

def lsst.pex.config.config.Config.load	(	self,
		filename,
		root = `"config"`
	)

inherited

Modify this config in place by executing the Python code in a
configuration file.

Parameters
----------
filename : `str`
    Name of the configuration file. A configuration file is Python
    module.
root : `str`, optional
    Name of the variable in file that refers to the config being
    overridden.

    For example, the value of root is ``"config"`` and the file
    contains::

        config.myField = 5

    Then this config's field ``myField`` is set to ``5``.

    **Deprecated:** For backwards compatibility, older config files
    that use ``root="root"`` instead of ``root="config"`` will be
    loaded with a warning printed to `sys.stderr`. This feature will be
    removed at some point.

See also
--------
lsst.pex.config.Config.loadFromStream
lsst.pex.config.Config.save
lsst.pex.config.Config.saveFromStream

Definition at line 1012 of file config.py.

     def load(self, filename, root="config"):
         """Modify this config in place by executing the Python code in a
         configuration file.
  
         Parameters
         ----------
         filename : `str`
             Name of the configuration file. A configuration file is Python
             module.
         root : `str`, optional
             Name of the variable in file that refers to the config being
             overridden.
  
             For example, the value of root is ``"config"`` and the file
             contains::
  
                 config.myField = 5
  
             Then this config's field ``myField`` is set to ``5``.
  
             **Deprecated:** For backwards compatibility, older config files
             that use ``root="root"`` instead of ``root="config"`` will be
             loaded with a warning printed to `sys.stderr`. This feature will be
             removed at some point.
  
         See also
         --------
         lsst.pex.config.Config.loadFromStream
         lsst.pex.config.Config.save
         lsst.pex.config.Config.saveFromStream
         """
         with open(filename, "r") as f:
             code = compile(f.read(), filename=filename, mode="exec")
             self.loadFromStream(stream=code, root=root, filename=filename)
  

◆ loadFromStream()

def lsst.pex.config.config.Config.loadFromStream	(	self,
		stream,
		root = `"config"`,
		filename = `None`
	)

inherited

Modify this Config in place by executing the Python code in the
provided stream.

Parameters
----------
stream : file-like object, `str`, or compiled string
    Stream containing configuration override code.
root : `str`, optional
    Name of the variable in file that refers to the config being
    overridden.

    For example, the value of root is ``"config"`` and the file
    contains::

        config.myField = 5

    Then this config's field ``myField`` is set to ``5``.

    **Deprecated:** For backwards compatibility, older config files
    that use ``root="root"`` instead of ``root="config"`` will be
    loaded with a warning printed to `sys.stderr`. This feature will be
    removed at some point.
filename : `str`, optional
    Name of the configuration file, or `None` if unknown or contained
    in the stream. Used for error reporting.

See also
--------
lsst.pex.config.Config.load
lsst.pex.config.Config.save
lsst.pex.config.Config.saveFromStream

Definition at line 1047 of file config.py.

     def loadFromStream(self, stream, root="config", filename=None):
         """Modify this Config in place by executing the Python code in the
         provided stream.
  
         Parameters
         ----------
         stream : file-like object, `str`, or compiled string
             Stream containing configuration override code.
         root : `str`, optional
             Name of the variable in file that refers to the config being
             overridden.
  
             For example, the value of root is ``"config"`` and the file
             contains::
  
                 config.myField = 5
  
             Then this config's field ``myField`` is set to ``5``.
  
             **Deprecated:** For backwards compatibility, older config files
             that use ``root="root"`` instead of ``root="config"`` will be
             loaded with a warning printed to `sys.stderr`. This feature will be
             removed at some point.
         filename : `str`, optional
             Name of the configuration file, or `None` if unknown or contained
             in the stream. Used for error reporting.
  
         See also
         --------
         lsst.pex.config.Config.load
         lsst.pex.config.Config.save
         lsst.pex.config.Config.saveFromStream
         """
         with RecordingImporter() as importer:
             globals = {"__file__": filename}
             try:
                 local = {root: self}
                 exec(stream, globals, local)
             except NameError as e:
                 if root == "config" and "root" in e.args[0]:
                     if filename is None:
                         # try to determine the file name; a compiled string
                         # has attribute "co_filename",
                         # an open file has attribute "name", else give up
                         filename = getattr(stream, "co_filename", None)
                         if filename is None:
                             filename = getattr(stream, "name", "?")
                     print(f"Config override file {filename!r}"
                           " appears to use 'root' instead of 'config'; trying with 'root'", file=sys.stderr)
                     local = {"root": self}
                     exec(stream, globals, local)
                 else:
                     raise
  
         self._imports.update(importer.getModules())
  

◆ names()

def lsst.pex.config.config.Config.names ( self )

inherited

Get all the field names in the config, recursively.

Returns
-------
names : `list` of `str`
    Field names.

Definition at line 1232 of file config.py.

     def names(self):
         """Get all the field names in the config, recursively.
  
         Returns
         -------
         names : `list` of `str`
             Field names.
         """
         #
         # Rather than sort out the recursion all over again use the
         # pre-existing saveToStream()
         #
         with io.StringIO() as strFd:
             self.saveToStream(strFd, "config")
             contents = strFd.getvalue()
             strFd.close()
         #
         # Pull the names out of the dumped config
         #
         keys = []
         for line in contents.split("\n"):
             if re.search(r"^((assert|import)\s+|\s*$|#)", line):
                 continue
  
             mat = re.search(r"^(?:config\.)?([^=]+)\s*=\s*.*", line)
             if mat:
                 keys.append(mat.group(1))
  
         return keys
  

◆ save()

def lsst.pex.config.config.Config.save	(	self,
		filename,
		root = `"config"`
	)

inherited

Save a Python script to the named file, which, when loaded,
reproduces this config.

Parameters
----------
filename : `str`
    Desination filename of this configuration.
root : `str`, optional
    Name to use for the root config variable. The same value must be
    used when loading (see `lsst.pex.config.Config.load`).

See also
--------
lsst.pex.config.Config.saveToStream
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream

Definition at line 1103 of file config.py.

     def save(self, filename, root="config"):
         """Save a Python script to the named file, which, when loaded,
         reproduces this config.
  
         Parameters
         ----------
         filename : `str`
             Desination filename of this configuration.
         root : `str`, optional
             Name to use for the root config variable. The same value must be
             used when loading (see `lsst.pex.config.Config.load`).
  
         See also
         --------
         lsst.pex.config.Config.saveToStream
         lsst.pex.config.Config.load
         lsst.pex.config.Config.loadFromStream
         """
         d = os.path.dirname(filename)
         with tempfile.NamedTemporaryFile(mode="w", delete=False, dir=d) as outfile:
             self.saveToStream(outfile, root)
             # tempfile is hardcoded to create files with mode '0600'
             # for an explantion of these antics see:
             # https://stackoverflow.com/questions/10291131/how-to-use-os-umask-in-python
             umask = os.umask(0o077)
             os.umask(umask)
             os.chmod(outfile.name, (~umask & 0o666))
             # chmod before the move so we get quasi-atomic behavior if the
             # source and dest. are on the same filesystem.
             # os.rename may not work across filesystems
             shutil.move(outfile.name, filename)
  

◆ saveToStream()

def lsst.pex.config.config.Config.saveToStream	(	self,
		outfile,
		root = `"config"`,
		skipImports = `False`
	)

inherited

Save a configuration file to a stream, which, when loaded,
reproduces this config.

Parameters
----------
outfile : file-like object
    Destination file object write the config into. Accepts strings not
    bytes.
root
    Name to use for the root config variable. The same value must be
    used when loading (see `lsst.pex.config.Config.load`).
skipImports : `bool`, optional
    If `True` then do not include ``import`` statements in output,
    this is to support human-oriented output from ``pipetask`` where
    additional clutter is not useful.

See also
--------
lsst.pex.config.Config.save
lsst.pex.config.Config.load
lsst.pex.config.Config.loadFromStream

Definition at line 1135 of file config.py.

     def saveToStream(self, outfile, root="config", skipImports=False):
         """Save a configuration file to a stream, which, when loaded,
         reproduces this config.
  
         Parameters
         ----------
         outfile : file-like object
             Destination file object write the config into. Accepts strings not
             bytes.
         root
             Name to use for the root config variable. The same value must be
             used when loading (see `lsst.pex.config.Config.load`).
         skipImports : `bool`, optional
             If `True` then do not include ``import`` statements in output,
             this is to support human-oriented output from ``pipetask`` where
             additional clutter is not useful.
  
         See also
         --------
         lsst.pex.config.Config.save
         lsst.pex.config.Config.load
         lsst.pex.config.Config.loadFromStream
         """
         tmp = self._name
         self._rename(root)
         try:
             if not skipImports:
                 self._collectImports()
                 # Remove self from the set, as it is handled explicitly below
                 self._imports.remove(self.__module__)
                 configType = type(self)
                 typeString = _typeStr(configType)
                 outfile.write(f"import {configType.__module__}\n")
                 outfile.write(f"assert type({root})=={typeString}, 'config is of type %s.%s instead of "
                               f"{typeString}' % (type({root}).__module__, type({root}).__name__)\n")
                 for imp in self._imports:
                     if imp in sys.modules and sys.modules[imp] is not None:
                         outfile.write(u"import {}\n".format(imp))
             self._save(outfile)
         finally:
             self._rename(tmp)
  

◆ setDefaults()

def lsst.pex.config.config.Config.setDefaults ( self )

inherited

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented in lsst.pipe.tasks.scaleVariance.ScaleVarianceConfig, lsst.pipe.tasks.mocks.mockCoadd.MockCoaddConfig, lsst.pipe.tasks.ingestCuratedCalibs.IngestCuratedCalibsConfig, lsst.pipe.tasks.dataFrameActions._actions.NanoJansky, lsst.pipe.drivers.multiBandDriver.MultiBandDriverConfig, lsst.pipe.drivers.constructCalibs.FringeConfig, lsst.pipe.drivers.constructCalibs.DarkConfig, lsst.pipe.drivers.constructCalibs.CalibConfig, lsst.pipe.drivers.coaddDriver.CoaddDriverConfig, lsst.pipe.drivers.background.MaskObjectsConfig, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedConfig, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFrameConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedConfig, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFrameConfig, lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig, and lsst.ip.diffim.dipoleMeasurement.DipoleMeasurementConfig.

Definition at line 939 of file config.py.

     def setDefaults(self):
         """Subclass hook for computing defaults.
  
         Notes
         -----
         Derived `~lsst.pex.config.Config` classes that must compute defaults
         rather than using the `~lsst.pex.config.Field` instances's defaults
         should do so here. To correctly use inherited defaults,
         implementations of ``setDefaults`` must call their base class's
         ``setDefaults``.
         """
         pass
  

◆ toDict()

def lsst.pex.config.config.Config.toDict ( self )

inherited

Make a dictionary of field names and their values.

Returns
-------
dict_ : `dict`
    Dictionary with keys that are `~lsst.pex.config.Field` names.
    Values are `~lsst.pex.config.Field` values.

See also
--------
lsst.pex.config.Field.toDict

Notes
-----
This method uses the `~lsst.pex.config.Field.toDict` method of
individual fields. Subclasses of `~lsst.pex.config.Field` may need to
implement a ``toDict`` method for *this* method to work.

Definition at line 1208 of file config.py.

     def toDict(self):
         """Make a dictionary of field names and their values.
  
         Returns
         -------
         dict_ : `dict`
             Dictionary with keys that are `~lsst.pex.config.Field` names.
             Values are `~lsst.pex.config.Field` values.
  
         See also
         --------
         lsst.pex.config.Field.toDict
  
         Notes
         -----
         This method uses the `~lsst.pex.config.Field.toDict` method of
         individual fields. Subclasses of `~lsst.pex.config.Field` may need to
         implement a ``toDict`` method for *this* method to work.
         """
         dict_ = {}
         for name, field in self._fields.items():
             dict_[name] = field.toDict(self)
         return dict_
  

◆ update()

def lsst.pex.config.config.Config.update	(		self,
		**	kw
	)

inherited

Update values of fields specified by the keyword arguments.

Parameters
----------
kw
    Keywords are configuration field names. Values are configuration
    field values.

Notes
-----
The ``__at`` and ``__label`` keyword arguments are special internal
keywords. They are used to strip out any internal steps from the
history tracebacks of the config. Do not modify these keywords to
subvert a `~lsst.pex.config.Config` instance's history.

Examples
--------
This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update ``fieldA`` and ``fieldC``:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'

Definition at line 952 of file config.py.

     def update(self, **kw):
         """Update values of fields specified by the keyword arguments.
  
         Parameters
         ----------
         kw
             Keywords are configuration field names. Values are configuration
             field values.
  
         Notes
         -----
         The ``__at`` and ``__label`` keyword arguments are special internal
         keywords. They are used to strip out any internal steps from the
         history tracebacks of the config. Do not modify these keywords to
         subvert a `~lsst.pex.config.Config` instance's history.
  
         Examples
         --------
         This is a config with three fields:
  
         >>> from lsst.pex.config import Config, Field
         >>> class DemoConfig(Config):
         ...     fieldA = Field(doc='Field A', dtype=int, default=42)
         ...     fieldB = Field(doc='Field B', dtype=bool, default=True)
         ...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
         ...
         >>> config = DemoConfig()
  
         These are the default values of each field:
  
         >>> for name, value in config.iteritems():
         ...     print(f"{name}: {value}")
         ...
         fieldA: 42
         fieldB: True
         fieldC: 'Hello world'
  
         Using this method to update ``fieldA`` and ``fieldC``:
  
         >>> config.update(fieldA=13, fieldC='Updated!')
  
         Now the values of each field are:
  
         >>> for name, value in config.iteritems():
         ...     print(f"{name}: {value}")
         ...
         fieldA: 13
         fieldB: True
         fieldC: 'Updated!'
         """
         at = kw.pop("__at", getCallStack())
         label = kw.pop("__label", "update")
  
         for name, value in kw.items():
             try:
                 field = self._fields[name]
                 field.__set__(self, value, at=at, label=label)
             except KeyError:
                 raise KeyError("No field of name %s exists in config type %s" % (name, _typeStr(self)))
  

◆ validate()

def lsst.fgcmcal.sedterms.Sedterm.validate ( self )

Validate the Config, raising an exception if invalid.

Raises
------
lsst.pex.config.FieldValidationError
    Raised if verification fails.

Notes
-----
The base class implementation performs type checks on all fields by
calling their `~lsst.pex.config.Field.validate` methods.

Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in `lsst.pex.config`
that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 121 of file sedterms.py.

     def validate(self):
         Config.validate(self)
         if self.extrapolated:
             if self.primaryBand is None or \
                     self.secondaryBand is None or \
                     self.tertiaryBand is None:
                 raise RuntimeError("extrapolated requires primaryBand, secondaryBand, and "
                                    "tertiaryBand are provided.")
  
  

◆ values()

def lsst.pex.config.config.Config.values ( self )

inherited

Get field values.

Returns
-------
values : `list`
    List of field values.

See also
--------
lsst.pex.config.Config.itervalues

Definition at line 810 of file config.py.

     def values(self):
         """Get field values.
  
         Returns
         -------
         values : `list`
             List of field values.
  
         See also
         --------
         lsst.pex.config.Config.itervalues
         """
         return list(self._storage.values())
  

Member Data Documentation

◆ constant

lsst.fgcmcal.sedterms.Sedterm.constant = Field(dtype=float, default=1.0, doc="Adjustment constant for SED slope")

static

Definition at line 113 of file sedterms.py.

◆ extrapolated

lsst.fgcmcal.sedterms.Sedterm.extrapolated = Field(dtype=bool, default=False, doc="Extrapolate to compute SED slope")

static

Definition at line 112 of file sedterms.py.

◆ primaryBand

lsst.fgcmcal.sedterms.Sedterm.primaryBand

static

Initial value:

= Field(dtype=str, default=None, optional=True,

doc="Primary band name for extrapolation")

Definition at line 114 of file sedterms.py.

◆ primaryTerm

lsst.fgcmcal.sedterms.Sedterm.primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")

static

Definition at line 109 of file sedterms.py.

◆ secondaryBand

lsst.fgcmcal.sedterms.Sedterm.secondaryBand

static

Initial value:

= Field(dtype=str, default=None, optional=True,

doc="Secondary band name for extrapolation")

Definition at line 116 of file sedterms.py.

◆ secondaryTerm

lsst.fgcmcal.sedterms.Sedterm.secondaryTerm

static

Initial value:

= Field(dtype=str, default=None, optional=True,

doc="Name of secondary Sedboundaryterm")

Definition at line 110 of file sedterms.py.

◆ tertiaryBand

lsst.fgcmcal.sedterms.Sedterm.tertiaryBand

static

Initial value:

= Field(dtype=str, default=None, optional=True,

doc="Tertiary band name for extrapolation")

Definition at line 118 of file sedterms.py.

Property Documentation

◆ history

lsst.pex.config.config.Config.history = property(lambda x: x._history)

staticinherited

Definition at line 1333 of file config.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-15-g6a90155+515f58c32b/python/lsst/fgcmcal/sedterms.py

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ __contains__()

◆ __delattr__()

◆ __eq__()

◆ __init_subclass__()

◆ __iter__()

◆ __ne__()

◆ __new__()

◆ __reduce__()

◆ __repr__()

◆ __setattr__() [1/2]

◆ __setattr__() [2/2]

◆ __str__()

◆ compare()

◆ formatHistory()

◆ freeze()

◆ items()

◆ iteritems()

◆ iterkeys()

◆ itervalues()

◆ keys()

◆ load()

◆ loadFromStream()

◆ names()

◆ save()

◆ saveToStream()

◆ setDefaults()

◆ toDict()

◆ update()

◆ validate()

◆ values()

Member Data Documentation

◆ constant

◆ extrapolated

◆ primaryBand

◆ primaryTerm

◆ secondaryBand

◆ secondaryTerm

◆ tertiaryBand

Property Documentation

◆ history

◆ contains()

◆ delattr()

◆ eq()

◆ iter()

◆ ne()

◆ new()

◆ reduce()

◆ repr()

◆ setattr() [1/2]

◆ setattr() [2/2]

◆ str()