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

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

<para>Reading a Situs image format. </para>
</listitem>
            <listitem><para>int <link linkend="_rw_situs_8h_1abe6817211469d17567e3c36c2231cb51">writeSitus</link> (<link linkend="_class_bimage">Bimage</link> *p)</para>

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

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

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

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

<para>Created: 20150316 </para>

<para>Modified: 20150316 <literallayout><computeroutput>Format: Situs image file format
</computeroutput></literallayout> </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_situs_8h_1a248bfdfdfe6f4862b58bbed37dea3264"/>    <section>
    <title>readSitus()</title>
<indexterm><primary>readSitus</primary><secondary>rwSitus.h</secondary></indexterm>
<indexterm><primary>rwSitus.h</primary><secondary>readSitus</secondary></indexterm>
<para><computeroutput>int readSitus (<link linkend="_class_bimage">Bimage</link> * p, int readdata)</computeroutput></para><para>

<para>Reading a Situs 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). This function reads an Situs image file: The first line contains (in order): sampling -origin 3 values size 3 values Data type returned is Float </para>
</formalpara>
</para>
<para>
Definition at line 27 of file rwSitus.cpp.</para>
    </section><anchor xml:id="_rw_situs_8h_1abe6817211469d17567e3c36c2231cb51"/>    <section>
    <title>writeSitus()</title>
<indexterm><primary>writeSitus</primary><secondary>rwSitus.h</secondary></indexterm>
<indexterm><primary>rwSitus.h</primary><secondary>writeSitus</secondary></indexterm>
<para><computeroutput>int writeSitus (<link linkend="_class_bimage">Bimage</link> * p)</computeroutput></para><para>

<para>Writing a Situs 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 82 of file rwSitus.cpp.</para>
</section>
</section>
</section>
