ParticipantMetadata#

class mobgap.data.base.ParticipantMetadata[source]#

Bases: TypedDict

The required minimal set of meta-data for the algorithms.

If your dataset has additional metadata, you can subclass this for the type-checking.

Attributes:
height_m

The height of the participant in meters.

sensor_height_m

The height of the lower back sensor in meters.

cohort

The cohort of the participant. If the Mobilise-D data thresholds are used, this should be one of the following: - “HA”: Healthy Adult - “MS”: Multiple Sclerosis - “PD”: Parkinson’s Disease - “COPD”: Chronic Obstructive Pulmonary Disease - “CHF”: Chronic Heart Failure - “PFF”: Primary Frailty Fracture

Otherwise, it can be any string.

Methods

clear()

copy()

fromkeys(iterable[, value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

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

items()

keys()

pop(key[, default])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

setdefault(key[, default])

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

update([E, ]**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]

values()

clear() None.  Remove all items from D.#
copy() a shallow copy of D#
fromkeys(iterable, value=None, /)#

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#

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

items() a set-like object providing a view on D's items#
keys() a set-like object providing a view on D's keys#
pop(key, default=<unrepresentable>, /)#

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(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.

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]

values() an object providing a view on D's values#

Examples using mobgap.data.base.ParticipantMetadata#

Custom Data and Datasets

Custom Data and Datasets