MAKE_PIXELMAP(1)

💅 MAKE_PIXELMAP(1) — General Commands Manual 🎀

okay bestie, so this is make_pixelmap(1), straight out of the CrystFEL fam, and it's literally the glow-up your detector geometry deserves ✨

🌸 NAME 🌸

make_pixelmap — create a pixelmap from a CrystFEL geometry file 🦋

✨ SYNOPSIS ✨

make_pixelmap [options] input.geom

make_pixelmap --help

💖 DESCRIPTION 💖

okay so picture this: make_pixelmap takes a CrystFEL geometry file as input, and produces an HDF5 "pixel map" — the same kind of thing Cheetah and OnDA use 👑 no cap.

That HDF5 file is gonna contain three arrays: /x, /y and /z, holding the x, y and z coordinates for each pixel respectively, in metres, in real space. periodt 💅

And that's not all — the file also contains /res and /coffset. /res is the resolution of the detector (that's one over the pixel size in metres, iykyk), and /coffset is the default coffset value for the detector — or, if there's no default value set, it's the value for the first panel 🫶

⚠️ heads up bestie: make_pixelmap currently assumes the file layout is "slabby" — meaning all of the image data appears in one "slab", with the fs and ss coordinates of each pixel being unique across the entire detector. That's the assumption, fr fr. 😭

With --badmap, make_pixelmap will instead write a map of bad pixels according to the bad regions specified in the geometry file 🔥 iconic behaviour honestly.

🦋 OPTIONS 🦋

• --badmap — Create a bad pixel mask instead of a pixel geometry map 💀 the values used for good and bad pixels in this map come from --good-pixel and --bad-pixel respectively. ngl, note that CrystFEL also has other ways of specifying bad regions, like providing a separate mask. This program is only concerned with the regions specified using "bad_" in the geometry file 🎀
• --good-pixel=n
• --bad-pixel=n — Specify the values to use in the mask for good and bad pixels, respectively. The defaults are --good-pixel=1 and --bad-pixel=0 ✨
• -o output.h5
• --output=output.h5 — Set the output filename. The default output filename is input.h5, i.e. the input filename with its extension changed to .h5 🍓

💜 AUTHOR 💜

This page was written by Thomas White. shoutout to him 👑

🙈 REPORTING BUGS 🙈

Report bugs to <taw@physics.org>, or visit <http://www.desy.de/~twhite/crystfel> — they wanna hear from you, bestie 🫶

🌈 COPYRIGHT AND DISCLAIMER 🌈

Copyright © 2015-2021 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association.

make_pixelmap, and this manual, are part of CrystFEL 💖

CrystFEL is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version 🎀

CrystFEL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. not me being dramatic but fr fr read the license 😭

You should have received a copy of the GNU General Public License along with CrystFEL. If not, see <http://www.gnu.org/licenses/>.

⭐ SEE ALSO ⭐

crystfel(7), crystfel_geometry(5)

---

okay that's the whole thing bestie, mwah 💋 this page lives in the General Commands Manual of the CrystFEL manual set — go make some pixelmaps, you're gonna slay 🧚‍♀️✨