pycpshealthcare.db.Marcoleta package
Submodules
pycpshealthcare.db.Marcoleta.functions module
- pycpshealthcare.db.Marcoleta.functions.get_marcoleta_metadata_results(test_ids, collection, timestamp_start, timestamp_end, metadata_type)[source]
A function that generates a MongoDB query from arguments for the specified collection.
- Returns:
An iterable with the database query results.
- Return type:
- Parameters:
test_ids (list of int) – A list of test ids to query.
collection (pymongo.collection.Collection) – The collection of the sensor to query.
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
metadata_type (str) – The type of metadata to be queried.
- pycpshealthcare.db.Marcoleta.functions.get_marcoleta_sensor_results(test_ids, collection, timestamp_start, timestamp_end, values, time_sorted=True)[source]
A function that generates a MongoDB query from arguments for the specified collection.
- Returns:
An iterable with the database query results.
- Return type:
- Parameters:
test_ids (list<int>) – A list of test ids to query.
collection (pymongo.collection.Collection) – The collection of the sensor to query.
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- pycpshealthcare.db.Marcoleta.functions.get_marcoleta_sensor_results_grouped(test_ids, collection, timestamp_start, timestamp_end, values, bin_size=60, bin_unit='minute')[source]
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
pycpshealthcare.db.Marcoleta.study module
- class pycpshealthcare.db.Marcoleta.study.MarcoletaStudy(connection)[source]
Bases:
objectA study class. Has methods for getting the data of all the sensors and measures of the respective study. A study is defined as all the test ocurrences of a corresponding study type for all the participant.
- get_autoreports_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_autoreports_results_grouped(timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- get_fitbit_v2_metadata_results(metadata_type, timestamp_start=None, timestamp_end=None, test_ids='all')[source]
- get_fitbit_v2_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_fitbit_v2_results_grouped(timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- get_holter_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_holter_results_grouped(timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- pycpshealthcare.db.Marcoleta.study.value(self, timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
pycpshealthcare.db.Marcoleta.participant_study module
- class pycpshealthcare.db.Marcoleta.participant_study.MarcoletaStudyOcurrence(study_info, connection)[source]
Bases:
objectA study ocurrence class. Has methods for getting the data of all the sensors and measures of the respective study. An ocurrence is defined as a unit test and is related to only one participant.
- get_autoreports_results(timestamp_start=None, timestamp_end=None, values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_fitbit_v2_metadata_results(metadata_type, timestamp_start=None, timestamp_end=None, test_ids='all')[source]
- get_fitbit_v2_results(timestamp_start=None, timestamp_end=None, values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_fitbit_v2_results_grouped(timestamp_start=None, timestamp_end=None, values='all', bin_size=60, bin_unit='minute')[source]
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- get_holter_results(timestamp_start=None, timestamp_end=None, values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_holter_results_grouped(timestamp_start=None, timestamp_end=None, values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- class pycpshealthcare.db.Marcoleta.participant_study.ParticipantMarcoletaStudiesGroup(data, connection)[source]
Bases:
objectA participant studies group class. Has methods for getting the data of all the sensors and measures of the respective studies group. A participant studies group is defined as all the ocurrences of a corresponding study type for a specific participant and is related to only one participant.
- get_autoreports_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_fitbit_v2_metadata_results(metadata_type, timestamp_start=None, timestamp_end=None, test_ids='all')[source]
- get_fitbit_v2_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_fitbit_v2_results_grouped(timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- get_holter_results(timestamp_start=None, timestamp_end=None, test_ids='all', values='all')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
- get_holter_results_grouped(timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.
- pycpshealthcare.db.Marcoleta.participant_study.value(self, timestamp_start=None, timestamp_end=None, test_ids='all', values='all', bin_size=60, bin_unit='minute')
- Returns:
an iterable with the query results
- Return type:
- Parameters:
timestamp_start (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results from start of records.
timestamp_end (datetime.datetime|None, optional) – Datetime start filter for query. If not specified query will bring results to end of records.
test_ids (int|list<int>|None, optional) – The ids of the tests to be queried, defaults to “all” that brings data of all the test ids.
values (str|list<str>|None, optional) – The names (keys) of the values of the sensors to be returned by the query, defaults to “all” that brings
bin_size (int, optional) – The width of the mobile window, defaults to 60.
bin_unit (str, optional) – The unit of the mobile window, defaults to minute. Options are minute, hour, day.