<?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_s_p_e_8cpp">
<title>/Users/bernard/b20/bsoft/src/rwimg/rwSPE.cpp File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/src/rwimg/rwSPE.cpp</primary></indexterm>
<para>

<para>Functions for reading and writing SPE CCD files. </para>
 
</para>
<programlisting>#include &quot;rwSPE.h&quot;
#include &quot;file_util.h&quot;
#include &quot;utilities.h&quot;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_s_p_e_8cpp_1ac993330f2b481005361f075210d96911">readSPE</link> (<link linkend="_class_bimage">Bimage</link> *p, int readdata, int img_select)</para>

<para>Reading a SPE image file format. </para>
</listitem>
            <listitem><para>int <link linkend="_rw_s_p_e_8cpp_1ad4cbbeef8c300a9c4ecf0171ebc9035f">writeSPE</link> (<link linkend="_class_bimage">Bimage</link> *p)</para>

<para>Writing a SPE image file format. </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Variables    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rw_s_p_e_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453">verbose</link></para>
</listitem>
            <listitem><para>char * <link linkend="_rw_s_p_e_8cpp_1abccbc24c7569657b2c2af7fcd59d2cc9">month</link> []</para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Functions for reading and writing SPE CCD files. </para>

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

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

<para>Created: 20081105 </para>

<para>Modified: 20120409 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rw_s_p_e_8cpp_1ac993330f2b481005361f075210d96911"/>    <section>
    <title>readSPE()</title>
<indexterm><primary>readSPE</primary><secondary>rwSPE.cpp</secondary></indexterm>
<indexterm><primary>rwSPE.cpp</primary><secondary>readSPE</secondary></indexterm>
<para><computeroutput>int readSPE (<link linkend="_class_bimage">Bimage</link> * p, int readdata, int img_select)</computeroutput></para><para>

<para>Reading a SPE image file 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>
                            <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). A Princeton Instruments CCD image file format. Header size: 4100 bytes (fixed). File format extension: .SPE. Byte order determination: data type field. Data types: 0 = float, 1 = int, 2 = short, 3 = unsigned short, 4 = string/char, 5 = double, 6 = char, 7 = unsigned char/byte. </para>
</formalpara>
</para>
<para>
Definition at line 33 of file rwSPE.cpp.</para>
    </section><anchor xml:id="_rw_s_p_e_8cpp_1ad4cbbeef8c300a9c4ecf0171ebc9035f"/>    <section>
    <title>writeSPE()</title>
<indexterm><primary>writeSPE</primary><secondary>rwSPE.cpp</secondary></indexterm>
<indexterm><primary>rwSPE.cpp</primary><secondary>writeSPE</secondary></indexterm>
<para><computeroutput>int writeSPE (<link linkend="_class_bimage">Bimage</link> * p)</computeroutput></para><para>

<para>Writing a SPE image file 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). A Princeton Instruments CCD image file format. </para>
</formalpara>
</para>
<para>
Definition at line 119 of file rwSPE.cpp.</para>
</section>
</section>
<section>
<title>Variable Documentation</title>
<anchor xml:id="_rw_s_p_e_8cpp_1abccbc24c7569657b2c2af7fcd59d2cc9"/>    <section>
    <title>month</title>
<indexterm><primary>month</primary><secondary>rwSPE.cpp</secondary></indexterm>
<indexterm><primary>rwSPE.cpp</primary><secondary>month</secondary></indexterm>
<para><computeroutput>char* month[]</computeroutput></para><para>
Definition at line 55 of file rwimg.cpp.</para>
    </section><anchor xml:id="_rw_s_p_e_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453"/>    <section>
    <title>verbose</title>
<indexterm><primary>verbose</primary><secondary>rwSPE.cpp</secondary></indexterm>
<indexterm><primary>rwSPE.cpp</primary><secondary>verbose</secondary></indexterm>
<para><computeroutput>int verbose</computeroutput></para></section>
</section>
</section>
