Commit a5808a88 authored by Archit Tamarapu's avatar Archit Tamarapu
Browse files

Merge branch 'update-readme-20250909' into 'main'

update README.md

See merge request !235
parents 5d17cbb9 e514b24b
Loading
Loading
Loading
Loading
+69 −15
Original line number Diff line number Diff line
@@ -146,6 +146,8 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha

### P.800 experiments

#### Input structure for P.800

```bash
.
└── P800-1
@@ -153,13 +155,21 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha
    │   └── <background noise files.wav>
    ├── config
    │   └── <configurations from git.yaml>
    ├── proc_input
    │   ├── cat1
    │   │   ├── <item_name.wav>
    │   │   ├── <item_name.wav.{0,1,2,3}.csv> for ISM metadata
    │   │   └── <item_name.wav.met> for MASA metadata
    │   ├── cat2...
    │   └── ...cat6
    └── proc_input
        ├── cat1
        │   ├── [l]p[ee]a[y]s[zz].c[nn].wav
        │   ├── [l]p[ee]a[y]s[zz].c[nn].wav.{0,1,2,3}.csv # for ISM metadata
        │   └── [l]p[ee]a[y]s[zz].c[nn].wav.met           # for MASA metadata
        ├── cat2...
        └── ...cat6
```

#### Scripts outputs for P.800

```bash
.
└── P800-1
# the below directories are created by the processing and collection scripts
    ├── proc_final
    │   ├── c01
    │   │    └── [l]p[ee]a[y]s[zz].c[nn].wav
@@ -171,7 +181,7 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha
        ├── cat1
        │   ├── out_-16LKFS
        │   │   ├── c01
        │   │   │   └── <item_name.c01.wav>
        │   │   │   └── [l]p[ee]a[y]s[zz].c[nn].wav
        │   │   ├── c02...
        │   │   └── ...cXX
        │   ├── out_-26LKFS
@@ -180,31 +190,75 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha
        └── ...cat6
```

#### Output structure for P.800

The folders for upload to box.com and for delivery to the listeing labs should look like the structure below.
This is essentially the contents of the `proc_final` directory produced from the collection scripts.

```bash
.
└── P800-1
    ├── c01
    │    └── [l]p[ee]a[y]s[zz].c[nn].wav
    ├── c02...
    ├── ...c36
    ├── preliminaries
    │   └── [l]p[ee]a[y]s[zz].c[nn].wav
    └── P800-1_hashes.txt
```

### BS.1534 experiments

#### Input structure for BS.1534

```bash
.
└── BS1534-1
    ├── config
    │   └── <configurations from git.yaml>
    ├── proc_input[_FMT] # for multiple input formats, suffix is present
    │   ├── <item_name.wav>
    │   ├── <item_name.wav.{0,1,2,3}.csv> for ISM metadata
    │   └── <item_name.wav.met> for MASA metadata
    │   ├── [l]m[ee]a[y]s[zz].c[nn].wav
    │   ├── [l]m[ee]a[y]s[zz].c[nn].wav.{0,1,2,3}.csv # for ISM metadata
    │   └── [l]m[ee]a[y]s[zz].c[nn].wav.met           # for MASA metadata
```

#### Scripts outputs for BS.1534

```bash
.
└── BS1534-1
# the below directories are created by the processing and collection scripts
    ├── proc_final
    │   ├── c01
        │   └── <item_name.c01.wav>
       │   └── [l]m[ee]a[y]s[zz].c[nn].wav
    │   ├── c02...
    │   ├── ...c08
    │   └── preliminaries
           └── <item_name.c01.wav>
           └── [l]m[ee]a[y]s[zz].c[nn].wav
    └── proc_output[_FMT] # for multiple input formats, suffix is present
        ├── c01
        │   └── <item_name.c01.wav>
        │   └── [l]m[ee]a[y]s[zz].c[nn].wav
        ├── c02...
        └── ...cXX
```

#### Output structure for BS.1534

The folders for upload to box.com and for delivery to the listeing labs should look like the structure below.
This is essentially the contents of the `proc_final` directory produced from the collection scripts.

```bash
.
└── BS1534-1
    ├── c01
    │   └── [l]m[ee]a[y]s[zz].c[nn].wav
    ├── c02...
    ├── ...c08
    ├── preliminaries
    │   └── [l]m[ee]a[y]s[zz].c[nn].wav
    └── BS1534-1_hashes.txt
```

# Quick guide: How to set up a listening test

This section describes step by step how to set up a listening test according to the Processing Plan (IVAS-7) and Test Plan (IVAS-8).
+1 −2
Original line number Diff line number Diff line
import argparse
import glob
import shutil
import re
import shutil
from pathlib import Path


PRELIMINARY_SUBSTRINGS = ["s13", "s14", "s15", "s16"]
PRELIMINARY_PATTERN = re.compile(r"dm[0-9]*a[1-9](s[0-9]*)\.c[0-1][0-9]\.wav")