mia-2dsegm...cal-kmeans(1)

📦
version 2.4.7 · 2 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 mia-2dsegment-local-kmeans 💖

bestie. hi. come sit. this is a General Commands Manual page, section 1, and it's about mia-2dsegment-local-kmeans — a whole 2D image segmenter that lives in your terminal and does localized k-means. i'm gonna walk you through literally everything on the page, no skips, no "we'll come back to that", fr fr. ✨

🌸 NAME 🌸

mia-2dsegment-local-kmeans — Run a k-means segmentation of a 2D image.

like... that's the whole vibe. it segments. 2D. k-means. 💅

🎀 SYNOPSIS 🎀

mia-2dsegment-local-kmeans -i <in-file> [options]

you give it an input file, you stack options on top. that's the shape of every call you'll ever write, bestie.

🦋 DESCRIPTION 🦋

okay so listen. mia-2dsegment-local-kmeans runs the segmentation of a 2D image by applying a localized k-means approach that helps to overcome intensity inhomogeneities in the image.

it's giving... glow-up for your image. the plan is this:

  1. The approach evaluates a global k-means clustering first. a little warm-up, a little opening number. 👑
  2. Then it separates the image into overlapping regions.
  3. Then more k-means iterations are run only including the locally present classes — that is, the classes that relatively contain more pixels than a given threshold.

so the local regions don't waste time on classes that barely show up there. iconic behavior, honestly. the intensity inhomogeneities never saw it coming. 😭

✨ OPTIONS ✨

📁 File-IO

  • -i, --in-file=(input, required); io — the image to be segmented. This one is required, so like, don't forget it. For supported file types see PLUGINS:2dimage/io. 💖
  • -o, --out-file=(output); io — class label image based on merging local labels. For supported file types see PLUGINS:2dimage/io. 🌸
  • -O, --out-file2=(output); io — class label image based on classifying by using the interpolated class centers. For supported file types see PLUGINS:2dimage/io. ✨
  • -D, --debug-centers=(output); io — Save the class center images to a debug file (type is double). For supported file types see PLUGINS:2dimage/io. 🧚

💬 Help & Info

  • -V, --verbose=warning — verbosity of output, print messages of given level and higher priorities. Supported priorities starting at lowest level are:
    • trace ‐ Function call trace
    • debug ‐ Debug output
    • info ‐ Low level messages
    • message ‐ Normal messages
    • warning ‐ Warnings
    • fail ‐ Report test failures
    • error ‐ Report errors
    • fatal ‐ Report only fatal errors
  • --copyright — print copyright information.
  • -h, --help — print this help.
  • -?, --usage — print a short help.
  • --version — print the version number and exit.

🎛️ Parameters

  • -g, --grid-spacing=20; int in [3, inf) — Spacing of the grid used to modulate the intensity inhomogeneities. default is 20, and it's an integer that has to be 3 or bigger (no upper bound). 🔥
  • -n, --nclasses=3; uint in [2, 127] — Number of intensity classes to segment. defaults to 3, and the allowed range is 2 through 127, unsigned ints only. 🎀
  • -t, --relative-cluster-threshold=0.0001; double in [0, 1) — Number of intensity classes to segment. yes bestie, the page literally says the same sentence as -n does, i'm just reporting what's on the page 😭. what's actually on the line is the value type: default 0.0001, a double in [0, 1) — so 0 is allowed, 1 is not.

⚙️ Processing

  • --threads=-1 — Maxiumum number of threads to use for processing. (that spelling is the page's spelling, i am not touching it 💀) This number should be lower or equal to the number of logical processor cores in the machine. (-1: automatic estimation).

🌈 PLUGINS: 2dimage/io 🌈

these are all the file type plug-ins that the io fields above can reach for. each one has its own recognized extensions and element types. no cap, this list is long and every single one matters.

🌟 bmp

BMP 2D-image input/output support. The plug-in supports reading and writing of binary images and 8-bit gray scale images. read-only support is provided for 4-bit gray scale images. The color table is ignored and the pixel values are taken as literal gray scale values.

  • Recognized file extensions: .BMP, .bmp
  • Supported element types: binary data, unsigned 8 bit

🌟 datapool

Virtual IO to and from the internal data pool.

  • Recognized file extensions: .@

🌟 dicom

2D image io for DICOM.

  • Recognized file extensions: .DCM, .dcm
  • Supported element types: signed 16 bit, unsigned 16 bit

🌟 exr

a 2dimage io plugin for OpenEXR images.

  • Recognized file extensions: .EXR, .exr
  • Supported element types: unsigned 32 bit, floating point 32 bit

🌟 jpg

a 2dimage io plugin for jpeg gray scale images.

  • Recognized file extensions: .JPEG, .JPG, .jpeg, .jpg
  • Supported element types: unsigned 8 bit

🌟 png

a 2dimage io plugin for png images.

  • Recognized file extensions: .PNG, .png
  • Supported element types: binary data, unsigned 8 bit, unsigned 16 bit

🌟 raw

RAW 2D-image output support.

  • Recognized file extensions: .RAW, .raw
  • Supported element types: binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit

🌟 tif

TIFF 2D-image input/output support.

  • Recognized file extensions: .TIF, .TIFF, .tif, .tiff
  • Supported element types: binary data, unsigned 8 bit, unsigned 16 bit, unsigned 32 bit

🌟 vista

a 2dimage io plugin for vista images.

  • Recognized file extensions: .-, .V, .VISTA, .v, .vista
  • Supported element types: binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit

🔥 EXAMPLE 🔥

Run the segmentation on image test.png using three classes, local regions of 40 pixels (grid width 20 pixels), and a class ignore threshold of 0.01.

mia-2dsegment-local-kmeans -i test.png -o label.png -n 3 -g 20 -t 0.01

that's it. that's the whole glow-up. hit enter and let her cook. 👑

💜 AUTHOR(s) 💜

Gert Wollny

This software is Copyright (c) 1999‐2015 Leipzig, Germany and Madrid, Spain. It comes with ABSOLUTELY NO WARRANTY and you may redistribute it under the terms of the GNU GENERAL PUBLIC LICENSE Version 3 (or later). For more information run the program with the option '--copyright'.

⚠️ ok genuine note bestie: ABSOLUTELY NO WARRANTY is not a vibe, it's a legal fact, and --copyright is the receipt. respect it. 🙈

and that's the page!! thanks for reading the whole thing, you ate that. this was the USER COMMANDS section, version v2.4.7, dated as the original page is dated — mwah, love u, go segment something gorgeous. 🫶💖✨🎀💅

📦 where this page comes from