GET_HKL(1)

📦 version 0.13.0, in nixos 26.05, nixpkgs unstable

💖 GET_HKL(1) — the get_hkl glow-up page 💖

okay so bestie, welcome to the General Commands Manual page for GET_HKL(1) — command name get_hkl, vibe: reflection-data manipulation. we're gonna keep every flag, every file, every warning, and make it make sense. no cap.

✨ NAME ✨

get_hkl — manipulate reflection data. short, iconic, to the point.

🌈 SYNOPSIS 🌈

get_hkl -i reflections.hkl -y pointgroup [options] ... -o output.hkl

get_hkl --help

💅 DESCRIPTION 💅

get_hkl does various manipulations on reflection lists, bestie. possible manipulations include: expanding to a point group of lower symmetry, 'twinning' to a point group of higher symmetry, adding noise, restricting the list to contain only reflections included in another 'template' list, and some less common miscellaneous manipulations. it's giving "reflection list makeover" energy.

The input filename should be specified with -i filename or --input=filename. The output filename should be specified with -o filename or --output=filename. Beyond these parameters, you can choose one of the manipulations described below.

⚠️ warning, bestie: the behaviour if multiple manipulations are requested is undefined. do not stack manipulations and hope for the best. perform multiple manipulations in explicit separate steps instead. periodt.
  • -p unitcell.cell, -p unitcell.pdb, --pdb=unitcell.pdb — specify the name of the file containing unit cell information, in PDB or CrystFEL format.

🎀 CHOOSING THE OUTPUT FORMAT 🎀

  • --output-format=format — the output file will be written in format, which can be mtz, mtz-bij or xds. use mtz-bij to put Bijvoet pairs together in the same row, suitable for anomalous phasing. otherwise, use mtz. if you omit this option, the output will be in the usual CrystFEL reflection list format.

🦋 EXPANDING REFLECTIONS INTO A POINT GROUP OF LOWER SYMMETRY 🦋

  • -e pointgroup, --expand=pointgroup — the reflections will be expanded out, according to the symmetry of the input reflections, to fill the asymmetric unit of pointgroup.

🌸 REDUCING REFLECTIONS INTO A POINT GROUP OF HIGHER SYMMETRY 🌸

  • -w pointgroup, --twin=pointgroup — reflections in the list which are equivalent according to pointgroup will have their intensities summed. the output reflection list will contain the summed intensities in the asymmetric unit for pointgroup. reflections for which any of the 'twin mates' are missing will not be written out, unless you use --no-need-all-parts.
  • --no-need-all-parts — this is the "okay bestie, write them out anyway" switch for the missing-twin-mates situation described with -w/--twin above.

💜 ADDING NOISE 💜

  • --noise — add 10% flat random noise.
  • --poisson — generate Poisson noise. if Poisson noise is to be generated, the reflection intensities will be assumed to be measured in arbitrary units, and the conversion factor to photons must be given using --adu-per-photon=n, where n is the conversion factor.
  • --adu-per-photon=n — see --poisson. it's the conversion factor to photons, with n as the conversion factor.

🧚 REMOVING DUPLICATED REFLECTIONS 🧚

  • --trim-centrics — reflections which are duplicated, according to the symmetry of the input reflection list, will be removed. this is sometimes useful when importing data from other programs.

🍓 RESTRICTING REFLECTIONS ACCORDING TO A TEMPLATE 🍓

  • -t filename, --template=filename — only reflections in the input list which also appear in filename will be written to the output.

👑 MULTIPLICITY 👑

  • --multiplicity — the intensities of the reflections will be multiplied by their symmetric multiplicities according to the point group of the input list.

🔥 APPLYING A RESOLUTION CUTOFF 🔥

  • --cutoff-angstroms=n — in the first form, reflections with d (=lamba/2*sin(theta)) < n will be removed.
  • --cutoff-angstroms=n1,n2,n3 — in the second form, anisotropic truncation will be performed with separate resolution limits n1, n2 and n3 along a*, b* and c* respectively. you must also specify -p or --pdb.
  • --highres=n — --highres is a synonym for --cutoff-angstroms.
  • --lowres=n — the option --lowres will remove reflections with d > n.

🌈 REINDEXING REFLECTIONS 🌈

  • --reindex=op — reindex the reflections according to op. example: --reindex=k,h,-l.

⭐ OVERRIDING THE INPUT SYMMETRY ⭐

  • -y pg, --symmetry=pg — use pg for the symmetry of the input data. in almost all cases, you should omit this option which will cause the program to use the point group recorded in the headers of the input data.

💖 AUTHOR 💖

this page was written by Thomas White.

🙈 REPORTING BUGS 🙈

report bugs to taw@physics.org, or visit http://www.desy.de/~twhite/crystfel.

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

get_hkl, 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.

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 🫶

okay that's the whole page, bestie — GET_HKL(1) from the General Commands Manual, with the date-ish copyright bit © 2012-2021, and the footer tag is just GET_HKL(1). go manipulate those reflection lists responsibly 💅✨💖

📦 where this page comes from