update branch for PR #319

.github/workflows/ORDA.yaml

@@ -0,0 +1,28 @@
+name: Release to ORDA
+on:
+ workflow_dispatch:
+ release:
+ types: [published]
+jobs:
+ upload:
+ runs-on: ubuntu-latest
+ env:
+ ARCHIVE_NAME: ${{ github.event.repository.name }}-${{ github.event.release.tag_name }}
+ steps:
+ - name: prepare-data-folder
+ run : mkdir 'data'
+ - name: download-archive
+ run: |
+ curl -sL "${{ github.event.release.zipball_url }}" > "$ARCHIVE_NAME".zip
+ curl -sL "${{ github.event.release.tarball_url }}" > "$ARCHIVE_NAME".tar.gz
+ - name: move-archive
+ run: |
+ mv "$ARCHIVE_NAME".zip data/
+ mv "$ARCHIVE_NAME".tar.gz data/
+ - name: upload-to-figshare
+ uses: figshare/[email protected]
+ with:
+ FIGSHARE_TOKEN: ${{ secrets.FIGSHARE_TOKEN }}
+ FIGSHARE_ENDPOINT: 'https://api.figshare.com/v2'
+ FIGSHARE_ARTICLE_ID: 23230694
+ DATA_DIR: 'data'

.pre-commit-config.yaml

@@ -20,25 +20,25 @@ repos:
  - id: check-toml
 
  - repo: https://github.com/asottile/pyupgrade
- rev: v3.4.0
+ rev: v3.10.1
  hooks:
  - id: pyupgrade
  args: [--py38-plus]
 
  - repo: https://github.com/psf/black
- rev: 23.3.0
+ rev: 23.9.1
  hooks:
  - id: black
  types: [python]
  additional_dependencies: ["click==8.0.4"]
 
  - repo: https://github.com/DavidAnson/markdownlint-cli2
- rev: v0.7.1
+ rev: v0.9.2
  hooks:
  - id: markdownlint-cli2
 
  - repo: https://github.com/pycqa/flake8.git
- rev: 6.0.0
+ rev: 6.1.0
  hooks:
  - id: flake8
  additional_dependencies: [flake8-print, Flake8-pyproject]
@@ -65,21 +65,21 @@ repos:
  - id: nbstripout
 
  - repo: https://github.com/pre-commit/mirrors-mypy
- rev: v1.3.0
+ rev: v1.5.1
  hooks:
  - id: mypy
  args:
  - --explicit-package-bases
 
- - repo: https://github.com/charliermarsh/ruff-pre-commit
+ - repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
- rev: "v0.0.267"
+ rev: "v0.0.288"
  hooks:
  - id: ruff
 
  # Serious pylint errors that will be enforced by CI
  - repo: https://github.com/pycqa/pylint
- rev: v3.0.0a6
+ rev: v3.0.0a7
  hooks:
  - id: pylint
  args:

README.md

@@ -18,10 +18,12 @@
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/claritychallenge/clarity/main.svg)](https://results.pre-commit.ci/latest/github/claritychallenge/clarity/main)
 [![Downloads](https://pepy.tech/badge/pyclarity)](https://pepy.tech/project/pyclarity)
 
-[![PyPI](https://img.shields.io/static/v1?label=CAD1%20and%20CPC2%20Challenges%20-%20pypi&message=v0.3.2&color=orange)](https://pypi.org/project/pyclarity/0.3.2/)
+[![PyPI](https://img.shields.io/static/v1?label=ICASSP%202024%20Cadenza%20Challenge%20-%20pypi&message=v0.4.1&color=orange)](https://pypi.org/project/pyclarity/0.4.1/)
+[![PyPI](https://img.shields.io/static/v1?label=CAD1%20and%20CPC2%20Challenges%20-%20pypi&message=v0.3.4&color=orange)](https://pypi.org/project/pyclarity/0.3.4/)
 [![PyPI](https://img.shields.io/static/v1?label=ICASSP%202023%20Challenge%20-%20pypi&message=v0.2.1&color=orange)](https://pypi.org/project/pyclarity/0.2.1/)
 [![PyPI](https://img.shields.io/static/v1?label=CEC2%20Challenge%20-%20pypi&message=v0.1.1&color=orange)](https://pypi.org/project/pyclarity/0.1.1/)
 
+[![ORDA](https://img.shields.io/badge/ORDA--DOI-10.15131%2Fshef.data.23230694.v.1-lightgrey)](https://figshare.shef.ac.uk/articles/software/clarity/23230694/1)
 </p>
 
 </div>
@@ -34,10 +36,11 @@ In this repository, you will find code to support all Clarity and Cadenza Challe
 
 ## Current Events
 
-- The first Cadenza Challenge (CAD1) is now open. :fire::fire:
+- The ICASSP 2024 Cadenza Challenge (CAD_ICASSP_2024) is now open. :fire::fire:
  - Join the [Cadenza Challenge Group](https://groups.google.com/g/cadenza-challenge) to keep up-to-date on developments.
  - Visit the Cadenenza Challenge [website](https://cadenzachallenge.org/) for more details.
- - Evaluation tools and a baseline system are available in the [CAD1 recipes](./recipes/cad1) folder. :new:
+- The first Cadenza Challenge (CAD1) is closed.
+ - Subjective Evaluation is underway. :new:
 - The 2nd Clarity Prediction Challenge (CPC2) is now open. :fire::fire:
  - Join the [Clarity Challenge Group](https://groups.google.com/g/clarity-challenge) to keep up-to-date on developments.
  - Visit the Clarity Challenge [website](https://claritychallenge.org/) for more details.
@@ -86,11 +89,12 @@ pip install -e git+https://github.com/claritychallenge/clarity.git@main
 
 Current challenge
 
-- [The 1st Cadenza Challenge (CAD1)](./recipes/cad1)
-- [The 2nd Clarity Prediction Challenge (CPC2)](./recipes/cpc2)
+- [The ICASSP 2024 Cadenza Challenge](./recipes/cad_icassp_2024)
 
 Previous challenges
 
+- [The 1st Cadenza Challenge (CAD1)](./recipes/cad1)
+- [The 2nd Clarity Prediction Challenge (CPC2)](./recipes/cpc2)
 - [The ICASSP 2023 Enhancement Challenge](./recipes/icassp_2023)
 - [The 2nd Clarity Enhancement Challenge (CEC2)](./recipes/cec2)
 - [The 1st Clarity Prediction Challenge (CPC1)](./recipes/cpc1)

clarity/evaluator/haaqi/haaqi.py

@@ -178,8 +178,9 @@ def haaqi_v1(
 def compute_haaqi(
  processed_signal: ndarray,
  reference_signal: ndarray,
+ processed_sample_rate: float,
+ reference_sample_rate: float,
  audiogram: Audiogram,
- sample_rate: float,
  equalisation: int = 1,
  level1: float = 65.0,
 ) -> float:
@@ -191,8 +192,9 @@ def compute_haaqi(
  reference_signal (np.ndarray): Input reference speech signal with no noise
  or distortion. If a hearing loss is specified, NAL-R equalization
  is optional
+ processed_sample_rate (float): Sampling rate in Hz for processed signal.
+ reference_sample_rate (float): Sampling rate in Hz for reference signal.
  audiogram (Audiogram): Audiogram object.
- sample_rate (int): Sample rate in Hz.
  equalisation (int): hearing loss equalization mode for reference signal:
  1 = no EQ has been provided, the function will add NAL-R
  2 = NAL-R EQ has already been added to the reference signal
@@ -211,9 +213,9 @@ def compute_haaqi(
 
  score, _, _, _ = haaqi_v1(
  reference=reference_signal,
- reference_freq=sample_rate,
+ reference_freq=reference_sample_rate,
  processed=processed_signal,
- processed_freq=sample_rate,
+ processed_freq=processed_sample_rate,
  audiogram=audiogram,
  equalisation=equalisation,
  level1=level1,

clarity/evaluator/msbg/smearing.py

@@ -124,10 +124,11 @@ def smear3(f_smear: ndarray, inbuffer: ndarray) -> ndarray:
  winwave = np.zeros(FFT_SIZE)
  winwave[0:FRAME_SIZE] = window * inwave.flatten()
  spectrum = np.fft.fft(winwave, FFT_SIZE)
- power = spectrum[0:nyquist] * np.conj(spectrum[0:nyquist])
- mag = np.sqrt(power)
+
+ mag = np.abs(spectrum[0:nyquist])
  phasor = spectrum[0:nyquist] / (mag + (mag == 0))
- smeared = np.dot(f_smear, power)
+
+ smeared = np.dot(f_smear, (mag**2).astype(complex))
  spectrum[0:nyquist] = np.sqrt(smeared) * phasor
  spectrum[nyquist] = 0
  spectrum[(nyquist + 1) : FFT_SIZE] = np.conj(spectrum[nyquist - 1 : 0 : -1])