Welcome to QPrism’s documentation!

The QPrism Python package serves as a quality assessment toolbox for data collected using sensors in smartphones and wearables (eg. accelerometer, gyroscope, audio and video). The package leverages digital signal and image processing techniques along with machine learning algorithms to assess the quality of sensor data covering data availability, interpretability, noise contamination and consistency. QPrism is completely data-driven, requiring no a priori data assumptions or application-specific parameter tuning to generate a comprehensive data quality report.

Check out the Usage section for further information, including the Installation of the project.

Note

This project is under active development.

Contents

• Implementation
• Usage
  • Installation
  • Examples
    • Sensor
    • Video
    • Audio
• API
  • Video
    • Video_DQM
      • Video_DQM
        • Video_DQM.artifacts_ratio()
        • Video_DQM.bit_rate()
        • Video_DQM.creation_time()
        • Video_DQM.duration()
        • Video_DQM.format()
        • Video_DQM.framerate()
        • Video_DQM.illumination()
        • Video_DQM.object_detection()
        • Video_DQM.resolution()
        • Video_DQM.save_csv()
  • Audio
    • Audio_DQM
      • Audio_DQM
        • Audio_DQM.RMS()
        • Audio_DQM.observation_duration()
        • Audio_DQM.sampling_rate()
        • Audio_DQM.save_csv()
        • Audio_DQM.voice_classification()
  • Sensor
    • DQM_single_record
      • DQM_single_record
        • DQM_single_record.compute_DQM()
        • DQM_single_record.get_APD()
        • DQM_single_record.get_DQM()
        • DQM_single_record.get_IRLR()
        • DQM_single_record.get_MDR()
        • DQM_single_record.get_SNR()
        • DQM_single_record.get_SRC()
        • DQM_single_record.get_VDR()
        • DQM_single_record.get_anomaly_index()
        • DQM_single_record.get_fields()
        • DQM_single_record.save_to_file()
        • DQM_single_record.set_APD()
        • DQM_single_record.set_MDR()
        • DQM_single_record.set_SNR()
        • DQM_single_record.set_SRC()
        • DQM_single_record.set_VDR()
        • DQM_single_record.set_input_data()
    • DQM_multiple_record
      • DQM_multiple_record
        • DQM_multiple_record.compute_avg_DQM()
        • DQM_multiple_record.compute_individual_DQM()
        • DQM_multiple_record.get_APD()
        • DQM_multiple_record.get_IRLR()
        • DQM_multiple_record.get_MDR()
        • DQM_multiple_record.get_RLC()
        • DQM_multiple_record.get_SCR()
        • DQM_multiple_record.get_SNR()
        • DQM_multiple_record.get_SRC()
        • DQM_multiple_record.get_VDR()
        • DQM_multiple_record.get_VRC()
        • DQM_multiple_record.get_avg_DQM()
        • DQM_multiple_record.get_avg_fields()
        • DQM_multiple_record.get_individual_DQM()
        • DQM_multiple_record.get_individual_fields()
        • DQM_multiple_record.save_avg_DQM_to_file()
        • DQM_multiple_record.save_individual_DQM_to_file()
        • DQM_multiple_record.set_APD()
        • DQM_multiple_record.set_MDR()
        • DQM_multiple_record.set_RLC()
        • DQM_multiple_record.set_SCR()
        • DQM_multiple_record.set_SNR()
        • DQM_multiple_record.set_SRC()
        • DQM_multiple_record.set_VDR()
        • DQM_multiple_record.set_VRC()
        • DQM_multiple_record.set_input_data()
    • helper_function
      • timestamp_to_unix()
• Glossary
  • Sensor Module
  • Audio Module
  • Video Module
• Git repo

Acknowledgements

Supported by CAMH / Krembil Center of Neuroinformatics.

The authors also like to acknowledge Aditi Surendra for designing the module function illustration.

Contribution

We welcome and encourage project contributions! Please see the here for details.

License

MIT License

Copyright (c) 2022 CAMH / Krembil Center of Neuroinformatics

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.