app.routers package

Subpackages

• app.routers.tests package
  • Submodules
  • app.routers.tests.test_fileuploads module
  • Module contents

Submodules

app.routers.channelmappings module

app.routers.channelmappings.create_channelmapping(channelmapping: ChannelMappingCreate, db: Session = Depends(get_db), db_user: User = Depends(AuthUser))

Create a new Channel Mapping.

Information about the Channel Mapping object to create. - name: Name of the Channel Mapping.

Specific mappings for each channel from the EDF file to our internal naming convention - eeg_left: Mapping for the EEG left channel. - eeg_right: Mapping for the EEG right channel. - eye_left: Mapping for the left eye channel. - eye_right: Mapping for the right eye channel. - mastoid: Mapping for the mastoid channel. - chin: Mapping for the chin channel. - intercostal_left: Mapping for the left intercostal channel. - intercostal_right: Mapping for the right intercostal channel. - ekg: Mapping for the EKG channel. - leg_left: Mapping for the left leg channel. - leg_right: Mapping for the right leg channel. - resp_cannula: Mapping for the respiratory cannula channel. - resp_chest: Mapping for the respiratory chest channel. - resp_abdomen: Mapping for the respiratory abdomen channel. - oxygen_sat: Mapping for the oxygen saturation channel. - pulse: Mapping for the pulse channel. - audio: Mapping for the audio channel. - light: Mapping for the light channel. - resp_thermistor: Mapping for the respiratory thermistor channel. - cpapflow: Mapping for the CPAP flow channel. - epap: Mapping for the EPAP channel. - ipap: Mapping for the IPAP channel. - etc02: Mapping for the end-tidal CO2 channel. - transc02: Mapping for the transcutaneous CO2 channel. - position: Mapping for the position channel.

• channel_name: Name of the Position channel in the EDF file.

• channel_index (int)(optional): Index position of the Position channel in the EDF. Overrides the channel_name if provided.

• unknown_value (int): Value in the position channel that indicates an unknown position.

• supine_value (int): Value in the position channel that indicates a supine position.

• left_value (int): Value in the position channel that indicates a left position.

• right_value (int): Value in the position channel that indicates a right position.

• prone_value (int): Value in the position channel that indicates a prone position.

• upright_value (int): Value in the position channel that indicates an upright position.

app.routers.channelmappings.delete_channelmapping(channelmapping_id: int, db: Session = Depends(get_db), db_user: User = Depends(AuthUser))

Delete a ChannelMapping object. They are ONLY deletable if they are not associated with any files.

• channelmapping_id: id of the channel mapping to delete

Returns a 204 status code

app.routers.channelmappings.get_channelmapping(channelmapping_id: int, db: Session = Depends(get_db), db_user: User = Depends(AuthUser))

Retrieve a ChannelMapping object.

• channelmapping_id: id of the channel mapping to fetch

Returns a ChannelMapping object.

app.routers.channelmappings.get_channelmappings(name: str = None, skip: int = None, limit: int = None, user_id: int = None, sort_by: str = 'id', sort_order: str = 'asc', db: Session = Depends(get_db), db_user: User = Depends(AuthUser))

Retrieve a list of ChannelMapping objects.

• user_id (optional) - list all files for a given user

• name (optional) - Filter the list of ChannelMapping objects by name

• skip (optional) - Number of objects to skip

• limit (optional) - Maximum number of objects to return

• sort_by (optional) - Field to sort by (defaults to id if field doesnt exist)

• sort_order (optional) - Sort order (asc or desc) (defaults to asc if not provided)

Returns a list of ChannelMapping objects.

app.routers.fileuploads module

Module contents