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

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

<para>Reading an OpenDX image format. </para>
</listitem>
            <listitem><para>int <link linkend="_rw_d_x_8h_1a77c5123429111178b420be2c4c2308e4">writeDX</link> (<link linkend="_class_bimage">Bimage</link> *p)</para>

<para>Writing a DX image format. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

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

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

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

<para>Created: 20150319 </para>

<para>Modified: 20150319 <literallayout><computeroutput>Format: OpenDX image file format
</computeroutput></literallayout> </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_d_x_8h_1acb11a2beac98fbce21b136b125c5fcf0"/>    <section>
    <title>readDX()</title>
<indexterm><primary>readDX</primary><secondary>rwDX.h</secondary></indexterm>
<indexterm><primary>rwDX.h</primary><secondary>readDX</secondary></indexterm>
<para><computeroutput>int readDX (<link linkend="_class_bimage">Bimage</link> * p, int readdata)</computeroutput></para><para>

<para>Reading an OpenDX 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). <formalpara><title>Comments</title></formalpara>
</para>
</formalpara>
object 1 class gridpositions counts nx ny nz origin xmin ymin zmin delta hx 0.0 0.0 delta 0.0 hy 0.0 delta 0.0 0.0 hz object 2 class gridconnections counts nx ny nz object 3 class array type double rank 0 times n u(0,0,0) u(0,0,1) u(0,0,2) ... u(0,0,nz-3) u(0,0,nz-2) u(0,0,nz-1) u(0,1,0) u(0,1,1) u(0,1,2) ... u(0,1,nz-3) u(0,1,nz-2) u(0,1,nz-1) ... u(0,ny-3,nz-3) u(0,ny-2,nz-2) u(0,ny-1,nz-1) u(1,0,0) u(1,0,1) u(1,0,2) ... attribute &quot;dep&quot; string &quot;positions&quot; object &quot;regular positions regular connections&quot; class field component &quot;positions&quot; value 1 component &quot;connections&quot; value 2 component &quot;data&quot; value 3 </para>
<para>
Definition at line 44 of file rwDX.cpp.</para>
    </section><anchor xml:id="_rw_d_x_8h_1a77c5123429111178b420be2c4c2308e4"/>    <section>
    <title>writeDX()</title>
<indexterm><primary>writeDX</primary><secondary>rwDX.h</secondary></indexterm>
<indexterm><primary>rwDX.h</primary><secondary>writeDX</secondary></indexterm>
<para><computeroutput>int writeDX (<link linkend="_class_bimage">Bimage</link> * p)</computeroutput></para><para>

<para>Writing a DX 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>
</para>
<para>
Definition at line 112 of file rwDX.cpp.</para>
</section>
</section>
</section>
