Skip to content
e873
CCP4 documentation
CIF2MTZ (CCP4: Supported Program)
Type to start searching
CCP4 documentation
e873
CCP4 documentation
"Contents"
CIF2MTZ (CCP4: Supported Program)
NAME
SYNOPSIS
DESCRIPTION
KEYWORDED INPUT
TITLE
</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#cell-a-b-c-alpha-beta-gamma" class="md-nav__link">CELL <a> <b> <c> [ <alpha> <beta> <gamma> ]</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#symmetry-spacegroup" class="md-nav__link">SYMMETRY <spacegroup></a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#labout-program-label-file-label" class="md-nav__link">LABOUT <program label>=<file label> …</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#name-project-pname-crystal-xname-dataset-dname" class="md-nav__link">NAME PROJECT <pname> CRYSTAL <xname> DATASET <dname></a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#block-blockname" class="md-nav__link">BLOCK <blockname></a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#anomalous" class="md-nav__link">ANOMALOUS</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#status-xplo-ccp4" class="md-nav__link">STATUS XPLO | CCP4</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#end" class="md-nav__link">END</a> </li></ul> </nav> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#error-messages" class="md-nav__link">ERROR MESSAGES</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#examples" class="md-nav__link">EXAMPLES</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#author" class="md-nav__link">AUTHOR</a> </li> <li class="md-nav__item"><a target="_top" href="/newspapers?url=#see-also" class="md-nav__link">SEE ALSO</a> </li></ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content"> <article class="md-content__inner md-typeset" role="main"> <section id="cif2mtz-ccp4-supported-program"> <h1 id="cif2mtz--page-root">CIF2MTZ (CCP4: Supported Program)<a class="headerlink" target="_top" href="/newspapers?url=#cif2mtz--page-root" title="Permalink to this heading">¶</a></h1> <section id="name"> <h2 id="name">NAME<a class="headerlink" target="_top" href="/newspapers?url=#name" title="Permalink to this heading">¶</a></h2> <p><strong>cif2mtz</strong> - Convert an mmCIF reflection file to MTZ format</p> </section> <section id="synopsis"> <h2 id="synopsis">SYNOPSIS<a class="headerlink" target="_top" href="/newspapers?url=#synopsis" title="Permalink to this heading">¶</a></h2> <div class="line-block"> <div class="line"><strong>cif2mtz hklin</strong> <em>foo.cif</em> <strong>hklout</strong> <em>foo.mtz</em></div> <div class="line">[<a class="reference external" target="_top" href="/newspapers?url=#keywords">Keyworded input</a>]</div> </div> </section> <section id="description"> <span id="id1"></span><h2 id="description">DESCRIPTION<a class="headerlink" target="_top" href="/newspapers?url=#description" title="Permalink to this heading">¶</a></h2> <p>CIF2MTZ is a program to convert an mmCIF reflection file to MTZ format. mmCIF reflection files are typically obtained from the Protein Data Bank. There are <a class="reference external" target="_top" href="/newspapers?url=#examples">examples</a> below for some representative PDB entries.</p> <p>In practice, mmCIF reflection files from the PDB can have a wide variety of data item names and contents. The program will attempt to identify quantities correctly, but you should always check the resulting MTZ file. Keywords are provided to supply missing information or to help the program make choices.</p> <p>There are a large number of mmCIF reflection files in the PDB which contain the PDB coordinate file header as a comment block. In particular, cell and symmetry information is held as the CRYST1 line, rather than using the correct mmCIF categories. The program will therefore look for a CRYST1 line, as well as the mmCIF categories. If neither are present, then cell and symmetry information must be provided via keywords.</p> <p><strong>Note:</strong> CIF2MTZ works with the macromolecular CIF format “mmCIF” which is substantially different from the original “CIF” format. The latter is usually used within small molecule crystallography, but you may come across it with SHELX. Small molecule “CIF” format has a different syntax (i.e. it is based on DDL1 rather than DDL2) and so cannot easily be read from CIF2MTZ. If you don’t know what format a file is in, look for _cell.length_a (with period: mmCIF) or _cell_length_a (with underscore: CIF).</p> </section> <section id="keyworded-input"> <span id="keywords"></span><h2 id="keyworded-input">KEYWORDED INPUT<a class="headerlink" target="_top" href="/newspapers?url=#keyworded-input" title="Permalink to this heading">¶</a></h2> <p>Possible keywords are:</p> <blockquote> <div><p><a class="reference external" target="_top" href="/newspapers?url=#title">TITLE</a>, <a class="reference external" target="_top" href="/newspapers?url=#labout">LABOUT</a>, <a class="reference external" target="_top" href="/newspapers?url=#cell">CELL</a>, <a class="reference external" target="_top" href="/newspapers?url=#symmetry">SYMMETRY</a>, <a class="reference external" target="_top" href="/newspapers?url=#name">NAME</a>, <a class="reference external" target="_top" href="/newspapers?url=#block">BLOCK</a>, <a class="reference external" target="_top" href="/newspapers?url=#anom">ANOMALOUS</a>, <a class="reference external" target="_top" href="/newspapers?url=#status">STATUS</a>, <a class="reference external" target="_top" href="/newspapers?url=#end">END</a></p> </div></blockquote> <p>All keywords are optional. The program will read in data, such as symmetry, from the mmCIF file if it is there. The keywords can be used to provide missing information, or to override existing information.</p> <section id="title-title"> <span id="title"></span><h3 id="title-title">TITLE <title><a class="headerlink" target="_top" href="/newspapers?url=#title-title" title="Permalink to this heading">¶</a></h3> <p>Put a suitable title in the output MTZ file.</p> </section> <section id="cell-a-b-c-alpha-beta-gamma"> <span id="cell"></span><h3 id="cell-a-b-c-alpha-beta-gamma">CELL <a> <b> <c> [ <alpha> <beta> <gamma> ]<a class="headerlink" target="_top" href="/newspapers?url=#cell-a-b-c-alpha-beta-gamma" title="Permalink to this heading">¶</a></h3> <p>Followed by the cell lengths and angles.</p> </section> <section id="symmetry-spacegroup"> <span id="symmetry"></span><h3 id="symmetry-spacegroup">SYMMETRY <spacegroup><a class="headerlink" target="_top" href="/newspapers?url=#symmetry-spacegroup" title="Permalink to this heading">¶</a></h3> <p>Followed by the standard space group name or number, or explicit symmetry operators.</p> </section> <section id="labout-program-label-file-label"> <span id="labout"></span><h3 id="labout-program-label-file-label">LABOUT <program label>=<file label> …<a class="headerlink" target="_top" href="/newspapers?url=#labout-program-label-file-label" title="Permalink to this heading">¶</a></h3> <p>The program currently recognises the following mmCIF item names for reflection data:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">_refln</span><span class="o">.</span><span class="n">index_h</span> <span class="n">H</span> <span class="n">h</span> <span class="n">index</span> <span class="n">_refln</span><span class="o">.</span><span class="n">index_k</span> <span class="n">K</span> <span class="n">k</span> <span class="n">index</span> <span class="n">_refln</span><span class="o">.</span><span class="n">index_l</span> <span class="n">L</span> <span class="n">l</span> <span class="n">index</span> <span class="n">_refln</span><span class="o">.</span><span class="n">status</span> <span class="n">FREE</span> <span class="n">free</span> <span class="n">R</span> <span class="n">flag</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_meas_au</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_meas</span> <span class="n">FP</span> <span class="n">structure</span> <span class="n">factor</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_meas_sigma_au</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_meas_sigma</span> <span class="n">SIGFP</span> <span class="n">sigma</span><span class="p">(</span><span class="n">F</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_calc_au</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_calc</span> <span class="n">FC</span> <span class="n">calculated</span> <span class="n">SF</span> <span class="n">_refln</span><span class="o">.</span><span class="n">phase_calc</span> <span class="n">PHIC</span> <span class="n">calculated</span> <span class="n">phase</span> <span class="n">_refln</span><span class="o">.</span><span class="n">phase_meas</span> <span class="n">PHIB</span> <span class="n">experimental</span> <span class="n">phase</span> <span class="n">_refln</span><span class="o">.</span><span class="n">fom</span> <span class="n">_refln</span><span class="o">.</span><span class="n">weight</span> <span class="n">FOM</span> <span class="n">figure</span> <span class="n">of</span> <span class="n">merit</span> <span class="n">_refln</span><span class="o">.</span><span class="n">intensity_meas</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_squared_meas</span> <span class="n">I</span> <span class="n">intensity</span> <span class="n">_refln</span><span class="o">.</span><span class="n">intensity_sigma</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_squared_sigma</span> <span class="n">SIGI</span> <span class="n">sigma</span><span class="p">(</span><span class="n">I</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">F_part_au</span> <span class="n">FPART</span> <span class="n">partial</span> <span class="n">structure</span> <span class="n">factor</span> <span class="n">_refln</span><span class="o">.</span><span class="n">phase_part</span> <span class="n">PHIP</span> <span class="n">partial</span> <span class="n">phase</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_F_plus</span> <span class="n">F</span><span class="p">(</span><span class="o">+</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_F_plus_sigma</span> <span class="n">SIGF</span><span class="p">(</span><span class="o">+</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_F_minus</span> <span class="n">F</span><span class="p">(</span><span class="o">-</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_F_minus_sigma</span> <span class="n">SIGF</span><span class="p">(</span><span class="o">-</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_anom_difference</span> <span class="n">DP</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_anom_difference_sigma</span> <span class="n">SIGDP</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_I_plus</span> <span class="n">I</span><span class="p">(</span><span class="o">+</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_I_plus_sigma</span> <span class="n">SIGI</span><span class="p">(</span><span class="o">+</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_I_minus</span> <span class="n">I</span><span class="p">(</span><span class="o">-</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_I_minus_sigma</span> <span class="n">SIGI</span><span class="p">(</span><span class="o">-</span><span class="p">)</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_HL_A_iso</span> <span class="n">HLA</span> <span class="n">HL</span> <span class="n">coefficient</span> <span class="n">A</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_HL_B_iso</span> <span class="n">HLB</span> <span class="n">HL</span> <span class="n">coefficient</span> <span class="n">B</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_HL_C_iso</span> <span class="n">HLC</span> <span class="n">HL</span> <span class="n">coefficient</span> <span class="n">C</span> <span class="n">_refln</span><span class="o">.</span><span class="n">pdbx_HL_D_iso</span> <span class="n">HLD</span> <span class="n">HL</span> <span class="n">coefficient</span> <span class="n">D</span> </pre></div> </div> <p>An MTZ column is output for each mmCIF item found. The default column name <program label> is given in the middle column above, but the LABOUT keyword can be used to rename these columns.</p> <p>With the <a class="reference external" target="_top" href="/newspapers?url=#anom">ANOMALOUS</a> option, there are additional columns F(+) SIGF(+) F(-) SIGF(-) which can be renamed by LABOUT.</p> <p><strong>Note:</strong> the mmCIF file may contain alternative labels, e.g. _refln.F_meas rather than _refln.F_meas_au. Some alternative labels will be recognised, see table above. Otherwise it is sufficient to edit the label name directly in the mmCIF file to one of the above labels.</p> </section> <section id="name-project-pname-crystal-xname-dataset-dname"> <span id="id2"></span><h3 id="name-project-pname-crystal-xname-dataset-dname">NAME PROJECT <pname> CRYSTAL <xname> DATASET <dname><a class="headerlink" target="_top" href="/newspapers?url=#name-project-pname-crystal-xname-dataset-dname" title="Permalink to this heading">¶</a></h3> <p>[Note that the keywords PNAME <pname>, XNAME <xname> and DNAME <dname> are also available, but the NAME keyword is preferred.]</p> <p>Specify the project, crystal and dataset names for the output MTZ file. <pname> and <xname> are taken from _entry.id if present in the mmCIF file, and <dname> is taken from _diffrn.id if present in the mmCIF file. If the mmCIF file does not contain _entry.id and _diffrn.id, then it is strongly recommended that this information is given. Otherwise, the default project, crystal and dataset names are “unknown”, “unknown” and “unknownddmmyy” respectively.</p> <p>The project-name specifies a particular structure solution project, the crystal name specifies a physical crystal contributing to that project, and the dataset-name specifies a particular dataset obtained from that crystal. All three should be given.</p> </section> <section id="block-blockname"> <span id="block"></span><h3 id="block-blockname">BLOCK <blockname><a class="headerlink" target="_top" href="/newspapers?url=#block-blockname" title="Permalink to this heading">¶</a></h3> <div class="line-block"> <div class="line">(Optional keyword)</div> <div class="line">mmCIF-format reflection files contain reflection data in blocks started by a “data_<blockname>” tag. Generally, a file will only contain a single block. In some cases, however, there may be several related blocks (e.g. native data, and additional datasets for phase determination). A specific block may be converted to MTZ format by specifying its name (including the “<a target="_top" href="/newspapers?url=#id5"><span class="problematic" id="id6">data_</span></a>” prefix). Without this keyword, cif2mtz will simply convert the first data block.</div> </div> </section> <section id="anomalous"> <span id="anom"></span><h3 id="anomalous">ANOMALOUS<a class="headerlink" target="_top" href="/newspapers?url=#anomalous" title="Permalink to this heading">¶</a></h3> <div class="line-block"> <div class="line">(Optional keyword)</div> <div class="line">If this keyword is given, the program will attempt to recover F(+) and F(-) columns from hkl / -h-k-l pairs in the input mmCIF file. Any hkl singletons will be treated as F(+) data. Columns FP/SIGFP will also be output as mean of the input F(+) and F(-).</div> </div> <p><strong>Warning:</strong> this option will work with mmCIF such as are output by <a class="reference external" target="_top" href="/newspapers?url=mtz2various.html">MTZ2VARIOUS</a>, where the -h-k-l reflection immediately follows the corresponding hkl, and where hkl reflections are in the CCP4 asymmetric unit. It will fail in other cases. Without the ANOMALOUS option, all reflections will be passed unchanged to HKLOUT.</p> <p><strong>Note also:</strong> this option deals with the case where anomalous pairs exist as different reflection rows. This is different (and incompatible with) the case where anomalous pairs exist as different columns, e.g. _refln.pdbx_F_plus and _refln.pdbx_F_minus</p> </section> <section id="status-xplo-ccp4"> <span id="status"></span><h3 id="status-xplo-ccp4">STATUS XPLO | CCP4<a class="headerlink" target="_top" href="/newspapers?url=#status-xplo-ccp4" title="Permalink to this heading">¶</a></h3> <div class="line-block"> <div class="line">(Optional keyword)</div> <div class="line">The _refln.status column (if present) should flag reflections used for the free-R calculation by ‘f’, and others by ‘o’. Some mmCIF files use ‘0’ and ‘1’ instead. The program will pick this up automatically, but needs to know which convention is being used. This keyword can be used to set the XPLOr convention (‘1’ if free, ‘0’ otherwise) or the CCP4 convention (‘0’ if free, ‘1’ otherwise). The default is XPLOr convention.</div> </div> <p>This is the convention used in the input mmCIF file. The MTZ file always adheres to the CCP4 convention.</p> </section> <section id="end"> <span id="id3"></span><h3 id="end">END<a class="headerlink" target="_top" href="/newspapers?url=#end" title="Permalink to this heading">¶</a></h3> <p>End keyworded input.</p> </section> </section> <section id="error-messages"> <span id="errors"></span><h2 id="error-messages">ERROR MESSAGES<a class="headerlink" target="_top" href="/newspapers?url=#error-messages" title="Permalink to this heading">¶</a></h2> <dl class="simple"> <dt>“CCIF signal CCIF_PARTLOOP” / “Attempt to process loop with incomplete loop packet”</dt><dd><p>The file should contain a table of reflection data such that the total number of items is divisible by the number of columns. If the mmCIF file is badly formatted, two numbers may run together, reducing the apparent number of data items. This shouldn’t happen with files from the PDB, but may happen after local processing. If you get this error message, you need to check through the data careful looking for such mistakes.</p> </dd> </dl> </section> <section id="examples"> <span id="id4"></span><h2 id="examples">EXAMPLES<a class="headerlink" target="_top" href="/newspapers?url=#examples" title="Permalink to this heading">¶</a></h2> <p>Structure factors and their sigmas from 1gme:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cif2mtz</span> <span class="n">hklin</span> <span class="n">r1gmesf</span><span class="o">.</span><span class="n">ent</span> <span class="n">hklout</span> <span class="mi">1</span><span class="n">gme</span><span class="o">.</span><span class="n">mtz</span> <span class="o"><<</span><span class="n">eof</span> <span class="n">END</span> <span class="n">eof</span> </pre></div> </div> <p>Another example of diffraction data, this time containing squared structure factors (assumed to be intensities) and calculated structure factors. The file only contains the list of reflections, so additional information must be supplied:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cif2mtz</span> <span class="n">hklin</span> <span class="n">r1d9ysf</span><span class="o">.</span><span class="n">ent</span> <span class="n">hklout</span> <span class="mi">1</span><span class="n">d9y</span><span class="o">.</span><span class="n">mtz</span> <span class="o"><<</span><span class="n">eof</span> <span class="n">CELL</span> <span class="mf">40.583</span> <span class="mf">111.009</span> <span class="mf">140.423</span> <span class="mf">90.00</span> <span class="mf">90.00</span> <span class="mf">90.00</span> <span class="n">SYMM</span> <span class="n">C2221</span> <span class="n">NAME</span> <span class="n">PROJ</span> <span class="n">MBP</span> <span class="n">CRYS</span> <span class="n">apoprotein</span> <span class="n">DATA</span> <span class="n">native</span> <span class="n">END</span> <span class="n">eof</span> </pre></div> </div> <p>Finally, 1gr5 contains structure factors and phases from electron microscopy data:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cif2mtz</span> <span class="n">hklin</span> <span class="n">r1gr5sf</span><span class="o">.</span><span class="n">ent</span> <span class="n">hklout</span> <span class="mi">1</span><span class="n">gr5</span><span class="o">.</span><span class="n">mtz</span> <span class="o"><<</span><span class="n">eof</span> <span class="n">END</span> <span class="n">eof</span> </pre></div> </div> <p>Note that this file contains dummy cell dimensions and symmetry, and it may be convenient to set these with the CELL and SYMM keywords.</p> </section> <section id="author"> <h2 id="author">AUTHOR<a class="headerlink" target="_top" href="/newspapers?url=#author" title="Permalink to this heading">¶</a></h2> <p>Martyn Winn</p> </section> <section id="see-also"> <h2 id="see-also">SEE ALSO<a class="headerlink" target="_top" href="/newspapers?url=#see-also" title="Permalink to this heading">¶</a></h2> <div class="line-block"> <div class="line"><a class="reference external" target="_top" href="/newspapers?url=f2mtz.html">f2mtz</a> - convert other ASCII formats to MTZ</div> <div class="line"><a class="reference external" target="_top" href="/newspapers?url=mtz2various.html">mtz2various</a> - convert MTZ to mmCIF and others</div> </div> </section> </section> </article> </div> </div> </main> </div> <footer class="md-footer"> <div class="md-footer-nav"> <nav class="md-footer-nav__inner md-grid"> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight"> © Copyright 2021, CCP4. </div> Created using <a target="_top" href="/newspapers?url=http://www.sphinx-doc.org/">Sphinx</a> 5.3.0. and <a target="_top" href="/newspapers?url=https://github.com/bashtage/sphinx-material/">Material for Sphinx</a> </div> </div> </div> </footer> <script src="_static/javascripts/application.js"></script> <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script> </body> </html>