LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+f5613e8b4f,g1470d8bcf6+190ad2ba91,g14a832a312+311607e4ab,g2079a07aa2+86d27d4dc4,g2305ad1205+a8e3196225,g295015adf3+b67ee847e5,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+a761f810f3,g487adcacf7+17c8fdbcbd,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+65b5bd823e,g5a732f18d5+53520f316c,g64a986408d+f5613e8b4f,g6c1bc301e9+51106c2951,g858d7b2824+f5613e8b4f,g8a8a8dda67+585e252eca,g99cad8db69+6729933424,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+ef4e3a5875,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e9bba80f27,gc120e1dc64+eee469a5e5,gc28159a63d+0e5473021a,gcf0d15dbbd+a761f810f3,gdaeeff99f8+f9a426f77a,ge6526c86ff+d4c1d4bfef,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf1cff7945b+f5613e8b4f,w.2024.16
LSST Data Management Base Package
|
Public Member Functions | |
getOrderedNames (self) | |
__iter__ (self) | |
checkUnits (self, parse_strict='raise') | |
addField (self, field, type=None, doc="", units="", size=None, doReplace=False, parse_strict="raise") | |
extract (self, *patterns, **kwargs) | |
__reduce__ (self) | |
Definition at line 91 of file _schema.py.
lsst.afw.table._schema.Schema.__iter__ | ( | self | ) |
Iterate over the items in the Schema.
Definition at line 108 of file _schema.py.
lsst.afw.table._schema.Schema.__reduce__ | ( | self | ) |
For pickle support.
Definition at line 238 of file _schema.py.
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. units : `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.
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.
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.
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.