rtCommon.structDict
- StructDictClass - contains classes StructDict and MatlabStructDict to make it
possible to access a dictionary with syntax struct.field.
Module Contents
Classes
Class that adds a structure type syntax to dictionaries, |
|
Subclass dictionary so that elements can be accessed either as dict['key'] |
Functions
|
|
|
Given a recursive dictionary, i.e. a dictionary that has |
|
Given a recursive StructDict, i.e. that has child StructDicts |
|
Convert a NumPy structured array to a dictionary. |
|
Return True if var is a numpy structured array |
Attributes
- class rtCommon.structDict.StructDict
Bases:
dict
Class that adds a structure type syntax to dictionaries, i.e. ‘dict.field’ will invoke dict[‘field’]
- __getattr__(key)
Implement getattr to support syntax “data.field”
- __setattr__(key, val)
Implement setattr to support syntax “data.field=x”
- __delattr__(key)
Implement delattr to support syntax “del data.field”
- __getstate__()
Needed for pickling, return the underlying dictionary
- __setstate__(dict_entries)
Needed for pickling, set the underlying dictionary
- copy()
D.copy() -> a shallow copy of D
- rtCommon.structDict.copy_toplevel(data)
- rtCommon.structDict.recurseCreateStructDict(data)
Given a recursive dictionary, i.e. a dictionary that has child dictionaries or lists of dictionaries, convert each child dictionary to a StructDict.
- rtCommon.structDict.structDictType
- rtCommon.structDict.recurseSDtoDict(data)
Given a recursive StructDict, i.e. that has child StructDicts or lists of StructDict, convert each child StructDict to a Dictionary.
- class rtCommon.structDict.MatlabStructDict(dictionary, name=None)
Bases:
StructDict
Subclass dictionary so that elements can be accessed either as dict[‘key’] of dict.key. If elements are of type NumPy structured arrays, convert them to dictionaries and then to MatlabStructDict also.
- __getattr__(key)
Implement getattr to support syntax x=data.field
- __setattr__(key, val)
Implement setattr to support syntax data.field=x
- copy()
D.copy() -> a shallow copy of D
- fields()
list all fields including subfields of the special ‘name’ field
- rtCommon.structDict.convertStructuredArrayToDict(sArray)
Convert a NumPy structured array to a dictionary.
- rtCommon.structDict.isStructuredArray(var) bool
Return True if var is a numpy structured array