| Name | pvqd JSON |
| Version |
0.1.0.dev5
JSON |
| download |
| home_page | |
| Summary | Voice Foundation Pathological Voice Quality Database Reader module |
| upload_time | 2023-02-08 15:11:22 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | GPL-2.0 License |
| keywords |
multimedia
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
`pvqd`: Voice Foundation Pathological Voice Quality Database Reader module
==========================================================================
|pypi| |status| |pyver| |license|
.. |pypi| image:: https://img.shields.io/pypi/v/pvqd
:alt: PyPI
.. |status| image:: https://img.shields.io/pypi/status/pvqd
:alt: PyPI - Status
.. |pyver| image:: https://img.shields.io/pypi/pyversions/pvqd
:alt: PyPI - Python Version
.. |license| image:: https://img.shields.io/github/license/tikuma-lsuhsc/python-pvqd
:alt: GitHub
.. note::
This Python package is still under development.
This Python module provides functions to retrieve data and information easily from
Voice Foundation's Pathological Voice Quality Database.
This module currently does not retrieve the database itself on its own. User must
download and extract the files first from https://prod-dcd-datasets-cache-zipfiles.s3.eu-west-1.amazonaws.com/9dz247gnyb-2.zip
Install
-------
.. code-block:: bash
pip install pvqd
Use
---
.. code-block:: python
from pvqd import PVQD
# to initialize (must call this once in every Python session)
pvqd = PVQD('<path to the root directory of the extracted database>')
# to get a copy of the full database with averaged CAPE-V scores
df = pvqd.query(include_cape_v=True)
# to get age, gender, and mean GRBAS grade scores
df = pvqd.query(["Age", "Gender"], include_grbas='grade')
# to get a dataframe of WAV files and start and ending timestamps of all /a/ segment
df = pvqd.get_files('/a/')
# to iterate over '/a/' acoustic data of female participants along with
# age and mean GRBAS scores
for id, fs, x, auxdata in pvqd.iter_data('/a/',
auxdata_fields=["Age"],
include_grbas=True,
Gender="Female"):
# run the acoustic data through your analysis function, get measurements
params = my_analysis_function(fs, x)
# log the measurements along with the age and GRBAS info
my_logger.log_outcome(id, *auxdata, *params)
Raw data
{
"_id": null,
"home_page": "",
"name": "pvqd",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "multimedia",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/85/21/638e9effc9ab40c24b40632116eb4ed754b8453b892bfb6a020783fd87a0/pvqd-0.1.0.dev5.tar.gz",
"platform": null,
"description": "`pvqd`: Voice Foundation Pathological Voice Quality Database Reader module\n==========================================================================\n\n|pypi| |status| |pyver| |license|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/pvqd\n :alt: PyPI\n.. |status| image:: https://img.shields.io/pypi/status/pvqd\n :alt: PyPI - Status\n.. |pyver| image:: https://img.shields.io/pypi/pyversions/pvqd\n :alt: PyPI - Python Version\n.. |license| image:: https://img.shields.io/github/license/tikuma-lsuhsc/python-pvqd\n :alt: GitHub\n\n.. note::\n This Python package is still under development.\n\nThis Python module provides functions to retrieve data and information easily from \nVoice Foundation's Pathological Voice Quality Database.\n\nThis module currently does not retrieve the database itself on its own. User must\ndownload and extract the files first from https://prod-dcd-datasets-cache-zipfiles.s3.eu-west-1.amazonaws.com/9dz247gnyb-2.zip\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install pvqd\n\nUse\n---\n\n.. code-block:: python\n\n from pvqd import PVQD\n\n # to initialize (must call this once in every Python session)\n pvqd = PVQD('<path to the root directory of the extracted database>')\n\n # to get a copy of the full database with averaged CAPE-V scores\n df = pvqd.query(include_cape_v=True)\n\n # to get age, gender, and mean GRBAS grade scores\n df = pvqd.query([\"Age\", \"Gender\"], include_grbas='grade')\n\n # to get a dataframe of WAV files and start and ending timestamps of all /a/ segment\n df = pvqd.get_files('/a/')\n\n # to iterate over '/a/' acoustic data of female participants along with\n # age and mean GRBAS scores\n for id, fs, x, auxdata in pvqd.iter_data('/a/',\n auxdata_fields=[\"Age\"],\n include_grbas=True,\n Gender=\"Female\"):\n # run the acoustic data through your analysis function, get measurements\n params = my_analysis_function(fs, x)\n\n # log the measurements along with the age and GRBAS info\n my_logger.log_outcome(id, *auxdata, *params)\n",
"bugtrack_url": null,
"license": "GPL-2.0 License",
"summary": "Voice Foundation Pathological Voice Quality Database Reader module",
"version": "0.1.0.dev5",
"split_keywords": [
"multimedia"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "636cbe47bf4ce9ec13ca161a979ebc3851e11f77581fcfd1bc22cc3f684a7eba",
"md5": "41940f2ad84ba0ebe75ac23c23afdcb8",
"sha256": "770b7e139932d5308fafaaab990fe84a7af6497a2661e46f52268fc08b706255"
},
"downloads": -1,
"filename": "pvqd-0.1.0.dev5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41940f2ad84ba0ebe75ac23c23afdcb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26986,
"upload_time": "2023-02-08T15:11:20",
"upload_time_iso_8601": "2023-02-08T15:11:20.538259Z",
"url": "https://files.pythonhosted.org/packages/63/6c/be47bf4ce9ec13ca161a979ebc3851e11f77581fcfd1bc22cc3f684a7eba/pvqd-0.1.0.dev5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8521638e9effc9ab40c24b40632116eb4ed754b8453b892bfb6a020783fd87a0",
"md5": "ab1f5d1ab83cc77211517888998c1fc5",
"sha256": "2edf6f7027af8fdb364668c1fc8519ed0a169d4944cdd97d4df887e47f4aa14e"
},
"downloads": -1,
"filename": "pvqd-0.1.0.dev5.tar.gz",
"has_sig": false,
"md5_digest": "ab1f5d1ab83cc77211517888998c1fc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 29385,
"upload_time": "2023-02-08T15:11:22",
"upload_time_iso_8601": "2023-02-08T15:11:22.105013Z",
"url": "https://files.pythonhosted.org/packages/85/21/638e9effc9ab40c24b40632116eb4ed754b8453b892bfb6a020783fd87a0/pvqd-0.1.0.dev5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 15:11:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pvqd"
}
