Subject Class¶
Documentation of the Subject class.
- class qmenta.client.Subject(subject_name)¶
Subject class, providing an interface to interact with the subjects stored inside a QMENTA project.
- Parameters
project (Project) – An instantiated Project
- property all_data¶
All the data in the platform about the instantiated subject. Including uploaded files, analysis etc …
- Returns
All the data
- Return type
dict[str] -> x
- property analysis¶
Retrieve all analysis data.
- Returns
List of dictionaries with the data of each analysis performed.
- Return type
list[dict]
- get_all_data(cache=True)¶
- get_parameters(cache=True)¶
Retrieve all of the the users metadata.
- Returns
Dictionary of dictionaries: { ssid1: {‘parameter_name’: ‘value’, … }, ssid2: {}, …}
- Return type
dict[str] -> dict
- property id¶
- property input_containers¶
Retrieves a list of conatiners with the reference to the data uploaded for that user.
- Returns
List of dictionaries with the conatiners info.
- Return type
list[dict]
- property name¶
The display name of the subject instanciated.
- Returns
The name of the subject
- Return type
str
- property parameters¶
Retrieve all of the the users metadata.
- Returns
Dictionary of dictionaries: { ssid1: {‘parameter_name’: ‘value’, … }, ssid2: {}, …}
- Return type
dict[str] -> dict
- set_parameters(ssid, params_dict)¶
Set the value of one or more parameters for the current subject.
- Parameters
ssid (int) – Aan integer indicating which session parameters will be updated.
params_dict (dict) – A dictionary with the names of the parameters to set (param_id), and the corresponding values: {‘param_id’: ‘value’}
- Returns
True if the request was successful, False otherwise.
- Return type
bool
- upload_gametection(path)¶
Upload gametection data to this subject.
- Parameters
path (str) – Path to a zip containing the data.
- Returns
True if correctly uploaded, False otherwise.
- Return type
bool
- upload_mri(path)¶
Upload mri data to this subject.
- Parameters
path (str) – Path to a zip containing the data.
- Returns
True if correctly uploaded, False otherwise.
- Return type
bool
- upload_result(path)¶
Upload result data to this subject.
- Parameters
path (str) – Path to a zip containing the data.
- Returns
True if correctly uploaded, False otherwise.
- Return type
bool