Mercurial > octave-nkf

annotate scripts/plot/saveas.m @ 14138:72c96de7a403 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents c792872f8942
children 4d917a6a858b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
1 ## Copyright (C) 2010-2012 Kai Habel
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
2 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
3 ## This file is part of Octave.
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
4 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
8 ## your option) any later version.
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
9 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
13 ## General Public License for more details.
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
14 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
18
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
19 ## -*- texinfo -*-
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
20 ## @deftypefn {Function File} {} saveas (@var{h}, @var{filename})
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
21 ## @deftypefnx {Function File} {} saveas (@var{h}, @var{filename}, @var{fmt})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
22 ## Save graphic object @var{h} to the file @var{filename} in graphic
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
23 ## format @var{fmt}.
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
24 ##
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
25 ## @var{fmt} should be one of the following formats:
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
26 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
27 ## @table @code
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
28 ## @item ps
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
29 ## Postscript
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
30 ##
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
31 ## @item eps
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
32 ## Encapsulated Postscript
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
33 ##
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
34 ## @item jpg
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
35 ## JPEG Image
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
36 ##
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
37 ## @item png
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
38 ## PNG Image
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
39 ##
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
40 ## @item emf
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
41 ## Enhanced Meta File
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
42 ##
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
43 ## @item pdf
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
44 ## Portable Document Format
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
45 ## @end table
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
46 ##
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
47 ## All device formats specified in @code{print} may also be used. If
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
48 ## @var{fmt} is omitted it is extracted from the extension of @var{filename}.
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
49 ## The default format is @code{"pdf"}.
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
50 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
51 ## @example
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
52 ## @group
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
53 ## figure (1);
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
54 ## clf ();
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
55 ## surf (peaks);
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
56 ## saveas(1, "figure1.png");
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
57 ## @end group
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
58 ## @end example
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
59 ##
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
60 ## @seealso{print}
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
61 ## @end deftypefn
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
62
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
63 ## Author: Kai Habel
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
64
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
65 function saveas (h, filename, fmt = "pdf")
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
66
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
67 if ((nargin != 2) && (nargin != 3))
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
68 print_usage ();
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
69 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
70
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
71 if (ishandle (h))
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
72 if (isfigure (h))
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
73 fig = h;
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
74 else
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
75 fig = ancestor (h, "figure");
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
76 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
77 else
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
78 error ("saveas: first argument H must be a graphics handle");
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
79 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
80
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
81 if (!ischar (filename))
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
82 error ("saveas: FILENAME must be a string");
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
83 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
84
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
85 if (nargin == 2)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
86 [~, ~, ext] = fileparts (filename);
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
87 if (!isempty (ext))
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
88 fmt = ext(2:end);
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
89 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
90 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
91
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
92 if (nargin == 3)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
93 if (!ischar (filename))
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
94 error ("saveas: EXT must be a string");
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
95 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
96
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
97 [~, ~, ext] = fileparts (filename);
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
98
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
99 if (isempty (ext))
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
100 filename = strcat (filename, ".", fmt);
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
101 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
102 endif
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
103
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
104 prt_opt = strcat ("-d", tolower (fmt));
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
105
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11254
diff changeset
106 print (filename, prt_opt);
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 11253
diff changeset
107
11253
093c9facf0f0 Add saveas function
Kai Habel <kai.habel@gmx.de>
parents:
diff changeset
108 endfunction