vibromaf


Namevibromaf JSON
Version 0.0.8 PyPI version JSON
download
home_pagehttps://github.com/hofbi/vibromaf
SummaryVibrotactile quality metrics and metric fusion
upload_time2024-11-04 22:18:11
maintainerNone
docs_urlNone
authorMarkus Hofbauer, Andreas Noll
requires_python>=3.9
licenseMIT
keywords haptics vibrotactile quality assessment signal processing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # VibroMAF - Vibrotactile Multi-Method Assessment Fusion

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/hofbi/vibromaf/main.svg)](https://results.pre-commit.ci/latest/github/hofbi/vibromaf/main)
[![Actions Status](https://github.com/hofbi/vibromaf/workflows/CI/badge.svg)](https://github.com/hofbi/vibromaf)
[![Actions Status](https://github.com/hofbi/vibromaf/workflows/Docs/badge.svg)](https://hofbi.github.io/vibromaf)
[![Actions Status](https://github.com/hofbi/vibromaf/workflows/CodeQL/badge.svg)](https://github.com/hofbi/vibromaf)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![PyPI](https://img.shields.io/pypi/v/vibromaf)](https://pypi.org/project/vibromaf/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vibromaf)](https://pypi.org/project/vibromaf/)
[![PyPI - License](https://img.shields.io/pypi/l/vibromaf)](https://pypi.org/project/vibromaf/)

## Vibrotactile Quality Metrics

This package provides implementations of existing vibrotactile quality metrics and machine learning approach that fuses the individual metric scores into a single final quality score.

## Installation

Install `vibromaf` from [PyPI](https://pypi.org/project/vibromaf):

```shell
pip install vibromaf
```

For development versions and alternative installations see the [installation documentation](https://hofbi.github.io/vibromaf/installation/).

## Usage

- [Get Started](https://hofbi.github.io/vibromaf/get-started/)
- [Full Documentation](https://hofbi.github.io/vibromaf/)

## Citation

If you use this work, please cite our paper ([PDF](https://www.researchgate.net/publication/357556145_Automated_Quality_Assessment_for_Compressed_Vibrotactile_Signals_Using_Multi-Method_Assessment_Fusion))

```tex
@inproceedings{noll_vibromaf,
  author    = {Noll, Andreas and Hofbauer, Markus and Muschter, Evelyn and Li, Shu-Chen and Steinbach, Eckehard},
  booktitle = {2022 IEEE Haptics Symposium (HAPTICS)},
  title     = {Automated Quality Assessment for Compressed Vibrotactile Signals Using Multi-Method Assessment Fusion},
  year      = {2022},
  volume    = {},
  number    = {},
  pages     = {1-6},
  doi       = {10.1109/HAPTICS52432.2022.9765599},
  address   = {Santa Barabara, California, USA}
}
```

## Contribute

See our [CONTRIBUTING.md](CONTRIBUTING.md)

# Changelog

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hofbi/vibromaf",
    "name": "vibromaf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "haptics, vibrotactile quality assessment, signal processing",
    "author": "Markus Hofbauer, Andreas Noll",
    "author_email": "name.surname@tum.de",
    "download_url": "https://files.pythonhosted.org/packages/f9/e7/71843c35436f383f6e63590f12c6b7509dd92e57fb54a143cfa475fee71a/vibromaf-0.0.8.tar.gz",
    "platform": null,
    "description": "# VibroMAF - Vibrotactile Multi-Method Assessment Fusion\n\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/hofbi/vibromaf/main.svg)](https://results.pre-commit.ci/latest/github/hofbi/vibromaf/main)\n[![Actions Status](https://github.com/hofbi/vibromaf/workflows/CI/badge.svg)](https://github.com/hofbi/vibromaf)\n[![Actions Status](https://github.com/hofbi/vibromaf/workflows/Docs/badge.svg)](https://hofbi.github.io/vibromaf)\n[![Actions Status](https://github.com/hofbi/vibromaf/workflows/CodeQL/badge.svg)](https://github.com/hofbi/vibromaf)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n[![PyPI](https://img.shields.io/pypi/v/vibromaf)](https://pypi.org/project/vibromaf/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vibromaf)](https://pypi.org/project/vibromaf/)\n[![PyPI - License](https://img.shields.io/pypi/l/vibromaf)](https://pypi.org/project/vibromaf/)\n\n## Vibrotactile Quality Metrics\n\nThis package provides implementations of existing vibrotactile quality metrics and machine learning approach that fuses the individual metric scores into a single final quality score.\n\n## Installation\n\nInstall `vibromaf` from [PyPI](https://pypi.org/project/vibromaf):\n\n```shell\npip install vibromaf\n```\n\nFor development versions and alternative installations see the [installation documentation](https://hofbi.github.io/vibromaf/installation/).\n\n## Usage\n\n- [Get Started](https://hofbi.github.io/vibromaf/get-started/)\n- [Full Documentation](https://hofbi.github.io/vibromaf/)\n\n## Citation\n\nIf you use this work, please cite our paper ([PDF](https://www.researchgate.net/publication/357556145_Automated_Quality_Assessment_for_Compressed_Vibrotactile_Signals_Using_Multi-Method_Assessment_Fusion))\n\n```tex\n@inproceedings{noll_vibromaf,\n  author    = {Noll, Andreas and Hofbauer, Markus and Muschter, Evelyn and Li, Shu-Chen and Steinbach, Eckehard},\n  booktitle = {2022 IEEE Haptics Symposium (HAPTICS)},\n  title     = {Automated Quality Assessment for Compressed Vibrotactile Signals Using Multi-Method Assessment Fusion},\n  year      = {2022},\n  volume    = {},\n  number    = {},\n  pages     = {1-6},\n  doi       = {10.1109/HAPTICS52432.2022.9765599},\n  address   = {Santa Barabara, California, USA}\n}\n```\n\n## Contribute\n\nSee our [CONTRIBUTING.md](CONTRIBUTING.md)\n\n# Changelog\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Vibrotactile quality metrics and metric fusion",
    "version": "0.0.8",
    "project_urls": {
        "Bug Tracker": "https://github.com/hofbi/vibromaf/issues",
        "Discussions": "https://github.com/hofbi/vibromaf/discussions",
        "Documentation": "https://hofbi.github.io/vibromaf",
        "Homepage": "https://github.com/hofbi/vibromaf"
    },
    "split_keywords": [
        "haptics",
        " vibrotactile quality assessment",
        " signal processing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13a1508f4f5d407260142719e6b5627a400ea1bddc04b3abf1aa9184c766affb",
                "md5": "90cb50de20fcabd233a22d20ba4d1615",
                "sha256": "ba75d5941b4e1b1a65cec795fde65ffd557038b0321010b60a6987b603ac70ed"
            },
            "downloads": -1,
            "filename": "vibromaf-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90cb50de20fcabd233a22d20ba4d1615",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11194,
            "upload_time": "2024-11-04T22:18:10",
            "upload_time_iso_8601": "2024-11-04T22:18:10.705087Z",
            "url": "https://files.pythonhosted.org/packages/13/a1/508f4f5d407260142719e6b5627a400ea1bddc04b3abf1aa9184c766affb/vibromaf-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9e771843c35436f383f6e63590f12c6b7509dd92e57fb54a143cfa475fee71a",
                "md5": "7797b9ac41465c951635fdb0e05da892",
                "sha256": "a6d70c05dc96514f629257be2d974381c3267cb10052c5b66b32595e23daed7a"
            },
            "downloads": -1,
            "filename": "vibromaf-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "7797b9ac41465c951635fdb0e05da892",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 18234,
            "upload_time": "2024-11-04T22:18:11",
            "upload_time_iso_8601": "2024-11-04T22:18:11.571621Z",
            "url": "https://files.pythonhosted.org/packages/f9/e7/71843c35436f383f6e63590f12c6b7509dd92e57fb54a143cfa475fee71a/vibromaf-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-04 22:18:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hofbi",
    "github_project": "vibromaf",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "vibromaf"
}
        
Elapsed time: 5.05181s