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

<para>Header file for reading (only) Digital Instruments files. </para>
 
</para>
<programlisting>#include &quot;rwimg.h&quot;
</programlisting><simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para>#define <link linkend="_rw_d_i_8h_1ac2ebde69e78925b8e3270db3690b93d0">DISIZE</link>   20480</para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_d_i_8h_1a3f7c02ea16ffa7979477bf528d88d5f7">readDI</link> (<link linkend="_class_bimage">Bimage</link> *p, int readdata, int img_select)</para>

<para>Reading a Digital Instruments image file format. A two-image 2D image format used in Digital Instruments atomic force microscopes. The header is text varying with the version of DI software, which may be 4,8,12,20K and is supposed to be read from the header itself. The header contains the following keywords (tags): image list: presumably one entry per image Data offset: offset to start of data, may however be incorrect if the file was transferred with ftp as text Data length: total length of data block Samps/line: samples per line (x-dimension) Number of lines: lines (y-dimension) list end: end of header File format extensions: .di, .DI Byte order: Always little endian because the DI software runs on Intel machines and there is no way to detect byte order from the text header. Data type: short. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for reading (only) Digital Instruments files. </para>

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

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

<para>Created: 19990424 </para>

<para>Modified: 20010410 <literallayout><computeroutput>Format: 2D image file format for AFM (Digital Instruments)
</computeroutput></literallayout> </para>
</formalpara>
</para>
</section>
<section>
<title>Macro Definition Documentation</title>
<anchor xml:id="_rw_d_i_8h_1ac2ebde69e78925b8e3270db3690b93d0"/>    <section>
    <title>DISIZE</title>
<indexterm><primary>DISIZE</primary><secondary>rwDI.h</secondary></indexterm>
<indexterm><primary>rwDI.h</primary><secondary>DISIZE</secondary></indexterm>
<para><computeroutput>#define DISIZE   20480</computeroutput></para><para>
Definition at line 13 of file rwDI.h.</para>
</section>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_d_i_8h_1a3f7c02ea16ffa7979477bf528d88d5f7"/>    <section>
    <title>readDI()</title>
<indexterm><primary>readDI</primary><secondary>rwDI.h</secondary></indexterm>
<indexterm><primary>rwDI.h</primary><secondary>readDI</secondary></indexterm>
<para><computeroutput>int readDI (<link linkend="_class_bimage">Bimage</link> * p, int readdata, int img_select)</computeroutput></para><para>

<para>Reading a Digital Instruments image file format. A two-image 2D image format used in Digital Instruments atomic force microscopes. The header is text varying with the version of DI software, which may be 4,8,12,20K and is supposed to be read from the header itself. The header contains the following keywords (tags): image list: presumably one entry per image Data offset: offset to start of data, may however be incorrect if the file was transferred with ftp as text Data length: total length of data block Samps/line: samples per line (x-dimension) Number of lines: lines (y-dimension) list end: end of header File format extensions: .di, .DI Byte order: Always little endian because the DI software runs on Intel machines and there is no way to detect byte order from the text header. Data type: short. </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>
                            <row>
                                <entry>img_select</entry>
                                <entry>
<para>image selection in multi-image file (-1 = all images). </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 42 of file rwDI.cpp.</para>
</section>
</section>
</section>
