afb6b0ffc3728aee3c6418bfb11a370815ef0cbb
[scilab.git] / scilab / modules / matio / help / en_US / loadmatfile.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) 2002-2007 - INRIA - Serge STEER
5     * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT 
6     * 
7     * This file must be used under the terms of the CeCILL.
8     * This source file is licensed as described in the file COPYING, which
9     * you should have received as part of this distribution.  The terms
10     * are also available at    
11     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12     *
13     -->
14 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="loadmatfile">
15   <info>
16     <pubdate>$LastChangedDate$</pubdate>
17   </info>
18   <refnamediv>
19     <refname>loadmatfile</refname>
20     <refpurpose>loads a Matlab V6 MAT-file (binary or ASCII) into Scilab</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>loadmatfile(format,filename[,var1[,var2[,...]]])
25 loadmatfile(filename[,format[,var1[,var2[,...]]]])
26 loadmatfile(filename[,var1[,var2,[,...[,format]]]])</synopsis>
27   </refsynopsisdiv>
28   <refsection>
29     <title>Parameters</title>
30     <variablelist>
31       <varlistentry>
32         <term>filename</term>
33         <listitem>
34           <para>character string containing the path of the file (needed)</para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>format</term>
39         <listitem>
40           <para>file format (if not given and file has extension ".mat", file is considered to be binary)</para>
41           <variablelist>
42             <varlistentry>
43               <term>"-mat"</term>
44               <listitem>
45                 <para>binary file</para>
46               </listitem>
47             </varlistentry>
48             <varlistentry>
49               <term>"-ascii"</term>
50               <listitem>
51                 <para>option to force Scilab to read file as an ASCII file</para>
52               </listitem>
53             </varlistentry>
54           </variablelist>
55         </listitem>
56       </varlistentry>
57       <varlistentry>
58         <term>var1, var2</term>
59         <listitem>
60           <para>character strings containing the name of the variables to load (only for binary files)</para>
61         </listitem>
62       </varlistentry>
63     </variablelist>
64   </refsection>
65   <refsection>
66     <title>Description</title>
67     <para>
68     loads a Matlab MAT-file into Scilab. The Matlab data types are
69     converted into the Scilab equivalents.</para>
70   </refsection>
71   <refsection>
72     <title>See Also</title>
73     <simplelist type="inline">
74       <member>
75         <link linkend="load">load</link>
76       </member>
77       <member>
78         <link linkend="savematfile">savematfile</link>
79       </member>
80       <member>
81         <link linkend="save">save</link>
82       </member>
83       <member>
84         <link linkend="mfile2sci">mfile2sci</link>
85       </member>
86       <member>
87         <link linkend="matfile2sci">matfile2sci</link>
88       </member>
89     </simplelist>
90   </refsection>
91   <refsection>
92     <title>Authors</title>
93     <simplelist type="vert">
94       <member>Serge Steer (INRIA)</member>
95       <member>V.C</member>
96     </simplelist>
97   </refsection>
98   <refsection>
99     <title>Bibliography</title>
100     <para>This function has been developped following the "MAT-File Format"
101   description: 
102 <literal>www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf</literal></para>
103   </refsection>
104 </refentry>