RAWTOPGM(1)

πŸ“¦
version 11.13.03 Β· 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’Ύ rawtopgm β€” Rawtopgm User Manual ✨

okay bestie, so this one is a little unhinged in the best way πŸ’– it's from the Netpbm family, and the whole vibe is: you got a pile of raw bytes that are secretly a picture, and rawtopgm turns them into a PGM so the rest of the world can look at them. no cap.


🌸 NAME 🌸

rawtopgm β€” convert raw grayscale bytes to a PGM image


πŸŽ€ SYNOPSIS πŸŽ€

rawtopgm

[-bpp [1|2]]

[-littleendian]

[-maxval N]

[-headerskip N]

[-rowskip N]

[-tb|-topbottom]

[width height]

[imagefile]

πŸ’… DESCRIPTION πŸ’…

So this program is part of Netpbm(1) 🫢 β€” one of the squad.

rawtopgm reads raw grayscale values as input and produces a PGM image as output. The input file is just a sequence of pure binary numbers, either one or two bytes each, either bigendian or littleendian, representing gray values. They may be arranged either top to bottom, left to right or bottom to top, left to right. And there may be arbitrary header information at the start of the file β€” rawtopgm pays no attention at all to that header other than its size. literally just vibing past it πŸ’€

The arguments to rawtopgm tell it how to interpret the pixels. that's a whole job that a regular graphics format would normally hand off to its header, but here you're the header, bestie 😌

The width and height parameters tell the dimensions of the image. If you omit these parameters, rawtopgm assumes it is a quadratic image and bases the dimensions on the size of the input stream. And if that size is not a perfect square, rawtopgm fails. periodt. πŸ“

⚠️ heads up β€” when you don't specify width and height, rawtopgm reads the entire input stream into storage at once, which may take a LOT of storage 😭 Otherwise, rawtopgm ordinarily stores only one row at a time, which is the chill version.

If you don't specify imagefile, or specify -, the input is from Standard Input.

The PGM output goes to Standard Output. iconic behavior tbqh ✨


✨ OPTIONS ✨

On top of the options common to all programs based on libnetpbm (most notably -quiet, see Common Options), rawtopgm recognizes these command line options πŸ’–

  • -maxval N β€” N is the maxval for the gray values in the input, and it's also the maxval of the PGM output image. The default is the maximum value that can be represented in the number of bytes used for each sample (i.e. 255 or 65535).
  • -bpp [1|2] β€” tells the number of bytes that represent each sample in the input. If the value is 2, the most significant byte is first in the stream. The default is 1 byte per sample.
  • -littleendian β€” says that the bytes of each input sample are ordered with the least significant byte first. Without this option, rawtopgm assumes MSB first. This obviously has no effect when there's only one byte per sample. πŸ’…
  • -headerskip N β€” rawtopgm skips over N bytes at the beginning of the stream and reads the image immediately after. The default is 0. This is useful when the input is actually some graphics format that has a descriptive header followed by an ordinary raster, and you don't have a program that understands the header β€” or you just want to ignore the header. ghosted, basically πŸ‘»
  • -rowskip N β€” if there's padding at the ends of the rows, you can skip it with this option. Note that rowskip need not be an integer. Amazingly, I once had an image with 0.376 bytes of padding per row 😭 This turned out to be due to a file-transfer problem, but I was still able to read the image. Skipping a fractional byte per row means skipping one byte per multiple rows. math ate, fr fr.
  • -bt / -bottomfirst β€” by default, rawtopgm assumes the pixels in the input go top to bottom, left to right. If you specify -bt or -bottomfirst, rawtopgm assumes the pixels go bottom to top, left to right. The Molecular Dynamics and Leica confocal format, for example, use the latter arrangement. ✨

If you don't specify -bt when you should, or vice versa, the resulting image is upside down β€” which you can correct with pamflip πŸ¦‹

This option causes rawtopgm to read the entire input stream into storage at once, which may take a lot of storage 😭 Normally, rawtopgm stores only one row at a time.

For backwards compatibility, rawtopgm also accepts -tb and -topbottom to mean exactly the same thing. The reason these are named backwards is that the original author thought of it as specifying that the wrong results of assuming the data is top to bottom should be corrected by flipping the result top for bottom. Today, we think of it as simply specifying the format of the input data so that there are no wrong results. character development honestly 🫢


πŸ‘‘ SEE ALSO πŸ‘‘

pgm(1), rawtoppm(1), pamflip(1)


πŸ’œ AUTHORS πŸ’œ

Copyright (C) 1989 by Jef Poskanzer. Modified June 1993 by Oliver Trepte, oliver@fysik4.kth.se


πŸ“š DOCUMENT SOURCE πŸ“š

This manual page was generated by the Netpbm tool makeman from HTML source. The master documentation is at

http://netpbm.sourceforge.net/doc/rawtopgm.html

okay and finally, the lil credits moment 🎬 this is the netpbm documentation, dated 14 September 2000, and it lives under the very glamorous title Rawtopgm User Manual(1). slay, go convert your bytes bestie πŸ’–πŸ¦‹πŸŽ€

πŸ“¦ where this page comes from