SLIDETOOL(1)

✨ SLIDETOOL ✨

okay bestie, so this is slidetool, and it lives in the User Commands section of the manual. it's giving very capable, very humble, and it's about to pull data out of your whole slide images 💅

---

🌸 NAME 🌸

slidetool — Retrieve data from whole slide images

---

🎀 SYNOPSIS 🎀

slidetool [--help] [--version]
slidetool assoc icc read file name [output-file]
slidetool assoc list file...
slidetool assoc read file name [output-file]
slidetool prop get property file...
slidetool prop list [--names] file...
slidetool region icc read file [output-file]
slidetool region read file x y level width height [output-file]
slidetool slide open file...
slidetool slide quickhash1 file...
slidetool slide vendor file...

---

🦋 DESCRIPTION 🦋

slidetool uses OpenSlide to retrieve data from whole slide images, also known as virtual slide files. no cap. that's the whole vibe. 🫶

🌈 slidetool assoc icc read

Write the associated image's ICC color profile to output-file if specified, and otherwise to standard output. If no ICC color profile is available, fail. that's it, that's the deal — no profile, no party. 😭

🍓 slidetool assoc list

List associated images for one or more slides. Associated images are small non-pyramidal images containing additional information about the slide, such as its label. tiny little bonus pics basically ✨

💜 slidetool assoc read

Write the associated image with the specified name to a PNG image. If output-file is not specified, the image will be written to standard output.

🌟 slidetool prop get

Print a single OpenSlide property value for one or more slides. Properties are individual pieces of textual metadata about the slide. Properties prefixed with openslide. are defined by OpenSlide; others are defined by the individual slide format. iykyk — the prefix tells you who's claiming it 💅

🧚 slidetool prop list

Print all OpenSlide properties for one or more slides. the full lore drop, no filter.

🌸 slidetool region icc read

Write the slide's ICC color profile to output-file if specified, and otherwise to standard output. If no ICC color profile is available, fail.

🔥 slidetool region read

Write a region of the specified level of a slide to a PNG image. x and y are pixel coordinates in level 0, the highest-resolution slide level. width and height are pixel dimensions in the specified level. If output-file is not specified, the image will be written to standard output.

The dimensions of each level of a slide can be obtained with slidetool prop list. pro tip from the manual itself, bestie, that's the cheat code 🎀

👑 slidetool slide open

Check whether OpenSlide can open one or more slide files. basically a vibe check for your file 🌈

💀 slidetool slide quickhash1

Print OpenSlide quickhash-1 checksums for one or more slides, in a format similar to sha256sum(1).

quickhash-1 is a non-cryptographic, 256-bit hash of a subset of a slide's data. It uniquely identifies a particular slide, but cannot be used to detect corruption or modification of the slide file. so like... it's an ID card, not a security guard. do not use it for integrity checks, fr fr 🙈

quickhash-1 is not defined for all slide files supported by OpenSlide. If a slide does not have a quickhash-1, "No quickhash-1 available" will be printed. iconic behavior honestly.

⭐ slidetool slide vendor

Report the detected OpenSlide vendor name for one or more slide files. who made you, little file? 💖

---

✨ OPTIONS ✨

• --help — Display usage summary.
• --names — For slidetool prop list, omit property values. just the names, no receipts 💅
• --version — Display version and copyright information.

---

💅 EXIT STATUS 💅

slidetool returns 0 on success, 1 if a slide file could not be read, or 2 if the arguments are invalid.

so: 0 = slay, 1 = the file said no, 2 = you typed it wrong bestie 😭

---

🌸 COPYRIGHT 🌸

Copyright © 2007-2023 Carnegie Mellon University and others

OpenSlide is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1 ⟨http://gnu.org/licenses/lgpl-2.1.html⟩.

OpenSlide comes with NO WARRANTY, to the extent permitted by law. See the GNU Lesser General Public License for more details.

NO WARRANTY is in all caps for a reason, bestie. read the license, it's literally right there 🫶

---

🌈 SEE ALSO 🌈

openslide-quickhash1sum(1), openslide-show-properties(1), openslide-write-png(1), sha256sum(1)

---

and that's the whole page, bestie 💖 this was OpenSlide 4.0.0, dated 2023-07-27 — mwah, go read some slides, you got this 👑✨🎀