VMTKIMAGECOMPARE(1)

📦 version 1.5.0, in ubuntu stonking

💖 VMTKIMAGECOMPARE(1) 💖

okay bestie, welcome to vmtkimagecompare — it's a User Commands page, it lives in the vmtk script family, and it is literally about to become your fave. 🦋

✨ NAME ✨

vmtkimagecompare — the vmtk script vmtkimagecompare, and yes she said her own name twice, she's iconic like that 💅

🎀 DESCRIPTION 🎀

So the vibe here is automatic piping, bestie. vmtkimagecompare is doing automatic piping, then it's parsing options, then it's vmtkimagecompare again. That's the whole pipeline of the description and we are not skipping a crumb of it. 🍓

And what does she actually do?

vmtkimagecompare : compares an image against a reference 👑

That's it. That's the job. She puts two images in a vibe check together and tells you if they're the same. 🌈

🌸 Input arguments 🌸

  • -id Id (str,1); default=0 — the script id, your little name tag at the party 🎀
  • -handle Self (self,1) — handle to self, aka she's holding her own hand, and honestly? self-love, we stan 🫶
  • -disabled Disabled (bool,1); default=0 — disable execution and piping. when set, she's ✨not doing all that✨ (set it to 1 and she simply clocks out) 💅
  • -i Image (vtkImageData,1) — the input image, the main character 😌
  • -ifile ImageInputFileName (str,1) — filename for the default Image reader, for when you'd rather point at a file than hand her the object 📁
  • -r ReferenceImage (vtkImageData,1) — the reference image to compare against, i.e. the standard she's being held to 😤
  • -rfile ReferenceImageInputFileName (str,1) — filename for the default ReferenceImage reader 📁✨
  • -method Method (str,1) in ['subtraction', 'range'] — method of the test. two choices, no more, no less, pick your fighter 🥊
  • -tolerance Tolerance (float,1); default=1e-08 — tolerance for numerical comparisons. she's forgiving, but only by 1e-08, so don't push it 💀

💜 Output arguments 💜

  • -id Id (str,1); default=0 — script id, returning to the group chat 🎀
  • -handle Self (self,1) — handle to self, she's still holding on 🫶
  • -result Result (bool,1) — Output boolean stating if images are equal or not. the moment of truth, the reveal, the season finale 😭
  • -log ResultLog (str,1) — Result Log, the receipts, the paper trail, the screenshots 📝

🌟 SEE ALSO 🌟

nothing else listed here bestie, she's an only child 💀

⚠️ heads up: this page is short and sweet and there is no further warning, exit status, environment variable, bug, author, copyright or license info in the original, so there's none here either. no cap. 🔥

sign-off time, bestie 🌈✨

this was vmtkimagecompare version 1.5, dated April 2026, from the VMTKIMAGECOMPARE(1) manual. go compare some images, you absolute legend. 💖🦋🎀

📦 where this page comes from