VistaIOSelectBand(3)

💖 VistaIOSelectBand(3) — Library Functions Manual 💖

okay bestie, welcome to the VistaIOSelectBand page, she's a lil library function from the VistaIO crew and she is here to help you pick out band(s) of image pixels. no cap. let's get into it 🦋

---

✨ NAME ✨

VistaIOSelectBand — select bands of image pixels 🎀

---

🌸 SYNOPSIS 🌸

#include <vistaio.h>

VistaIOBoolean VistaIOSelectBand (routine, image, band, npixels, first_pixel)
       VistaIOStringConst routine;
       VistaIOImage image;
       VistaIOBand band;
       int *npixels;
       VistaIOPointer *first_pixel;

---

💅 ARGUMENTS 💅

• routine — this one names the routine that's using VistaIOSelectBand to check its arguments. the name gets dropped into any error messages that VistaIOSelectBand spits out, so like, everyone knows who's responsible 🙈
• image — specifies the image whose pixels are gonna get selected, periodt.
• band — may specify one particular band of the image to select, OR it can be VistaIOAllBands, which means "girl, give me every single band of this image." both options are valid, she's flexible 💖
• npixels — returns the number of pixels selected. or it can be NULL if you're not about that number life. either way is fine ✨
• first_pixel — returns the address of the first pixel selected. or NULL, same deal, no pressure 🫶

---

🌈 DESCRIPTION 🌈

VistaIOSelectBand selects one band, or literally all the bands, of an image for processing. it's giving "picker of pixels." 👑

so image tells her which image we're working with, and band tells her either a single band of that image or all the bands of that image. then she does a lil vibe check on those two arguments (validity check, bestie, she's thorough), and after that she hands back — via npixels and first_pixel — the number and location of the pixels that got selected. and yes, those pixels are chillin' in a contiguous block of memory, all cozy together 🧚

either npixels or first_pixel can be NULL if that's the corresponding return value you actually want. you don't have to take both, she's not gonna force you. 💅

---

⭐ RETURN VALUES ⭐

VistaIOSelectBand returns TRUE if her image and band arguments are consistent with each other, and FALSE otherwise. slay or not slay, that's the whole deal 🌸

---

👑 SEE ALSO 👑

VistaIOImage(3), 💜

---

💀 DIAGNOSTICS 💀

``Routine: Band band referenced in image of nbands band(s).''

this one means the band argument is invalid, given the number of bands in image. like, you asked for a band that does not exist, bestie 😭. and Routine will be the name that was supplied by the routine argument — so yeah, that's why routine is there, it takes the blame for you 🙈

---

🎀 AUTHOR 🎀

Art Pope <pope@cs.ubc.ca>

Adaption to vistaio: Gert Wollny <gw.fossdev@gmail.com>

---

and that's the whole page, you ate it, you understood it, iconic behavior fr fr 🦋✨

this was brought to you by VistaIO Version 1.2.14, dated 24 April 1993 — yes she's an older queen but she still serves 💅👑💖