|
lsst.afw g712618294e+4813a5392e
|
Public Member Functions | |
| def | getOrderedNames (self) |
| def | __iter__ (self) |
| def | checkUnits (self, parse_strict='raise') |
| def | addField (self, field, type=None, doc="", units="", size=None, doReplace=False, parse_strict="raise") |
| def | extract (self, *patterns, **kwargs) |
| def | __reduce__ (self) |
Definition at line 91 of file _schema.py.
| def lsst.afw.table._schema.Schema.__iter__ | ( | self | ) |
Iterate over the items in the Schema.
Definition at line 108 of file _schema.py.
| def lsst.afw.table._schema.Schema.__reduce__ | ( | self | ) |
For pickle support.
Definition at line 238 of file _schema.py.
| def lsst.afw.table._schema.Schema.addField | ( | self, | |
| field, | |||
type = None, |
|||
doc = "", |
|||
units = "", |
|||
size = None, |
|||
doReplace = False, |
|||
parse_strict = "raise" |
|||
| ) |
Add a field to the Schema.
Parameters
----------
field : `str` or `Field`
The string name of the Field, or a fully-constructed Field object.
If the latter, all other arguments besides doReplace are ignored.
type : `str`, optional
The type of field to create. Valid types are the keys of the
afw.table.Field dictionary.
doc : `str`
Documentation for the field.
unit : `str`
Units for the field, or an empty string if unitless.
size : `int`
Size of the field; valid for string and array fields only.
doReplace : `bool`
If a field with this name already exists, replace it instead of
raising pex.exceptions.InvalidParameterError.
parse_strict : `str`
One of 'raise' (default), 'warn', or 'strict', indicating how to
handle unrecognized unit strings. See also astropy.units.Unit.
Returns
-------
result :
Result of the `Field` addition.
Definition at line 129 of file _schema.py.
| def lsst.afw.table._schema.Schema.checkUnits | ( | self, | |
parse_strict = 'raise' |
|||
| ) |
Check that all units in the Schema are valid Astropy unit strings.
Parameters
----------
parse_strict : `str`, optional
One of 'raise' (default), 'warn', or 'strict', indicating how to
handle unrecognized unit strings. See also astropy.units.Unit.
Definition at line 115 of file _schema.py.
| def lsst.afw.table._schema.Schema.extract | ( | self, | |
| * | patterns, | ||
| ** | kwargs | ||
| ) |
Extract a dictionary of {<name>: <schema-item>} in which the field
names match the given shell-style glob pattern(s).
Any number of glob patterns may be passed; the result will be the
union of all the result of each glob considered separately.
Parameters
----------
patterns : Array of `str`
List of glob patterns to use to select field names.
kwargs : `dict`
Dictionary of additional keyword arguments. May contain:
``regex`` : `str` or `re` pattern
A regular expression to be used in addition to any
glob patterns passed as positional arguments. Note
that this will be compared with re.match, not
re.search.
``sub`` : `str`
A replacement string (see re.MatchObject.expand) used
to set the dictionary keys of any fields matched by
regex.
``ordered`` : `bool`, optional
If True, a collections.OrderedDict will be returned
instead of a standard dict, with the order
corresponding to the definition order of the
Schema. Default is False.
Returns
-------
d : `dict`
Dictionary of extracted name-schema item sets.
Raises
------
ValueError
Raised if the `sub` keyword argument is invalid without
the `regex` argument.
Also raised if an unknown keyword argument is supplied.
Definition at line 164 of file _schema.py.
| def lsst.afw.table._schema.Schema.getOrderedNames | ( | self | ) |
Return a list of field names in the order the fields were added to the Schema.
Returns
-------
names : `List`
Field names in order they were added to the Schema.
Definition at line 93 of file _schema.py.