summaryrefslogtreecommitdiff
path: root/modules/matio/help/en_US/savematfile.xml
blob: 62832b9a29266c71bd4be2d992fb99206d749190 (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) 2004-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="savematfile">
    <refnamediv>
        <refname>savematfile</refname>
        <refpurpose>write a Matlab MAT-file (binary or ASCII)</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>savematfile('filename')
            savematfile('filename', 'var1', 'var2', ...)
            savematfile('filename', '-struct', 's')
            savematfile('filename', '-struct', 's', 'f1', 'f2', ...)
            savematfile(..., '-v4')
            savematfile(..., '-v6')
            savematfile(..., '-v7')
            savematfile(..., '-v7.3')
            savematfile filename var1 var2 ...
        </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>data format to use</para>
                    <variablelist>
                        <varlistentry>
                            <term>"-mat"</term>
                            <listitem>
                                <para>binary MAT-file (default)</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-ascii"</term>
                            <listitem>
                                <para>8-bit ASCII format</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-ascii" "-double"</term>
                            <listitem>
                                <para>16-bit ASCII format</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-ascii" "-tabs"</term>
                            <listitem>
                                <para>delimits with tabs</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-ascii" "-double" "-tabs"</term>
                            <listitem>
                                <para>16-digit ASCII format, tab delimited</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-v4"</term>
                            <listitem>
                                <para>A format that MATLAB Version 4 can open</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-v6"</term>
                            <listitem>
                                <para>A format that MATLAB Version 6 and earlier can open</para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-v7"</term>
                            <listitem>
                                <para>A format that MATLAB Version 7 and earlier can
                                    open (default)
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>"-v7.3"</term>
                            <listitem>
                                <para>A format that MATLAB Version 7.3 and earlier can
                                    open
                                </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>
            <varlistentry>
                <term>"-struct" "s"</term>
                <listitem>
                    <para>saves all fields of the scalar structure s as individual variables within the file filename.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>"-struct" "s" "f1" "f2"</term>
                <listitem>
                    <para>saves as individual variables only those structure fields specified (s.f1, s.f2, ...).</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            saves variables in a Matlab MAT-file from Scilab. The Scilab data types are
            converted into the Matlab 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)

// As a Matlab 7.3 file
A = rand(10, 10);
B = sprand(100, 100, 0.1);
savematfile("test_matfile.mat", "A", "B", "-v7.3");
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="save">save</link>
            </member>
            <member>
                <link linkend="loadmatfile">loadmatfile</link>
            </member>
            <member>
                <link linkend="mfile2sci">mfile2sci</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Bibliography</title>
        <para>This function has been developed following the "MAT-File Format"
            description:
            <literal>
                <ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink>
            </literal>
        </para>
    </refsection>
</refentry>