UNU-JHISTO(1)

✨ UNU-JHISTO(1) ✨

okay bestie, welcome to the unu-jhisto page of the User Commands manual 💖 this one lives in section 1, and it's literally the joint-histogram-maker of your dreams. sit down, grab a strawberry 🍓, let's get into it.

🌸 NAME 🌸

unu-jhisto — create joint histogram of two or more nrrds

🎀 SYNOPSIS 🎀

unu jhisto -b,--bin <bins0 bins1 ...> [-w,--weight <nweight>]
[-min,--minimum <min0 min1 ...>] [-max,--maximum <max0 max1 ...>]
[-t,--type <type>] [-i,--input <nin0 nin1 ...>] [-a,--axis <axis>]
[-o,--output <nout>]

🦋 DESCRIPTION 🦋

Create joint histogram of two or more nrrds. no cap. 💅

Each axis of the output corresponds to one of the input nrrds, and each bin in the output records the number of corresponding positions in the inputs with a combination of values represented by the coordinates of the bin. so like… every axis is a whole entire nrrd, and every bin is out here counting up how many spots in the inputs landed on that exact combo of values. iconic behaviour honestly.

• Uses nrrdHistoJoint

✨ OPTIONS ✨

• -b <bins0 bins1 ...> , --bin <bins0 bins1 ...> — bins<i> is the number of bins to use along axis i (of joint histogram), which represents the values of nin<i> (2 or more size_ts). so yeah, one bin count per axis, and you need at least two of them, periodt.
• -w <nweight> , --weight <nweight> — how to weigh contributions to joint histogram. By default (not using this option), the increment is one bin count per sample, but by giving a nrrd, the value in the nrrd at the corresponding location will be the bin count increment. lowkey the glow-up version of counting: instead of +1 every time, you hand over a whole nrrd and whatever number lives at that spot becomes the increment 👑
• -min <min0 min1 ...> , --minimum <min0 min1 ...> — min<i> is the low range of values to be quantized along axis i; use “nan” to represent lowest value present (2 or more doubles). yes bestie, you can literally type nan and it'll go find the lowest value that's actually there 🫶
• -max <max0 max1 ...> , --maximum <max0 max1 ...> — max<i> is the high range of values to be quantized along axis i; use “nan” to represent highest value present (2 or more doubles). same energy as -min but for the top end, and yeah, nan means "just grab whatever the highest value present is" 🌈
• -t <type> , --type <type> — type to use for output (the type used to store hit counts in the joint histogram). Clamping is done on hit counts so that they never overflow a fixed-point type; default: “uint”. > heads up bestie: if you pick a fixed-point type, your hit counts get clamped so they never overflow — so if you're expecting huge counts, think about that type choice fr fr.
• -i <nin0 [nin1] ...> , --input <nin0 [nin1] ...> — list of nrrds (one for each axis of joint histogram), or, single nrrd that will be sliced along specified axis. (1 or more nrrds); default: “-”. so either you feed it one nrrd per axis, or you feed it one single nrrd and it gets sliced along the axis you specified. either way, if you don't say anything, it's reading from - 🧚
• -o <nout> , --output <nout> — output nrrd (string); default: “-”. and if you don't say anything here either, it's writing to - 💜

👑 SEE ALSO 👑

• unu(1)

that's the whole page, bestie, you ate it up 💅 this page is from the User Commands manual, dated August 2021 — mwah, enjoy your joint histograms, no cap 🎀✨🦋