allyhub frames compare
How a candidate picture differs from a reference, as numbers (ΔE, channels, SSIM, levels, grain, edges, regions) with a heatmap and a side-by-side: a piece's moment, a picture file or a video file's frame
allyhub frames compare [reference] [candidate] [options]Arguments
Section titled “Arguments”| Argument | Type | What it is |
|---|---|---|
<reference> |
string | The reference picture (PNG, WebP, JPEG…) |
<candidate> |
string | A piece (its id, its file without its extension, or its file; default the project’s only one) at –at or –part’s still; or a file by its extension: a picture (.png, .jpg, .webp…), or a video file’s frame at –at (.mp4, .mov, .webm…) |
Options
Section titled “Options”| Option | Type | Default | What it does |
|---|---|---|---|
--combo |
list of string | The first combo matching name=value pairs joined with commas (lang=zh-cn,hook=b), or a combo’s id (c03); default the first combo | |
--at |
string | The moment: seconds (from the start of –part when given) or an anchor of the piece; a video file’s are seconds (default 0) | |
--part |
string | The piece’s part –at counts from; alone, its still | |
--ref-crop |
string | Cut the reference to x,y,width,height, or to an element of the elements.json beside it (frames web writes one) | |
--crop |
string | Cut the candidate to x,y,width,height before any resize | |
--encode |
string | Draw the candidate through this encode first, as a platform serves it: codec:kbps, h264 or hevc (hevc:618) | |
--out |
string | Where its files go, a path without extension; default under .allyhub/work/compare/ |
Parameters
Section titled “Parameters”Each is given as --param name=value.
| Name | Type | Default | What it does |
|---|---|---|---|
resize |
stretch, width, none |
"stretch" |
When sizes differ: stretch the candidate to the reference, scale it to its width, or compare the common area |
shift |
integer | 0 |
Search the best offset within this many pixels each way |
Global options
Section titled “Global options”--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.
Output
Section titled “Output”With --json, the command prints an object with these fields:
| Field | Type | What it is |
|---|---|---|
reference |
string | |
files |
object |
Examples
Section titled “Examples”allyhub frames compare reference.png launch/film --at 2.5 --encode hevc:618allyhub frames compare reference.png shot.webp --ref-crop ctaallyhub frames compare reference.png theirs.mp4 --at 3Exit codes
Section titled “Exit codes”0 when it succeeds; the others are listed in Exit codes.
In the work
Section titled “In the work”decks: Making a deck
slides capabilities → slides import → check → frames → frames compare → inspect layout → inspect contrast → dev → render
websites: Making a website: any web project, with its website JSON listed in allyhub.yaml
check → render → frames web → frames compare → site deploy → site status → site live
references: Studying reference videos, and a piece against them
reference → reference compare → reference set → frames → frames compare → words → audio → align