<?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_a_s_c_i_i_8h">
<title>/Users/bernard/b20/bsoft/include/rwASCII.h File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/include/rwASCII.h</primary></indexterm>
<para>

<para>Header file for reading and writing ASCII files. </para>
 
</para>
<programlisting>#include &quot;rwimg.h&quot;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_a_s_c_i_i_8h_1a3cf8d10640416eecfef9f565db291558">readASCII</link> (<link linkend="_class_bimage">Bimage</link> *p, int readdata)</para>

<para>Reading an ASCII or text image format. </para>
</listitem>
            <listitem><para>int <link linkend="_rw_a_s_c_i_i_8h_1a515230625fa01aafde0b35f61200ca53">writeASCII</link> (<link linkend="_class_bimage">Bimage</link> *p)</para>

<para>Writing an ASCII or text image format. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for reading and writing ASCII files. </para>

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

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

<para>Created: 20000318 </para>

<para>Modified: 20111217 <literallayout><computeroutput>Format: Generic ASCII image file format
</computeroutput></literallayout> </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_a_s_c_i_i_8h_1a3cf8d10640416eecfef9f565db291558"/>    <section>
    <title>readASCII()</title>
<indexterm><primary>readASCII</primary><secondary>rwASCII.h</secondary></indexterm>
<indexterm><primary>rwASCII.h</primary><secondary>readASCII</secondary></indexterm>
<para><computeroutput>int readASCII (<link linkend="_class_bimage">Bimage</link> * p, int readdata)</computeroutput></para><para>

<para>Reading an ASCII or text image format. </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>
This function reads an ASCII image file with up to five dimensions in the order: c (channels), x, y, z, n (number of images) Default data type is Float Data is given as real (R) or complex (R and I or A and P), and may include an optional FOM (F) Column labels: Images: C X Y Z N R I F Structure factors: H K L A P R I F </para>
<para>
Definition at line 34 of file rwASCII.cpp.</para>
    </section><anchor xml:id="_rw_a_s_c_i_i_8h_1a515230625fa01aafde0b35f61200ca53"/>    <section>
    <title>writeASCII()</title>
<indexterm><primary>writeASCII</primary><secondary>rwASCII.h</secondary></indexterm>
<indexterm><primary>rwASCII.h</primary><secondary>writeASCII</secondary></indexterm>
<para><computeroutput>int writeASCII (<link linkend="_class_bimage">Bimage</link> * p)</computeroutput></para><para>

<para>Writing an ASCII or text image format. </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>
This function writes an ascii image file with up to five dimensions in the order: c (channels), x, y, z, n (number of images) Default data type is Float Data is given as real (R) or complex (R and I or A and P), and may include an optional FOM (F) Column labels: Images: C X Y Z N R I F Structure factors: H K L A P R I F </para>
<para>
Definition at line 279 of file rwASCII.cpp.</para>
</section>
</section>
</section>
