MY Sleep Scoring API
Table of Contents:
Cerebra - MY Sleep Scoring API Guide
MY Sleep Scoring API
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
add_autoscoring_task_to_cloud_tasks() (in module app.utils.gcs)
addPermissionsFromRole() (in module app.controllers.user)
app
module
app.config
module
app.config.config
module
app.controllers
module
app.controllers.channelmapping
module
app.controllers.processinghistory
module
app.controllers.user
module
app.db
module
app.db.database
module
app.dependencies
module
app.main
module
app.models
module
app.models.channelmapping
module
app.models.processinghistory
module
app.models.study
module
app.models.user
module
app.routers
module
app.routers.channelmappings
module
app.routers.tests
module
app.tests
module
app.tests.test_main
module
app.utils
module
app.utils.gcs
module
app.utils.utils
module
app.validators
module
app.validators.channelmapping
module
app.validators.processinghistory
module
app.validators.user
module
app_name (app.config.config.Settings attribute)
audio (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
audio_index (app.models.channelmapping.ChannelMapping attribute)
AUTH0_ALGORITHMS (app.config.config.Settings attribute)
AUTH0_API_AUDIENCE (app.config.config.Settings attribute)
auth0_subject (app.models.user.User attribute)
(app.validators.user.User attribute)
AUTOSCORING_TOKEN (app.config.config.Settings attribute)
AUTOSCORING_URL (app.config.config.Settings attribute)
B
Bearer Token
C
channel_index (app.validators.channelmapping.PositionChannelBase attribute)
(app.validators.channelmapping.SingleChannelBase attribute)
channel_name (app.validators.channelmapping.PositionChannelBase attribute)
(app.validators.channelmapping.SingleChannelBase attribute)
channelLookupDict() (app.models.channelmapping.ChannelMapping method)
ChannelMapping (class in app.models.channelmapping)
(class in app.validators.channelmapping)
channelmapping_dict_to_model() (in module app.controllers.channelmapping)
ChannelMappingBase (class in app.validators.channelmapping)
ChannelMappingCreate (class in app.validators.channelmapping)
ChannelMappingCreateFromScoringRun (class in app.validators.channelmapping)
ChannelMappingToAutoScoringChannelType (class in app.models.channelmapping)
check_blob_exists() (in module app.utils.gcs)
chin (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
chin_index (app.models.channelmapping.ChannelMapping attribute)
CLOUD_TASK_AUTOSCORING_ID (app.config.config.Settings attribute)
CLOUD_TASK_EDFVALIDATOR_ID (app.config.config.Settings attribute)
compliance_log() (in module app.utils.utils)
copy_blob() (in module app.utils.gcs)
CORS_ALLOWED_ORIGINS (app.config.config.Settings attribute)
cpapflow (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
cpapflow_index (app.models.channelmapping.ChannelMapping attribute)
create_blob() (in module app.utils.gcs)
create_channelmapping() (in module app.controllers.channelmapping)
(in module app.routers.channelmappings)
create_processing_history() (in module app.controllers.processinghistory)
create_user() (in module app.controllers.user)
D
date_created (app.models.channelmapping.ChannelMapping attribute)
(app.models.processinghistory.ProcessingHistory attribute)
(app.models.study.Study attribute)
(app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
date_modified (app.models.channelmapping.ChannelMapping attribute)
(app.models.study.Study attribute)
(app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
DB_ADDITIONAL_PARAMETERS (app.config.config.Settings attribute)
DB_NAME (app.config.config.Settings attribute)
DB_URL (app.config.config.Settings attribute)
DB_USERNAME (app.config.config.Settings attribute)
delete_blob() (in module app.utils.gcs)
delete_channelmapping() (in module app.routers.channelmappings)
delete_channelmapping_by_user_and_id() (in module app.controllers.channelmapping)
description (app.models.study.Study attribute)
download_blob_as_bytes() (in module app.utils.gcs)
download_blob_as_string() (in module app.utils.gcs)
download_public_certs() (app.utils.utils.verify_token_oidc method)
E
EDFVALIDATOR_URL (app.config.config.Settings attribute)
EEG
eeg_left (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
eeg_left_index (app.models.channelmapping.ChannelMapping attribute)
eeg_right (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
eeg_right_index (app.models.channelmapping.ChannelMapping attribute)
EKG
ekg (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
ekg_index (app.models.channelmapping.ChannelMapping attribute)
email (app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserCreate attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
EMG
ENVIRONMENT (app.config.config.Settings attribute)
EOG
epap (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
epap_index (app.models.channelmapping.ChannelMapping attribute)
Epoch
etc02 (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
etc02_index (app.models.channelmapping.ChannelMapping attribute)
eye_left (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
eye_left_index (app.models.channelmapping.ChannelMapping attribute)
eye_right (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
eye_right_index (app.models.channelmapping.ChannelMapping attribute)
F
File Object
file_list (app.models.study.Study attribute)
files (app.models.channelmapping.ChannelMapping attribute)
(app.models.user.User attribute)
findAutoScoringChannelName() (app.models.channelmapping.ChannelMapping method)
G
GCP_PROJECT_NAME (app.config.config.Settings attribute)
GCS_FILEUPLOAD_BUCKET (app.config.config.Settings attribute)
GCS_FILEUPLOAD_BUCKET_PREFIX (app.config.config.Settings attribute)
generate_autoscoring_task_autoscoringconfig() (in module app.utils.gcs)
generate_autoscoring_task_channelmapping() (in module app.utils.gcs)
get_channelmapping() (in module app.routers.channelmappings)
get_channelmapping_by_user_and_id() (in module app.controllers.channelmapping)
get_channelmappings() (in module app.controllers.channelmapping)
(in module app.routers.channelmappings)
get_db() (in module app.db.database)
get_or_create_user_from_token() (in module app.controllers.user)
get_presigned_gcs_url() (in module app.utils.gcs)
get_settings() (in module app.config.config)
get_storage_client() (in module app.utils.gcs)
get_tasks_client() (in module app.utils.gcs)
get_user() (in module app.controllers.user)
get_users() (in module app.controllers.user)
getPositionValueMappingDict() (app.models.channelmapping.ChannelMapping method)
GOOGLE_IDENTITY_API_KEY (app.config.config.Settings attribute)
GOOGLE_IDENTITY_REFRESH_TOKEN_URL (app.config.config.Settings attribute)
GOOGLE_INTERNAL_METADATA_URL (app.config.config.Settings attribute)
H
hasPermission() (app.validators.user.User method)
I
id (app.models.channelmapping.ChannelMapping attribute)
(app.models.processinghistory.ProcessingHistory attribute)
(app.models.study.Study attribute)
(app.models.user.User attribute)
(app.validators.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingCreateFromScoringRun attribute)
(app.validators.user.User attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
info() (in module app.main)
intercostal_left (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
intercostal_left_index (app.models.channelmapping.ChannelMapping attribute)
intercostal_right (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
intercostal_right_index (app.models.channelmapping.ChannelMapping attribute)
ipap (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
ipap_index (app.models.channelmapping.ChannelMapping attribute)
is_active (app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserPatch attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
L
left_value (app.validators.channelmapping.PositionChannelBase attribute)
leg_left (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
leg_left_index (app.models.channelmapping.ChannelMapping attribute)
leg_right (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
leg_right_index (app.models.channelmapping.ChannelMapping attribute)
Level I
Level II
Level III
light (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
light_index (app.models.channelmapping.ChannelMapping attribute)
lights_from_seconds_to_epoch() (in module app.utils.utils)
lights_on_calculation() (in module app.utils.utils)
list_blobs() (in module app.utils.gcs)
LOG_NAME (app.config.config.Settings attribute)
M
M2M_ISSUER (app.config.config.Settings attribute)
M2M_X509_URL (app.config.config.Settings attribute)
mastoid (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
mastoid_index (app.models.channelmapping.ChannelMapping attribute)
MAX_PER_PAGE (app.config.config.Settings attribute)
model_computed_fields (app.config.config.Settings attribute)
(app.validators.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
(app.validators.channelmapping.ChannelMappingCreate attribute)
(app.validators.channelmapping.ChannelMappingCreateFromScoringRun attribute)
(app.validators.channelmapping.PositionChannelBase attribute)
(app.validators.channelmapping.SingleChannelBase attribute)
(app.validators.processinghistory.ProcessingHistoryCreate attribute)
(app.validators.user.User attribute)
(app.validators.user.UserBase attribute)
(app.validators.user.UserCreate attribute)
(app.validators.user.UserPatch attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
model_config (app.config.config.Settings attribute)
(app.validators.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
(app.validators.channelmapping.ChannelMappingCreate attribute)
(app.validators.channelmapping.ChannelMappingCreateFromScoringRun attribute)
(app.validators.channelmapping.PositionChannelBase attribute)
(app.validators.channelmapping.SingleChannelBase attribute)
(app.validators.processinghistory.ProcessingHistoryCreate attribute)
(app.validators.user.User attribute)
(app.validators.user.UserBase attribute)
(app.validators.user.UserCreate attribute)
(app.validators.user.UserPatch attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
model_fields (app.config.config.Settings attribute)
(app.validators.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
(app.validators.channelmapping.ChannelMappingCreate attribute)
(app.validators.channelmapping.ChannelMappingCreateFromScoringRun attribute)
(app.validators.channelmapping.PositionChannelBase attribute)
(app.validators.channelmapping.SingleChannelBase attribute)
(app.validators.processinghistory.ProcessingHistoryCreate attribute)
(app.validators.user.User attribute)
(app.validators.user.UserBase attribute)
(app.validators.user.UserCreate attribute)
(app.validators.user.UserPatch attribute)
(app.validators.user.UserResponseInStudyList attribute)
(app.validators.user.UserResponseSmall attribute)
model_validator() (app.validators.channelmapping.ChannelMapping class method)
(app.validators.user.User class method)
module
app
app.config
app.config.config
app.controllers
app.controllers.channelmapping
app.controllers.processinghistory
app.controllers.user
app.db
app.db.database
app.dependencies
app.main
app.models
app.models.channelmapping
app.models.processinghistory
app.models.study
app.models.user
app.routers
app.routers.channelmappings
app.routers.tests
app.tests
app.tests.test_main
app.utils
app.utils.gcs
app.utils.utils
app.validators
app.validators.channelmapping
app.validators.processinghistory
app.validators.user
N
name (app.models.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
NREM
O
ORP
oxygen_sat (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
oxygen_sat_index (app.models.channelmapping.ChannelMapping attribute)
P
password (app.validators.user.UserCreate attribute)
password_min_length() (app.validators.user.UserCreate class method)
permissions (app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserResponseSmall attribute)
PLM
position (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
position_index (app.models.channelmapping.ChannelMapping attribute)
position_left_value (app.models.channelmapping.ChannelMapping attribute)
position_prone_value (app.models.channelmapping.ChannelMapping attribute)
position_right_value (app.models.channelmapping.ChannelMapping attribute)
position_supine_value (app.models.channelmapping.ChannelMapping attribute)
position_unknown_value (app.models.channelmapping.ChannelMapping attribute)
position_upright_value (app.models.channelmapping.ChannelMapping attribute)
PositionChannelBase (class in app.validators.channelmapping)
processinghistories (app.models.user.User attribute)
ProcessingHistory (class in app.models.processinghistory)
ProcessingHistoryCreate (class in app.validators.processinghistory)
prone_value (app.validators.channelmapping.PositionChannelBase attribute)
pulse (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
pulse_index (app.models.channelmapping.ChannelMapping attribute)
R
REDIS_AUTH_STRING (app.config.config.Settings attribute)
REDIS_HOST (app.config.config.Settings attribute)
REDIS_PORT (app.config.config.Settings attribute)
Refresh Token
requested_permission (app.validators.user.UserBase attribute)
resp_abdomen (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
resp_abdomen_index (app.models.channelmapping.ChannelMapping attribute)
resp_cannula (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
resp_cannula_index (app.models.channelmapping.ChannelMapping attribute)
resp_chest (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
resp_chest_index (app.models.channelmapping.ChannelMapping attribute)
resp_thermistor (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
resp_thermistor_index (app.models.channelmapping.ChannelMapping attribute)
right_value (app.validators.channelmapping.PositionChannelBase attribute)
role (app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserResponseSmall attribute)
role_name (app.validators.user.UserCreate attribute)
(app.validators.user.UserPatch attribute)
S
Scoring Run
scoringrun (app.models.processinghistory.ProcessingHistory attribute)
scoringrun_id (app.models.processinghistory.ProcessingHistory attribute)
scoringruns (app.models.user.User attribute)
serialize_permissions() (app.validators.user.UserResponseSmall method)
serialize_role() (app.validators.user.UserResponseSmall method)
SERVICE_ACCOUNT_EMAIL (app.config.config.Settings attribute)
Settings (class in app.config.config)
SingleChannelBase (class in app.validators.channelmapping)
site_id (app.models.user.User attribute)
(app.validators.user.User attribute)
(app.validators.user.UserCreate attribute)
(app.validators.user.UserPatch attribute)
(app.validators.user.UserResponseSmall attribute)
status (app.models.processinghistory.ProcessingHistory attribute)
(app.validators.processinghistory.ProcessingHistoryCreate attribute)
status_message (app.models.processinghistory.ProcessingHistory attribute)
(app.validators.processinghistory.ProcessingHistoryCreate attribute)
studies (app.models.user.User attribute)
(app.validators.user.User attribute)
Study (class in app.models.study)
Study Object
supine_value (app.validators.channelmapping.PositionChannelBase attribute)
T
test_read_main() (in module app.tests.test_main)
transc02 (app.models.channelmapping.ChannelMapping attribute)
(app.models.channelmapping.ChannelMappingToAutoScoringChannelType attribute)
(app.validators.channelmapping.ChannelMappingBase attribute)
transc02_index (app.models.channelmapping.ChannelMapping attribute)
trigger_edf_validator() (in module app.utils.gcs)
U
unknown_value (app.validators.channelmapping.PositionChannelBase attribute)
update_user() (in module app.controllers.user)
upright_value (app.validators.channelmapping.PositionChannelBase attribute)
user (app.models.study.Study attribute)
User (class in app.models.user)
(class in app.validators.user)
user_id (app.models.channelmapping.ChannelMapping attribute)
(app.models.processinghistory.ProcessingHistory attribute)
(app.models.study.Study attribute)
(app.validators.channelmapping.ChannelMapping attribute)
(app.validators.channelmapping.ChannelMappingCreateFromScoringRun attribute)
USER_ISSUER (app.config.config.Settings attribute)
USER_X509_URL (app.config.config.Settings attribute)
UserBase (class in app.validators.user)
UserCreate (class in app.validators.user)
UserPatch (class in app.validators.user)
UserResponseInStudyList (class in app.validators.user)
UserResponseSmall (class in app.validators.user)
V
verify() (app.utils.utils.verify_token_oidc method)
verify_token_get_or_create_internaluser() (in module app.utils.utils)
verify_token_m2m() (in module app.utils.utils)
verify_token_oidc (class in app.utils.utils)
version (app.config.config.Settings attribute)
W
WEB_REPORTING_V2_URL (app.config.config.Settings attribute)
Y
yield_blob_as_chunks() (in module app.utils.gcs)