| Name | kpdvdb JSON |
| Version |
0.6.2
JSON |
| download |
| home_page | |
| Summary | KayPENTAX Disordered Voice Database Reader module |
| upload_time | 2024-01-22 04:21:54 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | GPL-2.0 License |
| keywords |
multimedia
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
`kpdvdb`: KayPENTAX Disordered Voice Database Reader
====================================================
|pypi| |status| |pyver| |license|
.. |pypi| image:: https://img.shields.io/pypi/v/kpdvdb
:alt: PyPI
.. |status| image:: https://img.shields.io/pypi/status/kpdvdb
:alt: PyPI - Status
.. |pyver| image:: https://img.shields.io/pypi/pyversions/kpdvdb
:alt: PyPI - Python Version
.. |license| image:: https://img.shields.io/github/license/tikuma-lsuhsc/python-kpdvdb
:alt: GitHub
This Python module provides functions to interact with KayPENTAX Disordered Voice Database
This module DOES NOT provide the database itself. KayPENTAX Disordered Voice Database is
a (discontinued) commercial product, an addon option to KayPENTAX's Computerized Speech Lab (CSL).
For faster access to the data, copying the database files from the CD-ROM to a local hard drive is
highly recommended.
Install
-------
.. code-block:: bash
pip install kpdvdb
Use
---
.. code-block:: python
from kpdvdb import KPDVDB
# to initialize (must call this once in every Python session)
kpdvdb = KPDVDB('<path to CDROM drive or root directory of the database>')
# to list all the data fields
print(kpdvdb.get_fields())
# to list categorical fields' unique values
print(kpdvdb.get_sexes()) # genders
print(kpdvdb.get_locations()) # pathology sites
print(kpdvdb.get_natlangs()) # native languages
print(kpdvdb.get_origins()) # races
print(kpdvdb.get_diagnoses()) # diagnoses
# to get a copy of the full database
df = kpdvdb.query(include_diagnoses=True)
# to get age, gender, diagnoses, and MDVP measures of non-smoking
# subjects with polyp or paralysis, F0 between 100 and 300 Hz
df = kpdvdb.query(["AGE","SEX","DIAGNOSES","MDVP"],
DIAGNOSES=["vocal fold polyp","paralysis"],
Fo=[100,300],
SMOKE=False)
# to get the list of AH NSP files of normal subjects
nspfiles = kpdvdb.get_files('ah',NORM=True)
# to iterate over 'rainbow passage' acoustic data of female pathological subjects
for fs, x, info in kpdvdb.iter_data('rainbow',
auxdata_fields=["AGE","SEX"],
NORM=False, SEX="F"):
# run the acoustic data through your analysis function, get measurements
params = my_analysis_function(fs, x)
# log the measurements along with the age and gender info
my_logger.log_outcome(*info, *params)
NOTE
----
Because the database is not public, this module cannot be tested for various platforms
via GitHub Action. If you encounter any issues, please post it on GitHub.
Raw data
{
"_id": null,
"home_page": "",
"name": "kpdvdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "multimedia",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e8/b9/d3e556f91eae99ff96d02b52bdcd910ea599661877d1522901987531622a/kpdvdb-0.6.2.tar.gz",
"platform": null,
"description": "`kpdvdb`: KayPENTAX Disordered Voice Database Reader\n====================================================\n\n|pypi| |status| |pyver| |license|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/kpdvdb\n :alt: PyPI\n.. |status| image:: https://img.shields.io/pypi/status/kpdvdb\n :alt: PyPI - Status\n.. |pyver| image:: https://img.shields.io/pypi/pyversions/kpdvdb\n :alt: PyPI - Python Version\n.. |license| image:: https://img.shields.io/github/license/tikuma-lsuhsc/python-kpdvdb\n :alt: GitHub\n\nThis Python module provides functions to interact with KayPENTAX Disordered Voice Database\n\nThis module DOES NOT provide the database itself. KayPENTAX Disordered Voice Database is \na (discontinued) commercial product, an addon option to KayPENTAX's Computerized Speech Lab (CSL).\n\nFor faster access to the data, copying the database files from the CD-ROM to a local hard drive is \nhighly recommended.\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install kpdvdb\n\nUse\n---\n\n.. code-block:: python\n\n from kpdvdb import KPDVDB\n\n # to initialize (must call this once in every Python session)\n kpdvdb = KPDVDB('<path to CDROM drive or root directory of the database>')\n\n # to list all the data fields \n print(kpdvdb.get_fields())\n\n # to list categorical fields' unique values\n print(kpdvdb.get_sexes()) # genders\n print(kpdvdb.get_locations()) # pathology sites\n print(kpdvdb.get_natlangs()) # native languages\n print(kpdvdb.get_origins()) # races\n print(kpdvdb.get_diagnoses()) # diagnoses\n\n # to get a copy of the full database\n df = kpdvdb.query(include_diagnoses=True)\n\n # to get age, gender, diagnoses, and MDVP measures of non-smoking \n # subjects with polyp or paralysis, F0 between 100 and 300 Hz\n df = kpdvdb.query([\"AGE\",\"SEX\",\"DIAGNOSES\",\"MDVP\"], \n DIAGNOSES=[\"vocal fold polyp\",\"paralysis\"],\n Fo=[100,300],\n SMOKE=False)\n\n # to get the list of AH NSP files of normal subjects\n nspfiles = kpdvdb.get_files('ah',NORM=True)\n\n # to iterate over 'rainbow passage' acoustic data of female pathological subjects\n for fs, x, info in kpdvdb.iter_data('rainbow',\n auxdata_fields=[\"AGE\",\"SEX\"],\n NORM=False, SEX=\"F\"):\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 gender info\n my_logger.log_outcome(*info, *params)\n\nNOTE\n----\n\nBecause the database is not public, this module cannot be tested for various platforms\nvia GitHub Action. If you encounter any issues, please post it on GitHub.\n",
"bugtrack_url": null,
"license": "GPL-2.0 License",
"summary": "KayPENTAX Disordered Voice Database Reader module",
"version": "0.6.2",
"project_urls": {
"Issues": "https://github.com/tikuma-lsuhsc/python-kpdvdb/issues",
"Pull_Requests": "https://github.com/tikuma-lsuhsc/python-kpdvdb/pulls",
"Repository": "https://github.com/tikuma-lsuhsc/python-kpdvdb"
},
"split_keywords": [
"multimedia"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ba1aad551fff9acc79564985d0dfdaebdf143bdc4136c1d7d89f9e3ad378f4b",
"md5": "135bcdab73f4dd9ceba4138e0409efc0",
"sha256": "f002b86f9e8ba9f6cac30b60c7740ab7e5b0a0366e2c8d5c722021833db4dead"
},
"downloads": -1,
"filename": "kpdvdb-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "135bcdab73f4dd9ceba4138e0409efc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14268,
"upload_time": "2024-01-22T04:21:52",
"upload_time_iso_8601": "2024-01-22T04:21:52.841713Z",
"url": "https://files.pythonhosted.org/packages/4b/a1/aad551fff9acc79564985d0dfdaebdf143bdc4136c1d7d89f9e3ad378f4b/kpdvdb-0.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8b9d3e556f91eae99ff96d02b52bdcd910ea599661877d1522901987531622a",
"md5": "60c954e81d51a94d7f7f3fae9ba3570c",
"sha256": "654b1fe32184d118802457567734b9c3a1e43e405e1fa4b03b77ed6ec2cead36"
},
"downloads": -1,
"filename": "kpdvdb-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "60c954e81d51a94d7f7f3fae9ba3570c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15579,
"upload_time": "2024-01-22T04:21:54",
"upload_time_iso_8601": "2024-01-22T04:21:54.480890Z",
"url": "https://files.pythonhosted.org/packages/e8/b9/d3e556f91eae99ff96d02b52bdcd910ea599661877d1522901987531622a/kpdvdb-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 04:21:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tikuma-lsuhsc",
"github_project": "python-kpdvdb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "kpdvdb"
}
