lsst.meas.base.forcedPhotCcd.ForcedPhotCcdConfig Class Reference

Inheritance diagram for lsst.meas.base.forcedPhotCcd.ForcedPhotCcdConfig:

Public Member Functions
def	setDefaults (self)
def	__iter__ (self)
	Iterate over fields. More...
def	keys (self)
	Return the list of field names. More...
def	values (self)
	Return the list of field values. More...
def	items (self)
	Return the list of (field name, field value) pairs. More...
def	iteritems (self)
	Iterate over (field name, field value) pairs. More...
def	itervalues (self)
	Iterate over field values. More...
def	iterkeys (self)
	Iterate over field names. More...
def	__contains__ (self, name)
	Return True if the specified field exists in this config. More...
def	__new__ (cls, args, kw)
	Allocate a new Config object. More...
def	__reduce__ (self)
def	update (self, kw)
	Update values specified by the keyword arguments. More...
def	load (self, filename, root="config")
	Modify this config in place by executing the Python code in the named file. More...
def	loadFromStream (self, stream, root="config", filename=None)
	Modify this config in place by executing the python code in the provided stream. More...
def	save (self, filename, root="config")
	Save a python script to the named file, which, when loaded, reproduces this Config. More...
def	saveToStream (self, outfile, root="config")
	Save a python script to a stream, which, when loaded, reproduces this Config. More...
def	freeze (self)
	Make this Config and all sub-configs read-only. More...
def	toDict (self)
	Return a dict of field name: value. More...
def	names (self)
	Return all the keys in a config recursively. More...
def	validate (self)
	Validate the Config; raise an exception if invalid. More...
def	formatHistory (self, name, kwargs)
	Format the specified config field's history to a more human-readable format. More...
def	__setattr__ (self, attr, value, at=None, label="assignment")
	Regulate which attributes can be set. More...
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)
	Compare two Configs for equality; return True if equal. More...

Static Public Attributes
	doApplyUberCal
	references
	measurement
	coaddName
	doApCorr
	applyApCorr
	catalogCalculation

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

Detailed Description

Definition at line 141 of file forcedPhotCcd.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.

Parameters

[in]

name

field name to test for

Definition at line 454 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 746 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 754 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

__iter__()

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

inherited

Iterate over fields.

Definition at line 419 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 767 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 Config object.

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

This ensures that even if a derived Config class implements init, the author does not need to be concerned about when or even if he should call the base Config.__init__

Definition at line 461 of file config.py.

    def __new__(cls, *args, **kw):
        """!Allocate a new Config object.

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

        This ensures that even if a derived Config class implements __init__,
        the author does not need to be concerned about when or even if he
        should call the base Config.__init__
        """
        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 Config, since it may contain lambdas
(as the 'check' elements) that cannot be pickled.

Definition at line 493 of file config.py.

    def __reduce__(self):
        """Reduction for pickling (function with arguments to reproduce).

        We need to condense and reconstitute the 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 773 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 110 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

Regulate which attributes can be set.

Unlike normal python objects, 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 720 of file config.py.

    def __setattr__(self, attr, value, at=None, label="assignment"):
        """!Regulate which attributes can be set

        Unlike normal python objects, 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 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 770 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 two Configs for equality; return True if equal.

If the Configs contain RegistryFields or ConfigChoiceFields, unselected Configs will not be compared.

Parameters

[in]	other	Config object to compare with self.
[in]	shortcut	If True, return as soon as an inequality is found.
[in]	rtol	Relative tolerance for floating point comparisons.
[in]	atol	Absolute tolerance for floating point comparisons.
[in]	output	If not None, a callable that takes a string, used (possibly repeatedly) to report inequalities.

Floating point comparisons are performed by numpy.allclose; refer to that for details.

Definition at line 779 of file config.py.

    def compare(self, other, shortcut=True, rtol=1E-8, atol=1E-8, output=None):
        """!Compare two Configs for equality; return True if equal

        If the Configs contain RegistryFields or ConfigChoiceFields, unselected Configs
        will not be compared.

        @param[in] other      Config object to compare with self.
        @param[in] shortcut   If True, return as soon as an inequality is found.
        @param[in] rtol       Relative tolerance for floating point comparisons.
        @param[in] atol       Absolute tolerance for floating point comparisons.
        @param[in] output     If not None, a callable that takes a string, used (possibly repeatedly)
                              to report inequalities.

        Floating point comparisons are performed by numpy.allclose; refer to that for details.
        """
        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 the specified config field's history to a more human-readable format.

Parameters

[in]	name	name of field whose history is wanted
[in]	kwargs	keyword arguments for lsst.pex.config.history.format

Returns

a string containing the formatted history

Definition at line 705 of file config.py.

    def formatHistory(self, name, **kwargs):
        """!Format the specified config field's history to a more human-readable format

        @param[in] name  name of field whose history is wanted
        @param[in] kwargs  keyword arguments for lsst.pex.config.history.format
        @return a string containing the formatted history
        """
        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 sub-configs read-only.

Definition at line 624 of file config.py.

    def freeze(self):
        """!Make this Config and all sub-configs read-only
        """
        self._frozen = True
        for field in self._fields.values():
            field.freeze(self)

items()

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

inherited

Return the list of (field name, field value) pairs.

Definition at line 434 of file config.py.

    def items(self):
        """!Return the list of (field name, field value) pairs
        """
        return list(self._storage.items())

iteritems()

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

inherited

Iterate over (field name, field value) pairs.

Definition at line 439 of file config.py.

    def iteritems(self):
        """!Iterate over (field name, field value) pairs
        """
        return iter(self._storage.items())

iterkeys()

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

inherited

Iterate over field names.

Definition at line 449 of file config.py.

    def iterkeys(self):
        """!Iterate over field names
        """
        return iter(self.storage.keys())

itervalues()

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

inherited

Iterate over field values.

Definition at line 444 of file config.py.

    def itervalues(self):
        """!Iterate over field values
        """
        return iter(self.storage.values())

keys()

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

inherited

Return the list of field names.

Definition at line 424 of file config.py.

    def keys(self):
        """!Return the list of field names
        """
        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 the named file.

Parameters

[in]	filename	name of file containing config override code
[in]	root	name of variable in file that refers to the config being overridden

For example: if the value of root is "config" and the file contains this text: "config.myField = 5" then this config's field "myField" is set to 5.

Deprecated:

For purposes of 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.

Definition at line 531 of file config.py.

    def load(self, filename, root="config"):
        """!Modify this config in place by executing the Python code in the named file.

        @param[in] filename  name of file containing config override code
        @param[in] root  name of variable in file that refers to the config being overridden

        For example: if the value of root is "config" and the file contains this text:
        "config.myField = 5" then this config's field "myField" is set to 5.

        @deprecated For purposes of 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.
        """
        with open(filename, "r") as f:
            code = compile(f.read(), filename=filename, mode="exec")
            self.loadFromStream(stream=code, root=root)

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

[in]	stream	open file object, string or compiled string containing config override code
[in]	root	name of variable in stream that refers to the config being overridden
[in]	filename	name of config override file, or None if unknown or contained in the stream; used for error reporting

For example: if the value of root is "config" and the stream contains this text: "config.myField = 5" then this config's field "myField" is set to 5.

Deprecated:

For purposes of 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.

Definition at line 548 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.

        @param[in] stream  open file object, string or compiled string containing config override code
        @param[in] root  name of variable in stream that refers to the config being overridden
        @param[in] filename  name of config override file, or None if unknown or contained
            in the stream; used for error reporting

        For example: if the value of root is "config" and the stream contains this text:
        "config.myField = 5" then this config's field "myField" is set to 5.

        @deprecated For purposes of 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.
        """
        with RecordingImporter() as importer:
            try:
                local = {root: self}
                exec(stream, {}, 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, {}, local)
                else:
                    raise

        self._imports.update(importer.getModules())

names()

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

inherited

Return all the keys in a config recursively.

Definition at line 651 of file config.py.

    def names(self):
        """!Return all the keys in a config recursively
        """
        #
        # 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

[in]	filename	name of file to which to write the config
[in]	root	name to use for the root config variable; the same value must be used when loading

Definition at line 584 of file config.py.

    def save(self, filename, root="config"):
        """!Save a python script to the named file, which, when loaded, reproduces this Config

        @param[in] filename  name of file to which to write the config
        @param[in] root  name to use for the root config variable; the same value must be used when loading
        """
        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"  )

inherited

Save a python script to a stream, which, when loaded, reproduces this Config.

Parameters

outfile	[inout] open file object to which to write the config. Accepts strings not bytes.
root	[in] name to use for the root config variable; the same value must be used when loading

Definition at line 604 of file config.py.

    def saveToStream(self, outfile, root="config"):
        """!Save a python script to a stream, which, when loaded, reproduces this Config

        @param outfile [inout] open file object to which to write the config. Accepts strings not bytes.
        @param root [in] name to use for the root config variable; the same value must be used when loading
        """
        tmp = self._name
        self._rename(root)
        try:
            configType = type(self)
            typeString = _typeStr(configType)
            outfile.write(u"import {}\n".format(configType.__module__))
            outfile.write(u"assert type({})=={}, 'config is of type %s.%s ".format(root, typeString))
            outfile.write(u"instead of {}' % (type({}).__module__, type({}).__name__)\n".format(typeString,
                                                                                                root,
                                                                                                root))
            self._save(outfile)
        finally:
            self._rename(tmp)

setDefaults()

def lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.setDefaults (   self )

inherited

Definition at line 72 of file forcedPhotImage.py.

    def setDefaults(self):
        # Docstring inherited.
        # Make catalogCalculation a no-op by default as no modelFlux is setup by default in
        # ForcedMeasurementTask
        self.catalogCalculation.plugins.names = []

toDict()

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

inherited

Return a dict of field name: value.

Correct behavior is dependent on proper implementation of Field.toDict. If implementing a new Field type, you may need to implement your own toDict method.

Definition at line 640 of file config.py.

    def toDict(self):
        """!Return a dict of field name: value

        Correct behavior is dependent on proper implementation of  Field.toDict. If implementing a new
        Field type, you may need to implement your own toDict method.
        """
        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 specified by the keyword arguments.

Warning

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. Modifying these keywords allows users to lie about a Config's history. Please do not do so!

Definition at line 513 of file config.py.

    def update(self, **kw):
        """!Update values specified by the keyword arguments

        @warning 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. Modifying these keywords allows users
        to lie about a Config's history. Please do not do so!
        """
        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.pex.config.config.Config.validate (   self )

inherited

Validate the Config; raise an exception if invalid.

The base class implementation performs type checks on all fields by calling Field.validate().

Complex single-field validation can be defined by deriving new Field types. As syntactic sugar, some derived Field types are defined in this module which handle recursing into sub-configs (ConfigField, ConfigChoiceField)

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete

Definition at line 688 of file config.py.

    def validate(self):
        """!Validate the Config; raise an exception if invalid

        The base class implementation performs type checks on all fields by
        calling Field.validate().

        Complex single-field validation can be defined by deriving new Field
        types. As syntactic sugar, some derived Field types are defined in
        this module which handle recursing into sub-configs
        (ConfigField, ConfigChoiceField)

        Inter-field relationships should only be checked in derived Config
        classes after calling this method, and base validation is complete
        """
        for field in self._fields.values():
            field.validate(self)

values()

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

inherited

Return the list of field values.

Definition at line 429 of file config.py.

    def values(self):
        """!Return the list of field values
        """
        return list(self._storage.values())

Member Data Documentation

applyApCorr

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.applyApCorr

staticinherited

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=ApplyApCorrTask,
        doc="Subtask to apply aperture corrections"
    )

Definition at line 63 of file forcedPhotImage.py.

catalogCalculation

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.catalogCalculation

staticinherited

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=CatalogCalculationTask,
        doc="Subtask to run catalogCalculation plugins on catalog"
    )

Definition at line 67 of file forcedPhotImage.py.

coaddName

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.coaddName

staticinherited

Initial value:

=  lsst.pex.config.Field(
        doc="coadd name: typically one of deep or goodSeeing",
        dtype=str,
        default="deep",
    )

Definition at line 53 of file forcedPhotImage.py.

doApCorr

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.doApCorr

staticinherited

Initial value:

=  lsst.pex.config.Field(
        dtype=bool,
        default=True,
        doc="Run subtask to apply aperture corrections"
    )

Definition at line 58 of file forcedPhotImage.py.

doApplyUberCal

lsst.meas.base.forcedPhotCcd.ForcedPhotCcdConfig.doApplyUberCal

static

Initial value:

=  lsst.pex.config.Field(
        dtype=bool,
        doc="Apply meas_mosaic ubercal results to input calexps?",
        default=False
    )

Definition at line 142 of file forcedPhotCcd.py.

measurement

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.measurement

staticinherited

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=ForcedMeasurementTask,
        doc="subtask to do forced measurement"
    )

Definition at line 49 of file forcedPhotImage.py.

references

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.references

staticinherited

Initial value:

=  lsst.pex.config.ConfigurableField(
        target=MultiBandReferencesTask,
        doc="subtask to retrieve reference source catalog"
    )

Definition at line 45 of file forcedPhotImage.py.

Property Documentation

history

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

staticinherited

Definition at line 718 of file config.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/meas_base/16.0-18-ga4d4bcb+1/python/lsst/meas/base/forcedPhotCcd.py