Metadata-Version: 2.1
Name: itu-r-468-weighting
Version: 2.0.1
Summary: A zero dependency Python ITU-R 468 noise weighting filter (1 kHz and 2 kHz)
Home-page: https://github.com/cinelexi/itu-r-468-weighting
Author: Alexis Michaltsis
Author-email: a.michaltsis@gmail.com
License: MIT
Description: # itu-r-468-weighting
        
        A zero dependency Python ITU-R 468 noise weighting filter (1 kHz and 2 kHz)
        
        Master branch: [![Build Status](https://travis-ci.com/cinelexi/itu-r-468-weighting.svg?branch=master)](https://travis-ci.com/cinelexi/itu-r-468-weighting?branch=master) [![Coverage Status](https://img.shields.io/coveralls/github/cinelexi/itu-r-468-weighting/master)](https://coveralls.io/github/cinelexi/itu-r-468-weighting?branch=master) \
        Dev branch: [![Build Status](https://travis-ci.com/cinelexi/itu-r-468-weighting.svg?branch=dev)](https://travis-ci.com/cinelexi/itu-r-468-weighting?branch=dev) [![Coverage Status](https://img.shields.io/coveralls/github/cinelexi/itu-r-468-weighting/dev)](https://coveralls.io/github/cinelexi/itu-r-468-weighting?branch=dev)
        
        ## Introduction
        
        This project consists of a sole function named `r468`. The function takes a frequency value and returns a weighted gain value. For weightening, the [ITU-R BS.468-4](https://www.itu.int/rec/R-REC-BS.468-4-198607-I/en) standard and the [SMPTE RP 2054:2010](https://ieeexplore.ieee.org/document/7290513) recommended practice are followed.
        
        The math for this project is taken from Wikipedia (as of 2019-08-08):
        
        - https://en.wikipedia.org/wiki/ITU-R_468_noise_weighting ([archived version](https://web.archive.org/web/20190808084536/https:/en.wikipedia.org/wiki/ITU-R_468_noise_weighting))
        
        ### Filter with gain in dB ("db" option):
        
        ![](https://raw.githubusercontent.com/cinelexi/itu-r-468-weighting/master/images/filter_gain_db.png)
        
        ### Filter with gain factor ("factor" option):
        
        ![](https://raw.githubusercontent.com/cinelexi/itu-r-468-weighting/master/images/filter_gain.png)
        
        ## Installation
        
        ```
        pip install itu-r-468-weighting
        ```
        
        More infos on the [project page](https://pypi.org/project/itu-r-468-weighting/) at PyPI.
        
        ## Example Usage
        
        ```
        from itu_r_468_weighting.filter import r468
        
        r468(1000, "1khz", "db")      # returns gain in dB
        r468(1000, "2khz", "db")      # returns gain in dB
        r468(1000, "1khz", "factor")  # returns gain factor
        r468(1000, "2khz", "factor")  # returns gain factor
        ```
        
        ## Documentation
        
        See docstring of function `r468()` in `itu_r_468_weighting/filter.py` or create and read the docs from source in `docs/` or read them online at [readthedocs.io](https://itu-r-468-weighting.readthedocs.io/en/latest/index.html).
        
        ## Contributing
        
        See CONTRIBUTING.md file.
        
        ## Project page
        
        This project is hosted on [GitHub](https://github.com/cinelexi/itu-r-468-weighting).
        
Keywords: ITU-R BS.468-4 SMPTE RP 2054:2010 noise weighting filter
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/markdown
