<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_rw_h_k_l_8cpp">
<title>/Users/bernard/b20/bsoft/src/rwimg/rwHKL.cpp File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/src/rwimg/rwHKL.cpp</primary></indexterm>
<para>

<para>Routines to read and write HKL reflection files. </para>
 
</para>
<programlisting>#include &quot;rwHKL.h&quot;
#include &quot;Complex.h&quot;
#include &quot;linked_list.h&quot;
#include &quot;utilities.h&quot;
#include &lt;fstream&gt;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_h_k_l_8cpp_1ab4c15e530689114ebc04efc31c332619">readHKL</link> (<link linkend="_class_bimage">Bimage</link> *p, int readdata)</para>

<para>Reading a HKL structure factor file format. This function reads a HKL file typically produced with MTZDUMP from X-ray crystallographic structure factor files in the CCP4 package. The first line as a space-delimited list of headers for the columns. All subsequent lines are rows containing the indices and data. Column headers: H K L indices. AMP amplitudes. SIGAMP amplitude deviations. PHI phases. SIGPHI phase deviations. FOM figure-of-merit values. FREE flag for R-free calculations. </para>
</listitem>
            <listitem><para>int <link linkend="_rw_h_k_l_8cpp_1a82fc69ec242f018f5cc365425cf9be19">writeHKL</link> (<link linkend="_class_bimage">Bimage</link> *p)</para>

<para>Writing a HKL structure factor file format. This function writes a HKL structure factor file. </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Variables    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_h_k_l_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453">verbose</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Routines to read and write HKL reflection files. </para>

<para><formalpara><title>Author: </title>

<para>Bernard Heymann </para>
</formalpara>
<formalpara><title>Date: </title>

<para>Created: 19981229 </para>

<para>Modified: 20120211 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_h_k_l_8cpp_1ab4c15e530689114ebc04efc31c332619"/>    <section>
    <title>readHKL()</title>
<indexterm><primary>readHKL</primary><secondary>rwHKL.cpp</secondary></indexterm>
<indexterm><primary>rwHKL.cpp</primary><secondary>readHKL</secondary></indexterm>
<para><computeroutput>int readHKL (<link linkend="_class_bimage">Bimage</link> * p, int readdata)</computeroutput></para><para>

<para>Reading a HKL structure factor file format. This function reads a HKL file typically produced with MTZDUMP from X-ray crystallographic structure factor files in the CCP4 package. The first line as a space-delimited list of headers for the columns. All subsequent lines are rows containing the indices and data. Column headers: H K L indices. AMP amplitudes. SIGAMP amplitude deviations. PHI phases. SIGPHI phase deviations. FOM figure-of-merit values. FREE flag for R-free calculations. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*p</entry>
                                <entry>
<para>the image structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>readdata</entry>
                                <entry>
<para>flag to activate reading of image data. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 36 of file rwHKL.cpp.</para>
    </section><anchor xml:id="_rw_h_k_l_8cpp_1a82fc69ec242f018f5cc365425cf9be19"/>    <section>
    <title>writeHKL()</title>
<indexterm><primary>writeHKL</primary><secondary>rwHKL.cpp</secondary></indexterm>
<indexterm><primary>rwHKL.cpp</primary><secondary>writeHKL</secondary></indexterm>
<para><computeroutput>int writeHKL (<link linkend="_class_bimage">Bimage</link> * p)</computeroutput></para><para>

<para>Writing a HKL structure factor file format. This function writes a HKL structure factor file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*p</entry>
                                <entry>
<para>the image structure. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 210 of file rwHKL.cpp.</para>
</section>
</section>
<section>
<title>Variable Documentation</title>
<anchor xml:id="_rw_h_k_l_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453"/>    <section>
    <title>verbose</title>
<indexterm><primary>verbose</primary><secondary>rwHKL.cpp</secondary></indexterm>
<indexterm><primary>rwHKL.cpp</primary><secondary>verbose</secondary></indexterm>
<para><computeroutput>int verbose</computeroutput></para></section>
</section>
</section>
