File: headers.rst

package info (click to toggle)
gemmi 0.6.5%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 5,836 kB
  • sloc: cpp: 54,719; python: 4,743; ansic: 3,972; sh: 384; makefile: 73; f90: 42; javascript: 12
file content (335 lines) | stat: -rw-r--r-- 9,638 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

gemmi/addends.hpp
    Addends to scattering form factors used in DensityCalculator
    and in StructureFactorCalculator.

gemmi/align.hpp
    Sequence alignment, label_seq_id assignment, structure superposition.

gemmi/assembly.hpp
    Generating biological assemblies by applying operations
    from struct Assembly to a Model.
    Includes chain (re)naming utilities.

gemmi/asudata.hpp
    AsuData for storing reflection data.

gemmi/asumask.hpp
    AsuBrick and MaskedGrid that is used primarily as direct-space asu mask.

gemmi/atof.hpp
    Functions that convert string to floating-point number ignoring locale.
    Simple wrappers around fastfloat::from_chars().

gemmi/atox.hpp
    Locale-independent functions that convert string to integer,
    equivalents of standard isspace and isdigit, and a few helper functions.

gemmi/bessel.hpp
    Functions derived from modified Bessel functions I1(x) and I0(x).

gemmi/binner.hpp
    Binning - resolution shells for reflections.

gemmi/blob.hpp
    Finding maxima or "blobs" in a Grid (map).
    Similar to CCP4 PEAKMAX and COOT's "Unmodelled blobs".

gemmi/bond_idx.hpp
    BondIndex: for checking which atoms are bonded, calculating graph distance.

gemmi/c4322.hpp
    Electron scattering factor coefficients from the International Tables.

gemmi/calculate.hpp
    Calculate various properties of the model.

gemmi/ccp4.hpp
    CCP4 format for maps and masks.

gemmi/cellred.hpp
    Unit cell reductions: Buerger, Niggli, Selling-Delaunay.

gemmi/chemcomp.hpp
    ChemComp - chemical component that represents a monomer from Refmac
    monomer library, or from PDB CCD.

gemmi/chemcomp_xyz.hpp
    Reading coordinates from chemical component or Refmac monomer library files.

gemmi/cif.hpp
    CIF parser (based on PEGTL) with pluggable actions,
    and a set of actions that prepare Document.

gemmi/cif2mtz.hpp
    A class for converting SF-mmCIF to MTZ (merged or unmerged).

gemmi/cifdoc.hpp
    struct Document that represents the CIF file (but can be also
    read from JSON file, such as CIF-JSON or mmJSON).

gemmi/contact.hpp
    Contact search, based on NeighborSearch from neighbor.hpp.

gemmi/crd.hpp
    Generate Refmac intermediate (prepared) files crd and rst

gemmi/ddl.hpp
    Using DDL1/DDL2 dictionaries to validate CIF/mmCIF files.

gemmi/dencalc.hpp
    Tools to prepare a grid with values of electron density of a model.

gemmi/dirwalk.hpp
    Classes for iterating files in a directory tree, top-down,
    in an alphabetical order.  It wraps the tinydir library (as we cannot
    depend on C++17 <filesystem> yet).

gemmi/ecalc.hpp
    Normalization of amplitudes F->E ("Karle" approach, similar to CCP4 ECALC).

gemmi/eig3.hpp
    Eigen decomposition code for symmetric 3x3 matrices.

gemmi/elem.hpp
    Elements from the periodic table.

gemmi/enumstr.hpp
    Converts between enums (EntityType, PolymerType, Connection::Type,
    SoftwareItem::Classification) and mmCIF strings.

gemmi/fail.hpp
    fail(), unreachable() and __declspec/__attribute__ macros

gemmi/fileutil.hpp
    File-related utilities.

gemmi/floodfill.hpp
    The flood fill (scanline fill) algorithm for Grid.
    Assumes periodic boundary conditions in the grid and 6-way connectivity.

gemmi/formfact.hpp
    Calculation of atomic form factors approximated by a sum of Gaussians.
    Tables with numeric coefficient are in it92.hpp and c4322.hpp.

gemmi/fourier.hpp
    Fourier transform applied to map coefficients.

gemmi/fprime.hpp
    C++ implementation of Cromer-Liberman calculation of anomalous scattering
    factors, with corrections from Kissel & Pratt, Acta Cryst. A46, 170 (1990).
    Single header. No dependencies.

gemmi/fstream.hpp
    Ofstream and Ifstream: wrappers around std::ofstream and std::ifstream.

gemmi/grid.hpp
    3d grids used by CCP4 maps, cell-method search and hkl data.

gemmi/gz.hpp
    Functions for transparent reading of gzipped files. Uses zlib.

gemmi/input.hpp
    Input abstraction.
    Used to decouple file reading and uncompression.

gemmi/intensit.hpp
    Class Intensities that reads multi-record data from MTZ, mmCIF or XDS_ASCII
    and merges it into mean or anomalous intensities.
    It can also read merged data.

gemmi/interop.hpp
    Interoperability between Model (MX) and SmallStructure (SX).

gemmi/it92.hpp
    X-ray scattering factor coefficients from International Tables
    for Crystallography Volume C, edition from 1992 or later.

gemmi/iterator.hpp
    Bidirectional iterators (over elements of any container) that can filter,
    uniquify, group, or iterate with a stride.

gemmi/json.hpp
    Reading CIF-JSON (COMCIFS) and mmJSON (PDBj) formats into cif::Document.

gemmi/levmar.hpp
    Least-squares fitting - Levenberg-Marquardt method.

gemmi/linkhunt.hpp
    Searching for links based on the _chem_link table from monomer dictionary.

gemmi/math.hpp
    Math utilities. 3D linear algebra.

gemmi/metadata.hpp
    Metadata from coordinate files.

gemmi/mmcif.hpp
    Read mmcif (PDBx/mmCIF) file into a Structure from model.hpp.

gemmi/mmcif_impl.hpp
    Function used in both mmcif.hpp and refln.hpp (for coordinate and
    reflection mmCIF files).

gemmi/mmdb.hpp
    Converts between gemmi::Structure and mmdb::Manager.

gemmi/mmread.hpp
    Read any supported coordinate file.

gemmi/mmread_gz.hpp
    Functions for reading possibly gzipped coordinate files.
    Trivial wrappers that can make compilation faster
    by having a separate implementation file src/mmread_gz.cpp.

gemmi/model.hpp
    Data structures to keep macromolecular structure model.

gemmi/modify.hpp
    Modify various properties of the model.

gemmi/monlib.hpp
    Monomer library - (Refmac) restraints dictionary,
    which is made of monomers (chemical components), links and modifications.

gemmi/mtz.hpp
    MTZ reflection file format.

gemmi/mtz2cif.hpp
    A class for converting MTZ (merged or unmerged) to SF-mmCIF

gemmi/neighbor.hpp
    Cell-linked lists method for atom searching (a.k.a. grid search, binning,
    bucketing, cell technique for neighbor search, etc).

gemmi/neutron92.hpp
    Neutron coherent scattering lengths of the elements,
    from Neutron News, Vol. 3, No. 3, 1992.

gemmi/numb.hpp
    Utilities for parsing CIF numbers (the CIF spec calls it 'numb').

gemmi/pdb.hpp
    Read PDB file format and store it in Structure.

gemmi/pdb_id.hpp
    handling PDB ID and $PDB_DIR: is_pdb_code(), expand_pdb_code_to_path()

gemmi/pirfasta.hpp
    Read sequence from PIR or (multi-)FASTA format.

gemmi/polyheur.hpp
    Heuristic methods for working with chains and polymers.
    Includes also a few well-defined functions, such as removal of waters.

gemmi/qcp.hpp
    Structural superposition, the QCP method.

gemmi/read_cif.hpp
    Functions for reading possibly gzipped CIF files.
    Trivial wrappers that can make compilation faster
    by having a separate implementation file src/read_cif.cpp.

gemmi/read_map.hpp
    Functions for reading possibly gzipped CCP4 map files.
    Trivial wrappers that can make compilation faster.

gemmi/recgrid.hpp
    ReciprocalGrid -- grid for reciprocal space data.

gemmi/reciproc.hpp
    Reciprocal space helper functions.

gemmi/refln.hpp
    Reads reflection data from the mmCIF format.

gemmi/remarks.hpp
    Function read_metadata_from_remarks() that interprets REMARK 3
    and REMARK 200/230/240 filling in Metadata.

gemmi/resinfo.hpp
    List of common residues with basic data.

gemmi/riding_h.hpp
    Place hydrogens according to bond lengths and angles from monomer library.

gemmi/scaling.hpp
    Anisotropic scaling of data (includes scaling of bulk solvent parameters)

gemmi/select.hpp
    Selections.

gemmi/seqalign.hpp
    Simple pairwise sequence alignment.

gemmi/seqid.hpp
    SeqId -- residue number and insertion code together.

gemmi/seqtools.hpp
    Functions for working with sequences (other than alignment).

gemmi/serialize.hpp
    Binary serialization for Structure (as well as Model, UnitCell, etc)

gemmi/sfcalc.hpp
    Direct calculation of structure factors.

gemmi/small.hpp
    Representation of small molecule or inorganic crystal.
    Flat list of atom sites. Minimal functionality.

gemmi/smcif.hpp
    Read small molecule CIF file into SmallStructure (from small.hpp).

gemmi/solmask.hpp
    Flat bulk solvent mask. With helper tools that modify data on grid.

gemmi/span.hpp
    Span - span of array or std::vector.
    MutableVectorSpan - span of std::vector with insert() and erase()

gemmi/sprintf.hpp
    interface to stb_sprintf: snprintf_z, to_str(float|double)

gemmi/stats.hpp
    Statistics utilities: classes Covariance, Correlation, DataStats

gemmi/symmetry.hpp
    Crystallographic Symmetry. Space Groups. Coordinate Triplets.

gemmi/to_chemcomp.hpp
    Create cif::Block with monomer library _chem_comp* categories
    from struct ChemComp.

gemmi/to_cif.hpp
    Writing cif::Document or its parts to std::ostream.

gemmi/to_json.hpp
    Writing cif::Document or its parts as JSON (mmJSON, CIF-JSON, etc).

gemmi/to_mmcif.hpp
    Create cif::Document (for PDBx/mmCIF file) from Structure.

gemmi/to_pdb.hpp
    Writing PDB file format (Structure -> pdb file).

gemmi/topo.hpp
    Topo(logy) - restraints (from a monomer library) applied to a model.

gemmi/twin.hpp
    Twinning laws.

gemmi/unitcell.hpp
    Unit cell.

gemmi/utf.hpp
    Conversion between UTF-8 and wchar. Used only for file names on Windows.

gemmi/util.hpp
    Utilities. Mostly for working with strings and vectors.

gemmi/version.hpp
    Version number.

gemmi/xds_ascii.hpp
    Read unmerged XDS files: XDS_ASCII.HKL and INTEGRATE.HKL.