habitat_sim.sensors.SensorSuite class

Holds all the agents sensors. Simply a dictionary with an extra method to lookup the name of a sensor as the key

Methods

def add(self, sensor: sensor.Sensor) -> None
def clear(...)
D.clear() -> None. Remove all items from D.
def copy(...)
D.copy() -> a shallow copy of D
def fromkeys(iterable, value = None, /)
Create a new dictionary with keys from iterable and values set to value.
def get(self, key, default = None, /)
Return the value for key if key is in the dictionary, else default.
def items(...)
D.items() -> a set-like object providing a view on D’s items
def keys(...)
D.keys() -> a set-like object providing a view on D’s keys
def pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised
def popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.
def setdefault(self, key, default = None, /)
Insert key with a value of default if key is not in the dictionary.
def update(...)
D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
def values(...)
D.values() -> an object providing a view on D’s values

Special methods

def __contains__(self, key, /)
True if the dictionary has the specified key, else False.
def __delitem__(self, key, /)
Delete self[key].
def __getitem__(...)
x.__getitem__(y) <==> x[y]
def __iter__(self, /)
Implement iter(self).
def __len__(self, /)
Return len(self).
def __setitem__(self, key, value, /)
Set self[key] to value.
def __sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes

Method documentation

def habitat_sim.sensors.SensorSuite.setdefault(self, key, default = None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.