Skip to content

Add tag definitions to README #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Add tag definitions to README #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Run a single tag against a supplied value or multiple tags using a config file (
|-----------------------------|-------------------------------------------------------------------------------------------------------|
| `-h`, `--help` | Show this help message and exit |
| `-i`, `--input` | Path to the input `qctools.xml.gz` or `qctools.mkv` file |
| `-t`, `--tagname` | The tag name you want to test (e.g., `SATMAX`) |
| `-t`, `--tagname` | The tag name you want to test (e.g., `SATMAX`); see table of tag names below for list |
| `-o`, `--over` | Threshold overage number |
| `-u`, `--under` | Threshold under number |
| `-p`, `--profile` | Compare frame data against tag values from `config.txt`. Use `-p default` for QCTools default values |
Expand All @@ -40,6 +40,20 @@ Run a single tag against a supplied value or multiple tags using a config file (
| `-pr`, `--print` | Print over/under frame data to console (default: off) |
| `-q`, `--quiet` | Suppress ffmpeg output in console (default: off) |

## Tags

| Tag category | Tag names |
|-----------------------------|-------------------------------------------------------------------------------------------------------|
| [YUV values](https://bavc.github.io/qctools/filter_descriptions.html#yuv) | `YMIN,YLOW,YAVG,YHIGH,YMAX`<br>`UMIN,ULOW,UAVG,UHIGH,UMAX`<br>`VMIN,VLOW,VAVG,VHIGH,VMAX` |
| [YUV values (difference)](https://bavc.github.io/qctools/filter_descriptions.html#diff) | `YDIF,UDIF,VDIF` |
| [Saturation values](https://bavc.github.io/qctools/filter_descriptions.html#saturation) | `SATMIN,SATLOW,SATAVG,SATHIGH,SATMAX` |
| [Hue values](https://bavc.github.io/qctools/filter_descriptions.html#hue) | `HUEMED,HUEAVG` |
| [Temporal outliers](https://bavc.github.io/qctools/filter_descriptions.html#tout) | `TOUT` |
| [Vertical line repetitions](https://bavc.github.io/qctools/filter_descriptions.html#vrep) | `VREP` |
| [Broadcast range](https://bavc.github.io/qctools/filter_descriptions.html#brng) | `BRNG` |
| [Mean square error fields](https://bavc.github.io/qctools/filter_descriptions.html#msef) | `mse_y,mse_u,mse_v,mse_avg` |
| [Peak signal to noise ratio fields](https://bavc.github.io/qctools/filter_descriptions.html#psnrf) | `psnr_y,psnr_u,psnr_v,psnr_avg` |

## Examples

### Run single tag tests
Expand Down
Loading