summaryrefslogtreecommitdiff
path: root/modules/matio/help/en_US/loadmatfile.xml
blob: 8ca3898fdd2894c5a366e85f7c5aefed60287e42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) 2002-2007 - INRIA - Serge STEER
    * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT 
    * 
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at    
    * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
    *
    -->
<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="loadmatfile">
    <refnamediv>
        <refname>loadmatfile</refname>
        <refpurpose>loads a Matlab V6 MAT-file (binary or ASCII) into Scilab</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>loadmatfile(format,filename[,var1[,var2[,...]]])
            loadmatfile(filename[,format[,var1[,var2[,...]]]])
            loadmatfile(filename[,var1[,var2,[,...[,format]]]])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>filename</term>
                <listitem>
                    <para>character string containing the path of the file (needed)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>format</term>
                <listitem>
                    <para>file format (if not given and file has extension ".mat", file is considered to be binary)</para>
                    <variablelist>
                        <varlistentry>
                            <term>"-mat"</term>
                            <listitem>
                                <para>binary file</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-ascii"</term>
                            <listitem>
                                <para>option to force Scilab to read file as an ASCII file</para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>var1, var2</term>
                <listitem>
                    <para>character strings containing the name of the variables to load (only for binary files)</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            loads a Matlab MAT-file into Scilab. The Matlab data types are
            converted into the Scilab equivalents.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
A = rand(10,10);
B = sprand(100,100,0.1);
savematfile('test_matfile.mat','A','B','-v6');
clear;
loadmatfile('test_matfile.mat');
disp(A)
disp(B)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="load">load</link>
            </member>
            <member>
                <link linkend="savematfile">savematfile</link>
            </member>
            <member>
                <link linkend="save">save</link>
            </member>
            <member>
                <link linkend="mfile2sci">mfile2sci</link>
            </member>
            <member>
                <link linkend="matfile2sci">matfile2sci</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Bibliography</title>
        <para>
            This function uses MATIO library (
            <literal>
                <ulink url="http://sourceforge.net/projects/matio/">http://sourceforge.net/projects/matio/</ulink>
            </literal>
            ).
        </para>
    </refsection>
</refentry>