jmrp.io / PyOctaveBand

Fork 0

[READ-ONLY] Mirror of https://github.com/jmrplens/PyOctaveBand. [Python3] Octave-Band and Fractional Octave-Band filter. For signal in time domain. jmrplens.github.io/PyOctaveBand/

acoustics audio filter frequency frequency-analysis frequency-domain octave python3 signal time-domain

Fork 0

PyOctaveBand / tests / data / published_catalogues /

at main 2 files

José M. Requena Plens Every catalogue row has one shape and says what its source claims for each cell (#862) 17d ago

42bd409f

README.md

Every catalogue row has one shape and says what its source claims for each cell (#862) * Every published catalogue cell is pinned to its last digit The 1982 rows of the 23 published catalogues are dumped once, every float by its repr, into tests/data/published_catalogues/baseline.json. A test takes that baseline through every change listed in tests/catalogue_fingerprint.py and asserts that the result is, field for field, what the library builds today. The page generator's check sees the numbers only as the site prints them; this sees the last digit of a float and a hedge moved from one field to another, so a change to how a row is built has to say what it moved. * Every catalogue row has one shape and says what its source claims The rows of every published catalogue share one base, and phonometry.io now publishes it: CatalogueRow, BandedRow, CatalogueError and CATALOGUE_BASES. A row gains basis, what the source claims a value is (measured, declared, calculated, estimated or extended), read through basis_of. The estimate had two spellings, SolidMaterial.estimated with is_estimate and OrthotropicWood.estimated with is_estimated; both are gone, and the 35 cells Hopkins Table A2 and Rossing Table 15.5 mark as estimates hold "estimated" in basis. A value the page prints in another unit is no longer derived: the 116 cells of Ver & Beranek Table 14.1 in degrees Fahrenheit and psi and the nine of Long Table 7.1 in sabins keep the printed figure and unit in converted. A cell the page leaves blank and prints on another row (Ver & Beranek Table 8.7, ASHRAE Table 30, Harris Chapter 32) names that row in carried. is_derived now answers only for what the library computes. The published catalogues page marks converted and carried cells as such, with the printed figure on a converted one, and a test walks every hedged cell of every catalogue to hold the page to it. OrthotropicWood and PlateauMaterial take their fields by name only, and no row class is slotted, because on Python 3.13 a slotted dataclass cannot call super() without arguments from its own methods. No published value changes: the fingerprint lists the 54 rows the move touched and nothing else moved. * A catalogue cell no longer claims a unit or a derivation its page does not print Long prints the six figures of his musician with no unit. The row now says so in its note and why they are read as sabins, and `converted` is described everywhere as the page's figure and its unit rather than as what the page prints; the published catalogues page words its tooltip the same way. A figure a packaged table prints with another SI prefix, such as the megapascals of Rossing Table 15.5, keeps no `converted` entry, and the docstring says so. `carried` covers a value the page gives by reference to another row, which includes the three Harris rows that print "Parecido al anterior" and no row number, not only a cell left blank under a block. The two ASHRAE rows that carry a diameter down no longer call it a derivation in their notes, and the damping paragraph of the catalogues page no longer says converted cells are marked as worked out. The fingerprint compares every row as the text the baseline holds, so a float served as an integer, or a flag served as a number, is a change. The page generator refuses a cell whose hedges it cannot show, two on one value or an estimate, a conversion or a carried value on an interval, a list or a word, instead of publishing it with one of them missing; the test walks every hedge of every published row to hold it to that. The older unreleased notes that still named `is_estimated`, the `estimated` field and cells marked derived now name `basis`, `basis_of` and `converted`. The scripts and tests that import `CatalogueRow` take it from `phonometry.io`, and the Spanish pages spell the sabin one way. * An approximate interval keeps its tilde on the catalogue page The porosity Cox Table 6.5 prints for granular vermiculite is an interval with a tilde, and the page showed the bare interval. The range and bound kinds have no mark of their own, so the tilde now goes into the cell text. The fingerprint's migration test also requires every field outside the hedges the step moves to stay equal, basis_of names all five bases, the baseline's README states the terms that cover it, and the test that probed the interpreter for the slotted super() failure is gone: Python 3.13.15 carries the fix and 3.13.5 does not, so it tested the Python patch release, not the library. * A list of readings printed with a tilde keeps it on the catalogue page Like an interval, a cell holding several readings has no mark of its own for a tilde, so it goes into the text. The generator now refuses an approximate hedge only on a printed word, which has nowhere to show it. No published cell changes. * A catalogue row refuses a basis outside the five words The catalogue page and every reader of basis_of act on measured, declared, calculated, estimated and extended only, so a row built with any other word, such as a misspelt estimate, now raises CatalogueError instead of reaching the page as a printed number.

2 weeks ago

baseline.json

2 weeks ago

README.md

Published catalogues: the baseline the fingerprint starts from#

What this folder contains#

File	Kind	Provenance
`baseline.json`	derived (the library's own output)	Every row of the 23 `PUBLISHED_*` mappings phonometry exported at commit `64deb4b1`, 1982 rows, dumped by `tests/catalogue_fingerprint.py`: each row as its fields, every float by its `repr`, one row per line. Fields that hold nothing are left out.

Nothing here is copied from a document. The file is what the library built from its own packaged tables (src/phonometry/**/data/*.json and the few tables still written in Python) on the day it was taken, so it holds the same transcriptions those tables hold, in the same words, and no more.

Source and authorship#

The values are the library's transcriptions of the published tables each row cites in its source field; the books and papers themselves are listed on the bibliography page of the site (site/src/content/docs/reference/bibliography.md).
The dump was written once with tests/catalogue_fingerprint.py and is never regenerated. A change that is meant to move a published cell is written as a step in that module instead, so that the file keeps saying what the catalogues held before the step and the step says what moved.

Purpose and scope of use#

tests/test_published_catalogue_fingerprint.py takes this baseline through every listed step and asserts that the result is, field for field and digit for digit, what the library builds today. It exists because the page generator's --check only sees the numbers as the site prints them, and a change in the last digit of a float, or a hedge moved from one field to another, does not show there. The file is not part of the phonometry package and is not installed with it.

Unlike the extracts elsewhere in tests/data/, this file is covered by this repository's MIT licence, the same terms as the packaged tables it was dumped from (src/phonometry/**/data/*.json), which the package already distributes under that licence. What it takes from each cited work is the transcribed numbers with the citation every row carries; no text, table layout, figure or page of any work is reproduced, and nothing in it comes from a file whose terms forbid redistribution.

Removal policy#

Removing the file removes the fingerprint and nothing else: the tests of tests/test_published_catalogue_fingerprint.py that read it would have to go with it, and every other test is independent of it.