LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
get (self, name, default=None) | |
getArray (self, name) | |
getScalar (self, name) | |
set (self, name, value, comment=None) | |
add (self, name, value, comment=None) | |
setComment (self, name, comment) | |
toList (self) | |
toOrderedDict (self) | |
__eq__ (self, other) | |
__copy__ (self) | |
__deepcopy__ (self, memo) | |
__iter__ (self) | |
__setitem__ (self, name, value) | |
__reduce__ (self) | |
NestedMetadataDict | get_dict (self, str key) |
None | set_dict (self, str key, NestedMetadataDict value) |
Public Attributes | |
COMMENTSUFFIX | |
Static Public Attributes | |
str | COMMENTSUFFIX = "#COMMENT" |
toDict = toOrderedDict | |
Protected Attributes | |
_typeMenu | |
Static Protected Attributes | |
dict | _typeMenu |
Definition at line 849 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__copy__ | ( | self | ) |
Definition at line 1062 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__deepcopy__ | ( | self, | |
memo ) |
Definition at line 1069 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__eq__ | ( | self, | |
other ) |
Definition at line 1049 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__iter__ | ( | self | ) |
Definition at line 1074 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__reduce__ | ( | self | ) |
Definition at line 1108 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__setitem__ | ( | self, | |
name, | |||
value ) |
Assigns the supplied value to the container. Parameters ---------- name : `str` Name of item to update. If the name ends with `PropertyList.COMMENTSUFFIX`, the comment is updated rather than the value. value : Value to assign Can be any value supported by the container's ``set()`` method. `~collections.abc.Mapping` are converted to `PropertySet` before assignment. Notes ----- Uses `PropertySet.set`, overwriting any previous value.
Definition at line 1078 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.add | ( | self, | |
name, | |||
value, | |||
comment = None ) |
Append one or more values to a given item, which need not exist If the item exists then the new value(s) are appended; otherwise it is like calling `set` Parameters ---------- name : `str` Name of item value : any supported type Value of item; may be a scalar or array Notes ----- If `value` is an `lsst.daf.base.PropertySet` items are added using dotted names (e.g. if name="a" and value contains an item "b" which is another PropertySet and contains an item "c" which is numeric or string, then the value of "c" is added as "a.b.c", appended to the existing values of "a.b.c" if any (in which case the types must be compatible). Raises ------ lsst::pex::exceptions::TypeError Raise if the type of ``value`` is incompatible with the existing value of the item.
Definition at line 953 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.get | ( | self, | |
name, | |||
default = None ) |
Return an item as a scalar, else default. Identical to `getScalar` except that a default value is returned if the requested key is not present. If an array item is requested the final value in the array will be returned. Parameters ---------- name : ``str`` Name of item default : `object`, optional Default value to use if the named item is not present. Returns ------- value : any type supported by container Single value of any type supported by the container, else the default value if the requested item is not present in the container. For array items the most recently added value is returned.
Definition at line 865 of file propertyContainerContinued.py.
NestedMetadataDict lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.get_dict | ( | self, | |
str | key ) |
Return a possibly-hierarchical nested `dict`. This implements the `lsst.pipe.base.GetDictMetadata` protocol for consistency with `lsst.pipe.base.TaskMetadata` and `PropertySet`. Parameters ---------- key : `str` String key associated with the mapping. May not have a ``.`` character. Returns ------- value : `~collections.abc.Mapping` Possibly-nested mapping, with `str` keys and values that are `int`, `float`, `str`, `bool`, or another `dict` with the same key and value types. Will be empty if ``key`` does not exist.
Definition at line 1116 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.getArray | ( | self, | |
name ) |
Return an item as a list. Parameters ---------- name : `str` Name of item Returns ------- values : `list` of values The contents of the item, guaranteed to be returned as a `list.` Raises ------ KeyError Raised if the item does not exist.
Definition at line 892 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.getScalar | ( | self, | |
name ) |
Return an item as a scalar If the item has more than one value then the last value is returned. Parameters ---------- name : `str` Name of item. Returns ------- value : scalar item Value stored in the item. If the item refers to an array the most recently added value is returned. Raises ------ KeyError Raised if the item does not exist.
Definition at line 912 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.set | ( | self, | |
name, | |||
value, | |||
comment = None ) |
Set the value of an item If the item already exists it is silently replaced; the types need not match. Parameters ---------- name : `str` Name of item value : any supported type Value of item; may be a scalar or array
Definition at line 935 of file propertyContainerContinued.py.
None lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.set_dict | ( | self, | |
str | key, | ||
NestedMetadataDict | value ) |
Assign a possibly-hierarchical nested `dict`. This implements the `lsst.pipe.base.SetDictMetadata` protocol for consistency with `lsst.pipe.base.TaskMetadata` and `PropertySet`. Parameters ---------- key : `str` String key associated with the mapping. May not have a ``.`` character. value : `~collections.abc.Mapping` Possibly-nested mapping, with `str` keys and values that are `int`, `float`, `str`, `bool`, or another `dict` with the same key and value types. Nested keys may not have a ``.`` character.
Definition at line 1146 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.setComment | ( | self, | |
name, | |||
comment ) |
Set the comment for an existing entry. Parameters ---------- name : `str` Name of the key to receive updated comment. comment : `comment` New comment string.
Definition at line 986 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toList | ( | self | ) |
Return a list of tuples of name, value, comment for each property in the order that they were inserted. Returns ------- ret : `list` of `tuple` Tuples of name, value, comment for each property in the order in which they were inserted.
Definition at line 1005 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toOrderedDict | ( | self | ) |
Return an ordered dictionary with all properties in the order that they were inserted. Returns ------- d : `dict` Ordered dictionary with all properties in the order that they were inserted. Comments are not included. Notes ----- As of Python 3.6 dicts retain their insertion order.
Definition at line 1027 of file propertyContainerContinued.py.
|
staticprotected |
Definition at line 851 of file propertyContainerContinued.py.
|
protected |
Definition at line 951 of file propertyContainerContinued.py.
|
static |
Definition at line 861 of file propertyContainerContinued.py.
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.COMMENTSUFFIX |
Definition at line 1096 of file propertyContainerContinued.py.
|
static |
Definition at line 1047 of file propertyContainerContinued.py.