mathgl 0.0.5 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/ext/mathgl/type.i ADDED
@@ -0,0 +1,100 @@
1
+ /***************************************************************************
2
+ * type.i is part of Math Graphic Library
3
+ * Copyright (C) 2007-2012 Alexey Balakin <mathgl.abalakin@gmail.ru> *
4
+ * *
5
+ * This program is free software; you can redistribute it and/or modify *
6
+ * it under the terms of the GNU Library General Public License as *
7
+ * published by the Free Software Foundation; either version 3 of the *
8
+ * License, or (at your option) any later version. *
9
+ * *
10
+ * This program is distributed in the hope that it will be useful, *
11
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13
+ * GNU General Public License for more details. *
14
+ * *
15
+ * You should have received a copy of the GNU Library General Public *
16
+ * License along with this program; if not, write to the *
17
+ * Free Software Foundation, Inc., *
18
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19
+ ***************************************************************************/
20
+ #include "mgl2/config.h"
21
+ #if MGL_USE_DOUBLE
22
+ typedef double mreal;
23
+ #else
24
+ typedef float mreal;
25
+ #endif
26
+ //-----------------------------------------------------------------------------
27
+ const mreal Pi = M_PI;
28
+ const mreal NaN = NAN;
29
+ const mreal Inf = INFINITY;
30
+ const mreal mgl_min_a = 1./256;
31
+ //-----------------------------------------------------------------------------
32
+ /// Class for point in 3D space
33
+ struct mglPoint
34
+ {
35
+ mreal x,y,z,c;
36
+ mglPoint(mreal X=0,mreal Y=0,mreal Z=0,mreal C=0){x=X;y=Y;z=Z;c=C;}
37
+ inline bool IsNAN() { return (x!=x || y!=y || z!=z || c!=c); }
38
+ inline mreal val(int i) { return (i<2 ? (i==0 ? x:y) : (i==2 ? z:c)); }
39
+ inline mreal norm() { return sqrt(x*x+y*y+z*z); }
40
+ inline void Normalize() { mreal v=norm(); x/=v; y/=v; z/=v; }
41
+
42
+ inline void operator+=(const mglPoint &a) { x+=a.x; y+=a.y; z+=a.z; c+=a.c; }
43
+ inline void operator-=(const mglPoint &a) { x-=a.x; y-=a.y; z-=a.z; c-=a.c; }
44
+ inline void operator+=(mreal a) { x+=a; y+=a; z+=a; }
45
+ inline void operator-=(mreal a) { x-=a; y-=a; z-=a; }
46
+ inline void operator*=(mreal a) { x*=a; y*=a; z*=a; }
47
+ inline void operator/=(mreal a) { x/=a; y/=a; z/=a; }
48
+ };
49
+ //-----------------------------------------------------------------------------
50
+ /// Class for RGBA color
51
+ struct mglColor
52
+ {
53
+ float r; ///< Red component of color
54
+ float g; ///< Green component of color
55
+ float b; ///< Blue component of color
56
+ float a; ///< Alpha component of color
57
+
58
+ /// Constructor for RGB components manualy
59
+ mglColor(float R,float G,float B, float A=1){ r=R; g=G; b=B; a=A; }
60
+ /// Constructor set default color
61
+ mglColor() { r=g=b=0; a=1; }
62
+ /// Constructor set color from character id
63
+ mglColor(char c, float bright=1) { Set(c,bright); }
64
+ /// Set color as Red, Green, Blue values
65
+ void Set(float R,float G,float B,float A=1) { r=R; g=G; b=B; a=A; }
66
+ /// Set color as Red, Green, Blue values
67
+ void Set(mglColor c, float bright=1)
68
+ {
69
+ if(bright<0) bright=0; if(bright>2.f) bright=2.f;
70
+ r = bright<=1 ? c.r*bright : 1 - (1-c.r)*(2-bright);
71
+ g = bright<=1 ? c.g*bright : 1 - (1-c.g)*(2-bright);
72
+ b = bright<=1 ? c.b*bright : 1 - (1-c.b)*(2-bright); a = 1;
73
+ }
74
+ /// Check if color is valid
75
+ inline bool Valid()
76
+ { return (r>=0 && r<=1 && g>=0 && g<=1 && b>=0 && b<=1 && a>=0 && a<=1); }
77
+ /// Get maximal spectral component
78
+ inline float Norm()
79
+ { return r>g ? r : (g>b ? g : b); }
80
+ inline float NormS()
81
+ { return r*r+g*g+b*b; }
82
+ /// Set color from symbolic id
83
+ inline void Set(char p, float bright=1)
84
+ {
85
+ float rgb[3]; mgl_chrrgb(p,rgb);
86
+ Set(mglColor(rgb[0],rgb[1],rgb[2]),bright);
87
+ }
88
+ /// Copy color from other one
89
+ inline bool operator==(const mglColor &c) const
90
+ { return !memcmp(this, &c, sizeof(mglColor)); }
91
+ inline bool operator!=(const mglColor &c) const
92
+ { return memcmp(this, &c, sizeof(mglColor)); }
93
+ inline bool operator<(const mglColor &c) const
94
+ { return memcmp(this, &c, sizeof(mglColor))<0; }
95
+ // transparency still the same
96
+ inline void operator*=(float v) { r*=v; g*=v; b*=v; a*=v; }
97
+ inline void operator+=(const mglColor &c) { r+=c.r; g+=c.g; b+=c.b; a+=c.a; }
98
+ inline void operator-=(const mglColor &c) { r-=c.r; g-=c.g; b-=c.b; a-=c.a; }
99
+ };
100
+ //-----------------------------------------------------------------------------
@@ -1,3 +1,3 @@
1
1
  module MathGL
2
- VERSION = "0.0.5"
2
+ VERSION = "0.1.0"
3
3
  end
data/mathgl.gemspec CHANGED
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["masa16.tanaka@gmail.com"]
11
11
  spec.description = %q{Ruby wrapper for MathGL - library for scientific data visualization}
12
12
  spec.summary = %q{Ruby wrapper for MathGL - library for scientific data visualization}
13
- spec.homepage = "https://github.com/masa16/ruby-mathgl"
13
+ spec.homepage = "http://masa16.github.io/ruby-mathgl/"
14
14
  spec.license = "LGPL"
15
15
  spec.extensions = ["ext/mathgl/extconf.rb"]
16
16
 
data/misc/Rakefile CHANGED
@@ -1,8 +1,8 @@
1
1
  require 'rake/clean'
2
2
 
3
3
  task :mkdoc do
4
- sh "ruby conv_texi.rb"
5
- sh "yard -r ../README.md --title 'Ruby/MathGL document'"
4
+ sh "ruby conv_texi.rb ~/2015/src/mathgl-2.3.2/texinfo/ ../lib/mathgl/doc/"
5
+ sh "yard doc -r ../README.md --title 'Ruby/MathGL document' '../lib/**/*.rb'"
6
6
  end
7
7
 
8
8
  task :default => :mkdoc
data/misc/conv_texi.rb CHANGED
@@ -108,7 +108,7 @@ class MethodType
108
108
 
109
109
 
110
110
  def parse(line)
111
- if /(.*)\((.*)\)/ =~ line.strip
111
+ if /([^()]*)\((.*)\)/ =~ line.strip
112
112
  m,parms = $1,$2
113
113
  if /(\S.*[\s*&])(\w+\S+)/ =~ m
114
114
  ret, meth = $1,$2
@@ -132,8 +132,10 @@ class MethodType
132
132
  def decomp_parms(parms)
133
133
  parms.split(/,/).each_with_index do |x,i|
134
134
  x.strip!
135
- if /(\S.*[\s*&])(\w+)(=([^=]+))?/ =~ x
136
- @args[i] = Args.new($1,$2,$4)
135
+ if /(\S.*[\s*&])\(\*(\w+)\)\([^()]*\)$/ =~ x
136
+ @args[i] = a = Args.new("function",$2,$4)
137
+ elsif /(\S.*[\s*&])(\w+)(=([^=]+))?/ =~ x
138
+ @args[i] = a = Args.new($1,$2,$4)
137
139
  elsif x=="num"
138
140
  @args[i] = Args.new("Numeric",x)
139
141
  else
@@ -312,12 +314,12 @@ class TexiParse
312
314
  end
313
315
 
314
316
  def deftype(tag,arg)
315
- #p arg
317
+ #p [tag,arg]
316
318
  @method = []
317
319
  deftypefnx(parse_inline(arg))
318
320
  lines = block_loop(tag,arg)
319
321
  s = ""
320
- section = @tags['section'].strip
322
+ section = (@tags['section']||"").strip
321
323
  if /^mgl.*class$/ !~ section
322
324
  s << "# #{section}.\n"
323
325
  end
@@ -421,8 +423,9 @@ class TexiParse
421
423
  end
422
424
  end
423
425
 
424
- srcdir = ENV["HOME"]+"/2013/src/mathgl-2.1.3.1/texinfo/"
425
- dstdir = "lib/mathgl/"
426
+ #srcdir = ENV["HOME"]+"/2013/src/mathgl-2.1.3.1/texinfo/"
427
+ #dstdir = "../lib/mathgl/doc/"
428
+ srcdir,dstdir = *ARGV
426
429
 
427
430
  %w[core data other parse].each do |b|
428
431
  rf = srcdir+b+'_en.texi'
data/setup.rb CHANGED
@@ -281,7 +281,6 @@ class ConfigTable
281
281
  'site-ruby-common' => 'siteruby', # For backward compatibility
282
282
  'site-ruby' => 'siterubyver', # For backward compatibility
283
283
  'bin-dir' => 'bindir',
284
- 'bin-dir' => 'bindir',
285
284
  'rb-dir' => 'rbdir',
286
285
  'so-dir' => 'sodir',
287
286
  'data-dir' => 'datadir',
@@ -659,7 +658,7 @@ module FileOperations
659
658
  def ruby(*args)
660
659
  command config('rubyprog'), *args
661
660
  end
662
-
661
+
663
662
  def make(task = nil)
664
663
  command(*[config('makeprog'), task].compact)
665
664
  end
@@ -722,7 +721,7 @@ module HookScriptAPI
722
721
  def srcdirectory?(path)
723
722
  File.dir?(srcfile(path))
724
723
  end
725
-
724
+
726
725
  def srcfile?(path)
727
726
  File.file?(srcfile(path))
728
727
  end
@@ -785,7 +784,11 @@ class ToplevelInstaller
785
784
  else
786
785
  require 'rbconfig'
787
786
  end
788
- ::Config::CONFIG
787
+ if defined? ::RbConfig
788
+ ::RbConfig::CONFIG
789
+ else
790
+ ::Config::CONFIG
791
+ end
789
792
  end
790
793
 
791
794
  def initialize(ardir_root, config)
@@ -826,7 +829,7 @@ class ToplevelInstaller
826
829
  __send__ "exec_#{task}"
827
830
  end
828
831
  end
829
-
832
+
830
833
  def run_metaconfigs
831
834
  @config.load_script "#{@ardir}/metaconfig"
832
835
  end
@@ -1404,7 +1407,7 @@ class Installer
1404
1407
  end
1405
1408
 
1406
1409
  # picked up many entries from cvs-1.11.1/src/ignore.c
1407
- JUNK_FILES = %w(
1410
+ JUNK_FILES = %w(
1408
1411
  core RCSLOG tags TAGS .make.state
1409
1412
  .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
1410
1413
  *~ *.old *.bak *.BAK *.orig *.rej _$* *$
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mathgl
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Masahiro TANAKA
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2013-10-29 00:00:00.000000000 Z
11
+ date: 2015-05-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -52,27 +52,30 @@ files:
52
52
  - README.md
53
53
  - Rakefile
54
54
  - TODO
55
+ - ext/mathgl/data.i
55
56
  - ext/mathgl/depend
56
57
  - ext/mathgl/extconf.rb
57
58
  - ext/mathgl/mathgl.cxx
58
59
  - ext/mathgl/mathgl.i
60
+ - ext/mathgl/mgl.i
59
61
  - ext/mathgl/rubymgl.i
60
62
  - ext/mathgl/tmpl/mkwin.rb
61
63
  - ext/mathgl/tmpl/win.erb.cxx
64
+ - ext/mathgl/type.i
65
+ - lib/mathgl/doc/libdoc_core_en.rb
66
+ - lib/mathgl/doc/libdoc_data_en.rb
67
+ - lib/mathgl/doc/libdoc_other_en.rb
68
+ - lib/mathgl/doc/libdoc_parse_en.rb
69
+ - lib/mathgl/doc/libdoc_window_en.rb
62
70
  - lib/mathgl/version.rb
63
71
  - mathgl.gemspec
64
72
  - misc/Rakefile
65
73
  - misc/conv_texi.rb
66
- - misc/lib/mathgl/libdoc_core_en.rb
67
- - misc/lib/mathgl/libdoc_data_en.rb
68
- - misc/lib/mathgl/libdoc_other_en.rb
69
- - misc/lib/mathgl/libdoc_parse_en.rb
70
- - misc/lib/mathgl/libdoc_window_en.rb
71
74
  - sample/conv_sample.rb
72
75
  - sample/prepare.rb
73
76
  - sample/sample.rb
74
77
  - setup.rb
75
- homepage: https://github.com/masa16/ruby-mathgl
78
+ homepage: http://masa16.github.io/ruby-mathgl/
76
79
  licenses:
77
80
  - LGPL
78
81
  metadata: {}
@@ -108,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
108
111
  version: '0'
109
112
  requirements: []
110
113
  rubyforge_project:
111
- rubygems_version: 2.0.3
114
+ rubygems_version: 2.4.5
112
115
  signing_key:
113
116
  specification_version: 4
114
117
  summary: Ruby wrapper for MathGL - library for scientific data visualization
@@ -1,4271 +0,0 @@
1
- # This document is converted from core_en.texi.
2
-
3
- # module MathGL
4
- module MathGL
5
-
6
- # MglGraph class
7
- class MglGraph
8
-
9
- # Create and delete objects.
10
- # Creates the instance of class mglGraph with specified sizes width and height. Parameter kind may have following values: '0' -- use default plotter, '1' -- use OpenGL plotter.
11
- #
12
- # @overload initialize(kind=0,width=600,height=400)
13
- # @param [Integer] kind default=0
14
- # @param [Integer] width default=600
15
- # @param [Integer] height default=400
16
- # @return [MglGraph]
17
- #
18
- # @overload initialize(gr)
19
- # @param [MglGraph] gr
20
- # @return [MglGraph]
21
- def initialize
22
- end
23
-
24
-
25
- # Graphics setup.
26
- # Restore initial values for all of parameters.
27
- #
28
- # @overload default_plot_param()
29
- # @return [nil]
30
- def default_plot_param
31
- end
32
-
33
-
34
- # Transparency.
35
- # Sets the transparency on/off and returns previous value of transparency. It is recommended to call this function before any plotting command. Default value is transparency off.
36
- #
37
- # @overload alpha(enable)
38
- # @param [bool] enable
39
- # @return [nil]
40
- def alpha
41
- end
42
-
43
-
44
- # Transparency.
45
- # Sets default value of alpha channel (transparency) for all plotting functions. Initial value is 0.5.
46
- #
47
- # @overload set_alpha_def(val)
48
- # @param [Float] val
49
- # @return [nil]
50
- def set_alpha_def
51
- end
52
-
53
-
54
- # Transparency.
55
- # Set the type of transparency. Possible values are:
56
- # Types of transparency.
57
- #
58
- # @overload set_transp_type(type)
59
- # @param [Integer] type
60
- # @return [nil]
61
- def set_transp_type
62
- end
63
-
64
-
65
- # Lighting.
66
- # Sets the using of light on/off for overall plot. Function returns previous value of lighting. Default value is lightning off.
67
- #
68
- # @overload light(enable)
69
- # @param [bool] enable
70
- # @return [bool]
71
- def light
72
- end
73
-
74
-
75
- # Lighting.
76
- # Switch on/off n-th light source separately.
77
- #
78
- # @overload light(n,enable)
79
- # @param [Integer] n
80
- # @param [bool] enable
81
- # @return [nil]
82
- def light
83
- end
84
-
85
-
86
- # Lighting.
87
- # The function adds a light source with identification n in direction d with color c and with brightness bright (which must be in range (0,1)). If position r is specified and isn't NAN then light source is supposed to be local otherwise light source is supposed to be placed at infinity.
88
- #
89
- # @overload add_light(n,d,c='w',bright=0.5,ap=0)
90
- # @param [Integer] n
91
- # @param [MglPoint] d
92
- # @param [String] c default='w'
93
- # @param [Float] bright default=0.5
94
- # @param [Float] ap default=0
95
- # @return [nil]
96
- #
97
- # @overload add_light(n,r,d,c='w',bright=0.5,ap=0)
98
- # @param [Integer] n
99
- # @param [MglPoint] r
100
- # @param [MglPoint] d
101
- # @param [String] c default='w'
102
- # @param [Float] bright default=0.5
103
- # @param [Float] ap default=0
104
- # @return [nil]
105
- def add_light
106
- end
107
-
108
-
109
- # Lighting.
110
- # Set on/off to use diffusive light (only for local light sources).
111
- #
112
- # @overload set_dif_light(enable)
113
- # @param [bool] enable
114
- # @return [nil]
115
- def set_dif_light
116
- end
117
-
118
-
119
- # Lighting.
120
- # Sets the brightness of ambient light. The value should be in range (0,1).
121
- #
122
- # @overload set_ambient(bright=0.5)
123
- # @param [Float] bright default=0.5
124
- # @return [nil]
125
- def set_ambient
126
- end
127
-
128
-
129
- # Fog.
130
- # Function imitate a fog in the plot. Fog start from relative distance dz from view point and its density growths exponentially in depth. So that the fog influence is determined by law ~ 1-exp(-d*z). Here *z* is normalized to 1 depth of the plot. If value d=0 then the fog is absent. Note, that fog was applied at stage of image creation, not at stage of drawing. Adding fog
131
- #
132
- # @overload fog(d,dz=0.25)
133
- # @param [Float] d
134
- # @param [Float] dz default=0.25
135
- # @return [nil]
136
- def fog
137
- end
138
-
139
-
140
- # Default sizes.
141
- # Sets relative width of rectangles in bars, barh, boxplot, candle. Default value is 0.7.
142
- #
143
- # @overload set_bar_width(val)
144
- # @param [Float] val
145
- # @return [nil]
146
- def set_bar_width
147
- end
148
-
149
-
150
- # Default sizes.
151
- # Sets size of marks for 1D plotting. Default value is 1.
152
- #
153
- # @overload set_mark_size(val)
154
- # @param [Float] val
155
- # @return [nil]
156
- def set_mark_size
157
- end
158
-
159
-
160
- # Default sizes.
161
- # Sets size of arrows for 1D plotting, lines and curves (see Primitives). Default value is 1.
162
- #
163
- # @overload set_arrow_size(val)
164
- # @param [Float] val
165
- # @return [nil]
166
- def set_arrow_size
167
- end
168
-
169
-
170
- # Default sizes.
171
- # Sets approximate number of lines in mesh, fall, grid and also the number of hachures in vect, dew and the number of cells in cloud. By default (=0) it draws all lines/hachures/cells.
172
- #
173
- # @overload set_mesh_num(val)
174
- # @param [Integer] val
175
- # @return [nil]
176
- def set_mesh_num
177
- end
178
-
179
-
180
- # Default sizes.
181
- # Sets approximate number of visible faces. Can be used for speeding up drawing by cost of lower quality. By default (=0) it draws all of them.
182
- #
183
- # @overload set_face_num(val)
184
- # @param [Integer] val
185
- # @return [nil]
186
- def set_face_num
187
- end
188
-
189
-
190
- # Default sizes.
191
- # Sets default name id as filename for saving (in FLTK window for example).
192
- #
193
- # @overload set_plot_id(id)
194
- # @param [String] id
195
- # @return [nil]
196
- def set_plot_id
197
- end
198
-
199
-
200
- # Default sizes.
201
- # Gets default name id as filename for saving (in FLTK window for example).
202
- #
203
- # @overload get_plot_id()
204
- # @return [String]
205
- def get_plot_id
206
- end
207
-
208
-
209
- # Cutting.
210
- # Flag which determines how points outside bounding box are drawn. If it is true then points are excluded from plot (it is default) otherwise the points are projected to edges of bounding box.
211
- #
212
- # @overload set_cut(val)
213
- # @param [bool] val
214
- # @return [nil]
215
- def set_cut
216
- end
217
-
218
-
219
- # Cutting.
220
- # Lower and upper edge of the box in which never points are drawn. If both edges are the same (the variables are equal) then the cutting box is empty.
221
- #
222
- # @overload set_cut_box(p1,p1)
223
- # @param [MglPoint] p1
224
- # @param [MglPoint] p1
225
- # @return [nil]
226
- def set_cut_box
227
- end
228
-
229
-
230
- # Cutting.
231
- # Sets the cutting off condition by formula cond. This condition determine will point be plotted or not. If value of formula is nonzero then point is omitted, otherwise it plotted. Set argument as "" to disable cutting off condition.
232
- #
233
- # @overload cut_off(cond)
234
- # @param [String] cond
235
- # @return [nil]
236
- def cut_off
237
- end
238
-
239
-
240
- # Font settings.
241
- # Sets to use or not text rotation.
242
- #
243
- # @overload set_rotated_text(val)
244
- # @param [bool] val
245
- # @return [nil]
246
- def set_rotated_text
247
- end
248
-
249
-
250
- # Font settings.
251
- # Load font typeface from path/name. Empty name will load default font.
252
- #
253
- # @overload load_font(name,path="")
254
- # @param [String] name
255
- # @param [String] path default=""
256
- # @return [nil]
257
- def load_font
258
- end
259
-
260
-
261
- # Font settings.
262
- # Sets the font specification (see Text printing). Default is 'rC' -- Roman font centering.
263
- #
264
- # @overload set_font_def(fnt)
265
- # @param [String] fnt
266
- # @return [nil]
267
- def set_font_def
268
- end
269
-
270
-
271
- # Font settings.
272
- # Sets the size of font for tick and axis labels. Default font size of axis labels is 1.4 times large than for tick labels.
273
- #
274
- # @overload set_font_size(val)
275
- # @param [Float] val
276
- # @return [nil]
277
- def set_font_size
278
- end
279
-
280
-
281
- # Font settings.
282
- # Set FontSize by size in pt and picture DPI (default is 16 pt for dpi=72).
283
- #
284
- # @overload set_font_size_pt(cm,dpi=72)
285
- # @param [Float] cm
286
- # @param [Integer] dpi default=72
287
- # @return [nil]
288
- def set_font_size_pt
289
- end
290
-
291
-
292
- # Font settings.
293
- # Set FontSize by size in centimeters and picture DPI (default is 0.56 cm = 16 pt).
294
- #
295
- # @overload set_font_size_cm(cm,dpi=72)
296
- # @param [Float] cm
297
- # @param [Integer] dpi default=72
298
- # @return [nil]
299
- def set_font_size_cm
300
- end
301
-
302
-
303
- # Font settings.
304
- # Set FontSize by size in inch and picture DPI (default is 0.22 in = 16 pt).
305
- #
306
- # @overload set_font_size_in(cm,dpi=72)
307
- # @param [Float] cm
308
- # @param [Integer] dpi default=72
309
- # @return [nil]
310
- def set_font_size_in
311
- end
312
-
313
-
314
- # Font settings.
315
- # Load font typeface from path/name.
316
- #
317
- # @overload load_font(name,path="")
318
- # @param [String] name
319
- # @param [String] path default=""
320
- # @return [nil]
321
- def load_font
322
- end
323
-
324
-
325
- # Font settings.
326
- # Copy font data from another mglGraph object.
327
- #
328
- # @overload copy_font(from)
329
- # @param [MglGraph] from
330
- # @return [nil]
331
- def copy_font
332
- end
333
-
334
-
335
- # Font settings.
336
- # Restore font data to default typeface.
337
- #
338
- # @overload restore_font()
339
- # @return [nil]
340
- def restore_font
341
- end
342
-
343
-
344
- # Palette and colors.
345
- # Sets the palette as selected colors. Default value is "Hbgrcmyhlnqeup" that corresponds to colors: dark gray 'H', blue 'b', green 'g', red 'r', cyan 'c', magenta 'm', yellow 'y', gray 'h', blue-green 'l', sky-blue 'n', orange 'q', yellow-green 'e', blue-violet 'u', purple 'p'. The palette is used mostly in 1D plots (see 1D plotting) for curves which styles are not specified. Internal color counter will be nullified by any change of palette. This includes even hidden change (for example, by box or axis functions).
346
- #
347
- # @overload set_palette(colors)
348
- # @param [String] colors
349
- # @return [nil]
350
- def set_palette
351
- end
352
-
353
-
354
- # Palette and colors.
355
- # Sets the sch as default color scheme. Default value is "BbcyrR".
356
- #
357
- # @overload set_def_scheme(sch)
358
- # @param [String] sch
359
- # @return [nil]
360
- def set_def_scheme
361
- end
362
-
363
-
364
- # Error handling.
365
- # Set warning code. Normally you should call this function only for clearing the warning state, i.e. call SetWarn(0);. Text info will be printed as is if code<0.
366
- #
367
- # @overload set_warn(code,info="")
368
- # @param [Integer] code
369
- # @param [String] info default=""
370
- # @return [nil]
371
- def set_warn
372
- end
373
-
374
-
375
- # Error handling.
376
- # Return messages about matters why some plot are not drawn. If returned string is empty then there are no messages.
377
- #
378
- # @overload message()
379
- # @return [String]
380
- def message
381
- end
382
-
383
-
384
- # Error handling.
385
- # Return the numerical ID of warning about the not drawn plot. Possible values are:
386
- #
387
- # @overload get_warn_code()
388
- # @return [Integer]
389
- def get_warn_code
390
- end
391
-
392
-
393
- # Ranges (bounding box).
394
- # Sets the range for 'x'-,'y'-,'z'- coordinate or coloring ('c'). See also ranges.
395
- #
396
- # @overload set_range(dir,v1,v2)
397
- # @param [String] dir
398
- # @param [Float] v1
399
- # @param [Float] v2
400
- # @return [nil]
401
- def set_range
402
- end
403
-
404
-
405
- # Ranges (bounding box).
406
- # Sets the range for 'x'-,'y'-,'z'- coordinate or coloring ('c') as minimal and maximal values of data dat. Parameter add=on shows that the new range will be joined to existed one (not replace it).
407
- #
408
- # @overload set_range(dir,dat,add=false)
409
- # @param [String] dir
410
- # @param [MglData] dat
411
- # @param [bool] add default=false
412
- # @return [nil]
413
- def set_range
414
- end
415
-
416
-
417
- # Ranges (bounding box).
418
- # Sets the ranges of coordinates. If minimal and maximal values of the coordinate are the same then they are ignored. Also it sets the range for coloring (analogous to crange z1 z2). This is default color range for 2d plots. Initial ranges are (-1, 1).
419
- #
420
- # @overload set_ranges(p1,p2)
421
- # @param [MglPoint] p1
422
- # @param [MglPoint] p2
423
- # @return [nil]
424
- #
425
- # @overload set_ranges(x1,x2,y1,y2,z1=0,z2=0)
426
- # @param [Float] x1
427
- # @param [Float] x2
428
- # @param [Float] y1
429
- # @param [Float] y2
430
- # @param [Float] z1 default=0
431
- # @param [Float] z2 default=0
432
- # @return [nil]
433
- def set_ranges
434
- end
435
-
436
-
437
- # Ranges (bounding box).
438
- # Sets the ranges of 'x'-,'y'-,'z'-coordinates and coloring as minimal and maximal values of data xx, yy, zz, cc correspondingly.
439
- #
440
- # @overload set_ranges(xx,yy)
441
- # @param [MglData] xx
442
- # @param [MglData] yy
443
- # @return [nil]
444
- #
445
- # @overload set_ranges(xx,yy,zz)
446
- # @param [MglData] xx
447
- # @param [MglData] yy
448
- # @param [MglData] zz
449
- # @return [nil]
450
- #
451
- # @overload set_ranges(xx,yy,zz,cc)
452
- # @param [MglData] xx
453
- # @param [MglData] yy
454
- # @param [MglData] zz
455
- # @param [MglData] cc
456
- # @return [nil]
457
- def set_ranges
458
- end
459
-
460
-
461
- # Ranges (bounding box).
462
- # Sets the ranges for automatic coordinates. If minimal and maximal values of the coordinate are the same then they are ignored.
463
- #
464
- # @overload set_auto_ranges(p1,p2)
465
- # @param [MglPoint] p1
466
- # @param [MglPoint] p2
467
- # @return [nil]
468
- #
469
- # @overload set_auto_ranges(x1,x2,y1,y2,z1=0,z2=0,c1=0,c2=0)
470
- # @param [Float] x1
471
- # @param [Float] x2
472
- # @param [Float] y1
473
- # @param [Float] y2
474
- # @param [Float] z1 default=0
475
- # @param [Float] z2 default=0
476
- # @param [Float] c1 default=0
477
- # @param [Float] c2 default=0
478
- # @return [nil]
479
- def set_auto_ranges
480
- end
481
-
482
-
483
- # Ranges (bounding box).
484
- # Sets center of axis cross section. If one of values is NAN then MathGL try to select optimal axis position.
485
- #
486
- # @overload set_origin(p0)
487
- # @param [MglPoint] p0
488
- # @return [nil]
489
- #
490
- # @overload set_origin(x0,y0,z0=NAN)
491
- # @param [Float] x0
492
- # @param [Float] y0
493
- # @param [Float] z0 default=NAN
494
- # @return [nil]
495
- def set_origin
496
- end
497
-
498
-
499
- # Ranges (bounding box).
500
- # Additionally extend axis range for any settings made by SetRange or SetRanges functions according the formula min += (max-min)*p1 and max += (max-min)*p1 (or min *= (max/min)^p1 and max *= (max/min)^p1 for log-axis range when inf>max/min>100 or 0<max/min<0.01). Initial ranges are (0, 1). Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam().
501
- #
502
- # @overload zoom_axis(p1,p2)
503
- # @param [MglPoint] p1
504
- # @param [MglPoint] p2
505
- # @return [nil]
506
- def zoom_axis
507
- end
508
-
509
-
510
- # Curved coordinates.
511
- # Sets transformation formulas for curvilinear coordinate. Each string should contain mathematical expression for real coordinate depending on internal coordinates 'x', 'y', 'z' and 'a' or 'c' for colorbar. For example, the cylindrical coordinates are introduced as SetFunc("x*cos(y)", "x*sin(y)", "z");. For removing of formulas the corresponding parameter should be empty or NULL. Using transformation formulas will slightly slowing the program. Parameter EqA set the similar transformation formula for color scheme. Textual formulas.
512
- #
513
- # @overload set_func(eqx,eqy,eqz="",eqa="")
514
- # @param [String] eqx
515
- # @param [String] eqy
516
- # @param [String] eqz default=""
517
- # @param [String] eqa default=""
518
- # @return [nil]
519
- def set_func
520
- end
521
-
522
-
523
- # Curved coordinates.
524
- # Sets one of the predefined transformation formulas for curvilinear coordinate. Paramater how define the coordinates: mglCartesian=0 -- Cartesian coordinates (no transformation); mglPolar=1 -- Polar coordinates x_n=x*cos(y),y_n=x*sin(y), z_n=z; mglSpherical=2 -- Sperical coordinates x_n=x*sin(y)*cos(z), y_n=x*sin(y)*sin(z), z_n=x*cos(y); mglParabolic=3 -- Parabolic coordinates x_n=x*y, y_n=(x*x-y*y)/2, z_n=z; mglParaboloidal=4 -- Paraboloidal coordinates x_n=(x*x-y*y)*cos(z)/2, y_n=(x*x-y*y)*sin(z)/2, z_n=x*y; mglOblate=5 -- Oblate coordinates x_n=cosh(x)*cos(y)*cos(z), y_n=cosh(x)*cos(y)*sin(z), z_n=sinh(x)*sin(y); mglProlate=6 -- Prolate coordinates x_n=sinh(x)*sin(y)*cos(z), y_n=sinh(x)*sin(y)*sin(z), z_n=cosh(x)*cos(y); mglElliptic=7 -- Elliptic coordinates x_n=cosh(x)*cos(y), y_n=sinh(x)*sin(y), z_n=z; mglToroidal=8 -- Toroidal coordinates x_n=sinh(x)*cos(z)/(cosh(x)-cos(y)), y_n=sinh(x)*sin(z)/(cosh(x)-cos(y)), z_n=sin(y)/(cosh(x)-cos(y)); mglBispherical=9 -- Bispherical coordinates x_n=sin(y)*cos(z)/(cosh(x)-cos(y)), y_n=sin(y)*sin(z)/(cosh(x)-cos(y)), z_n=sinh(x)/(cosh(x)-cos(y)); mglBipolar=10 -- Bipolar coordinates x_n=sinh(x)/(cosh(x)-cos(y)), y_n=sin(y)/(cosh(x)-cos(y)), z_n=z; mglLogLog=11 -- log-log coordinates x_n=lg(x), y_n=lg(y), z_n=lg(z); mglLogX=12 -- log-x coordinates x_n=lg(x), y_n=y, z_n=z; mglLogY=13 -- log-y coordinates x_n=x, y_n=lg(y), z_n=z.
525
- #
526
- # @overload set_coor(how)
527
- # @param [Integer] how
528
- # @return [nil]
529
- def set_coor
530
- end
531
-
532
-
533
- # Curved coordinates.
534
- # The function sets to draws Ternary (tern=1), Quaternary (tern=2) plot or projections (tern=4,5,6).
535
- #
536
- # Ternary plot is special plot for 3 dependent coordinates (components) a, b, c so that a+b+c=1. MathGL uses only 2 independent coordinates a=x and b=y since it is enough to plot everything. At this third coordinate z act as another parameter to produce contour lines, surfaces and so on.
537
- #
538
- # Correspondingly, Quaternary plot is plot for 4 dependent coordinates a, b, c and d so that a+b+c+d=1. MathGL uses only 3 independent coordinates a=x, b=y and d=z since it is enough to plot everything.
539
- #
540
- # Projections can be obtained by adding value 4 to tern argument. So, that tern=4 will draw projections in Cartesian coordinates, tern=5 will draw projections in Ternary coordinates, tern=6 will draw projections in Quaternary coordinates.
541
- #
542
- # Use Ternary(0) for returning to usual axis. Ternary axis Axis projection
543
- #
544
- # @overload ternary(tern)
545
- # @param [Integer] tern
546
- # @return [nil]
547
- def ternary
548
- end
549
-
550
-
551
- # Ticks.
552
- # Set the ticks step, number of sub-ticks and initial ticks position to be the most human readable for the axis along direction(s) dir. Also set SetTuneTicks(true). Usually you don't need to call this function except the case of returning to default settings.
553
- #
554
- # @overload adjust(dir="xyzc")
555
- # @param [String] dir default="xyzc"
556
- # @return [nil]
557
- def adjust
558
- end
559
-
560
-
561
- # Ticks.
562
- # Set the ticks step d, number of sub-ticks ns (used for positive d) and initial ticks position org for the axis along direction dir (use 'c' for colorbar ticks). Variable d set step for axis ticks (if positive) or it's number on the axis range (if negative). Zero value set automatic ticks. If org value is NAN then axis origin is used.
563
- #
564
- # @overload set_ticks(dir,d=0,ns=0,org=NAN)
565
- # @param [String] dir
566
- # @param [Float] d default=0
567
- # @param [Integer] ns default=0
568
- # @param [Float] org default=NAN
569
- # @return [nil]
570
- def set_ticks
571
- end
572
-
573
-
574
- # Ticks.
575
- # Set the manual positions val and its labels lbl for ticks along axis dir. If array val is absent then values equidistantly distributed in interval (Min.x, Max.x) are used. Labels are separated by '\n' symbol. Use SetTicks() to restore automatic ticks.
576
- #
577
- # @overload set_ticks_val(dir,lbl,add=false)
578
- # @param [String] dir
579
- # @param [String] lbl
580
- # @param [bool] add default=false
581
- # @return [nil]
582
- #
583
- # @overload set_ticks_val(dir,val,lbl,add=false)
584
- # @param [String] dir
585
- # @param [MglData] val
586
- # @param [String] lbl
587
- # @param [bool] add default=false
588
- # @return [nil]
589
- def set_ticks_val
590
- end
591
-
592
-
593
- # Ticks.
594
- # Set template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. If templ="" then default template is used (in simplest case it is '%.2g'). Setting on template switch off automatic ticks tuning.
595
- #
596
- # @overload set_tick_templ(dir,templ)
597
- # @param [String] dir
598
- # @param [String] templ
599
- # @return [nil]
600
- def set_tick_templ
601
- end
602
-
603
-
604
- # Ticks.
605
- # Sets time labels with step val and template templ for x-,y-,z-axis ticks or colorbar ticks. It may contain TeX symbols also. The format of template templ is the same as described in http://www.manpagez.com/man/3/strftime/. Most common variants are '%X' for national representation of time, '%x' for national representation of date, '%Y' for year with century. If val=0 and/or templ="" then automatic tick step and/or template will be selected. You can use mgl_get_time() function for obtaining number of second for given date/time string. Note, that MS Visual Studio couldn't handle date before 1970.
606
- #
607
- # @overload set_ticks_time(dir,val,templ)
608
- # @param [String] dir
609
- # @param [Float] val
610
- # @param [String] templ
611
- # @return [nil]
612
- def set_ticks_time
613
- end
614
-
615
-
616
- # Ticks.
617
- # Switch on/off ticks enhancing by factoring common multiplier (for small, like from 0.001 to 0.002, or large, like from 1000 to 2000, coordinate values -- enabled if tune&1 is nonzero) or common component (for narrow range, like from 0.999 to 1.000 -- enabled if tune&2 is nonzero). Also set the position pos of common multiplier/component on the axis: =0 at minimal axis value, =1 at maximal axis value. Default value is 1.15.
618
- #
619
- # @overload set_tune_ticks(tune,pos=1.15)
620
- # @param [Integer] tune
621
- # @param [Float] pos default=1.15
622
- # @return [nil]
623
- def set_tune_ticks
624
- end
625
-
626
-
627
- # Ticks.
628
- # Set value of additional shift for ticks labels.
629
- #
630
- # @overload set_tick_shift(d)
631
- # @param [MglPoint] d
632
- # @return [nil]
633
- def set_tick_shift
634
- end
635
-
636
-
637
- # Ticks.
638
- # Enable/disable ticks rotation if there are too many ticks or ticks labels are too long.
639
- #
640
- # @overload set_tick_rotate(val)
641
- # @param [bool] val
642
- # @return [nil]
643
- def set_tick_rotate
644
- end
645
-
646
-
647
- # Ticks.
648
- # Enable/disable ticks skipping if there are too many ticks or ticks labels are too long.
649
- #
650
- # @overload set_tick_skip(val)
651
- # @param [bool] val
652
- # @return [nil]
653
- def set_tick_skip
654
- end
655
-
656
-
657
- # Ticks.
658
- #
659
- # Enable/disable using UTC time for ticks labels. In C/Fortran you can use mgl_set_flag(gr,val, MGL_USE_GMTIME);.
660
- #
661
- # @overload set_time_utc(val)
662
- # @param [bool] val
663
- # @return [nil]
664
- def set_time_utc
665
- end
666
-
667
-
668
- # Ticks.
669
- # Enable/disable drawing of ticks labels at axis origin. In C/Fortran you can use mgl_set_flag(gr,val, MGL_NO_ORIGIN);.
670
- #
671
- # @overload set_origin_tick(val=true)
672
- # @param [bool] val default=true
673
- # @return [nil]
674
- def set_origin_tick
675
- end
676
-
677
-
678
- # Ticks.
679
- # The relative length of axis ticks. Default value is 0.1. Parameter stt>0 set relative length of subticks which is in sqrt(1+stt) times smaller.
680
- #
681
- # @overload set_tick_len(val,stt=1)
682
- # @param [Float] val
683
- # @param [Float] stt default=1
684
- # @return [nil]
685
- def set_tick_len
686
- end
687
-
688
-
689
- # Ticks.
690
- # The line style of axis (stl), ticks (tck) and subticks (sub). If stl is empty then default style is used ('k' or 'w' depending on transparency type). If tck or sub is empty then axis style is used (i.e. stl).
691
- #
692
- # @overload set_axis_stl(stl="k",tck=0,sub=0)
693
- # @param [String] stl default="k"
694
- # @param [String] tck default=0
695
- # @param [String] sub default=0
696
- # @return [nil]
697
- def set_axis_stl
698
- end
699
-
700
-
701
- # Subplots and rotation.
702
- # Puts further plotting in a m-th cell of nx*ny grid of the whole frame area. This function set off any aspects or rotations. So it should be used first for creating the subplot. Extra space will be reserved for axis/colorbar if stl contain:
703
- # From the aesthetical point of view it is not recommended to use this function with different matrices in the same frame. The position of the cell can be shifted from its default position by relative size dx, dy.
704
- #
705
- # @overload sub_plot(nx,ny,m,stl="<>_^",dx=0,dy=0)
706
- # @param [Integer] nx
707
- # @param [Integer] ny
708
- # @param [Integer] m
709
- # @param [String] stl default="<>_^"
710
- # @param [Float] dx default=0
711
- # @param [Float] dy default=0
712
- # @return [nil]
713
- def sub_plot
714
- end
715
-
716
-
717
- # Subplots and rotation.
718
- # Puts further plotting in a rectangle of dx*dy cells starting from m-th cell of nx*ny grid of the whole frame area. This function set off any aspects or rotations. So it should be used first for creating subplot. Extra space will be reserved for axis/colorbar if stl contain:
719
- #
720
- # @overload multi_plot(nx,ny,m,dx,dy,stl="<>_^")
721
- # @param [Integer] nx
722
- # @param [Integer] ny
723
- # @param [Integer] m
724
- # @param [Integer] dx
725
- # @param [Integer] dy
726
- # @param [String] stl default="<>_^"
727
- # @return [nil]
728
- def multi_plot
729
- end
730
-
731
-
732
- # Subplots and rotation.
733
- # Puts further plotting in some region of the whole frame surface. This function allows one to create a plot in arbitrary place of the screen. The position is defined by rectangular coordinates (x1, x2)*(y1, y2). The coordinates x1, x2, y1, y2 are normalized to interval (0, 1). If parameter rel=true then the relative position to current subplot (or inplot with rel=false) is used. This function set off any aspects or rotations. So it should be used first for creating subplot.
734
- #
735
- # @overload in_plot(x1,x2,y1,y2,rel=true)
736
- # @param [Float] x1
737
- # @param [Float] x2
738
- # @param [Float] y1
739
- # @param [Float] y2
740
- # @param [bool] rel default=true
741
- # @return [nil]
742
- def in_plot
743
- end
744
-
745
-
746
- # Subplots and rotation.
747
- # Puts further plotting in ind-th cell of column with num cells. The position is relative to previous subplot (or inplot with rel=false). Parameter d set extra gap between cells.
748
- #
749
- # @overload column_plot(num,ind,d=0)
750
- # @param [Integer] num
751
- # @param [Integer] ind
752
- # @param [Float] d default=0
753
- # @return [nil]
754
- def column_plot
755
- end
756
-
757
-
758
- # Subplots and rotation.
759
- # Puts further plotting in ind-th cell of nx*ny grid. The position is relative to previous subplot (or inplot with rel=false). Parameter d set extra gap between cells.
760
- #
761
- # @overload grid_plot(nx,ny,ind,d=0)
762
- # @param [Integer] nx
763
- # @param [Integer] ny
764
- # @param [Integer] ind
765
- # @param [Float] d default=0
766
- # @return [nil]
767
- def grid_plot
768
- end
769
-
770
-
771
- # Subplots and rotation.
772
- # Puts further plotting in ind-th cell of stick with num cells. At this, stick is rotated on angles tet, phi. The position is relative to previous subplot (or inplot with rel=false).
773
- #
774
- # @overload stick_plot(num,ind,tet,phi)
775
- # @param [Integer] num
776
- # @param [Integer] ind
777
- # @param [Float] tet
778
- # @param [Float] phi
779
- # @return [nil]
780
- def stick_plot
781
- end
782
-
783
-
784
- # Subplots and rotation.
785
- # Add text title for current subplot/inplot. Paramater stl can contain:
786
- # Parameter size set font size. This function set off any aspects or rotations. So it should be used just after creating subplot.
787
- #
788
- # @overload title(txt,stl="",size=-2)
789
- # @param [String] txt
790
- # @param [String] stl default=""
791
- # @param [Float] size default=-2
792
- # @return [nil]
793
- def title
794
- end
795
-
796
-
797
- # Subplots and rotation.
798
- # Rotates a further plotting relative to each axis (x, z, y) consecutively on angles TetX, TetZ, TetY.
799
- #
800
- # @overload rotate(tetx,tetz,tety=0)
801
- # @param [Float] tetx
802
- # @param [Float] tetz
803
- # @param [Float] tety default=0
804
- # @return [nil]
805
- def rotate
806
- end
807
-
808
-
809
- # Subplots and rotation.
810
- # Rotates a further plotting around vector (x, y, z) on angle Tet.
811
- #
812
- # @overload rotate_n(tet,x,y,z)
813
- # @param [Float] tet
814
- # @param [Float] x
815
- # @param [Float] y
816
- # @param [Float] z
817
- # @return [nil]
818
- def rotate_n
819
- end
820
-
821
-
822
- # Subplots and rotation.
823
- # Defines aspect ratio for the plot. The viewable axes will be related one to another as the ratio Ax:Ay:Az. For the best effect it should be used after rotate function. If Ax is NAN then function try to select optimal aspect ratio to keep equal ranges for x-y axis. At this, Ay will specify proportionality factor, or set to use automatic one if Ay=NAN.
824
- #
825
- # @overload aspect(ax,ay,az=1)
826
- # @param [Float] ax
827
- # @param [Float] ay
828
- # @param [Float] az default=1
829
- # @return [nil]
830
- def aspect
831
- end
832
-
833
-
834
- # Subplots and rotation.
835
- # Add (switch on) the perspective to plot. The parameter a ~ 1/z_(eff@ \in (0,1)}. By default (a=0) the perspective is off.
836
- #
837
- # @overload perspective(a)
838
- # @param [Float] a
839
- # @return [nil]
840
- def perspective
841
- end
842
-
843
-
844
- # Subplots and rotation.
845
- # Push transformation matrix into stack. Later you can restore its current state by Pop() function.
846
- #
847
- # @overload push()
848
- # @return [nil]
849
- def push
850
- end
851
-
852
-
853
- # Subplots and rotation.
854
- # Pop (restore last 'pushed') transformation matrix into stack.
855
- #
856
- # @overload pop()
857
- # @return [nil]
858
- def pop
859
- end
860
-
861
-
862
- # Subplots and rotation.
863
- # Sets the factor of plot size. It is not recommended to set it lower then 1.5. This is some analogue of function Zoom() but applied not to overall image but for each InPlot. Use negative value or zero to enable automatic selection.
864
- #
865
- # @overload set_plot_factor(val)
866
- # @param [Float] val
867
- # @return [nil]
868
- def set_plot_factor
869
- end
870
-
871
-
872
- # Subplots and rotation.
873
- # Rotates a further plotting relative to each axis (x, z, y) consecutively on angles TetX, TetZ, TetY. Rotation is done independently on rotate. Attention! this settings can not be overwritten by DefaultPlotParam(). Use Zoom(0,0,1,1) to return default view.
874
- #
875
- # @overload view(tetx,tetz,tety=0)
876
- # @param [Float] tetx
877
- # @param [Float] tetz
878
- # @param [Float] tety default=0
879
- # @return [nil]
880
- def view
881
- end
882
-
883
-
884
- # Subplots and rotation.
885
- # The function changes the scale of graphics that correspond to zoom in/out of the picture. After function call the current plot will be cleared and further the picture will contain plotting from its part (x1,x2)*(y1,y2). Here picture coordinates x1, x2, y1, y2 changes from 0 to 1. Attention! this settings can not be overwritten by any other functions, including DefaultPlotParam(). Use Zoom(0,0,1,1) to return default view.
886
- #
887
- # @overload zoom(x1,y1,x2,y2)
888
- # @param [Float] x1
889
- # @param [Float] y1
890
- # @param [Float] x2
891
- # @param [Float] y2
892
- # @return [nil]
893
- def zoom
894
- end
895
-
896
-
897
- # Export picture.
898
- # Sets size of picture in pixels. This function must be called before any other plotting because it completely remove picture contents.
899
- #
900
- # @overload set_size(width,height)
901
- # @param [Integer] width
902
- # @param [Integer] height
903
- # @return [nil]
904
- def set_size
905
- end
906
-
907
-
908
- # Export picture.
909
- # Sets quality of the plot depending on value val: MGL_DRAW_WIRE=0 -- no face drawing (fastest), MGL_DRAW_FAST=1 -- no color interpolation (fast), MGL_DRAW_NORM=2 -- high quality (normal), MGL_DRAW_HIGH=3 -- high quality with 3d primitives (arrows and marks). If MGL_DRAW_LMEM=0x4 is set then direct bitmap drawing is used (low memory usage).
910
- #
911
- # @overload set_quality(val=MGL_DRAW_NORM)
912
- # @param [Integer] val default=MGL_DRAW_NORM
913
- # @return [nil]
914
- def set_quality
915
- end
916
-
917
-
918
- # Export picture.
919
- # Gets quality of the plot: MGL_DRAW_WIRE=0 -- no face drawing (fastest), MGL_DRAW_FAST=1 -- no color interpolation (fast), MGL_DRAW_NORM=2 -- high quality (normal), MGL_DRAW_HIGH=3 -- high quality with 3d primitives (arrows and marks). If MGL_DRAW_LMEM=0x4 is set then direct bitmap drawing is used (low memory usage).
920
- #
921
- # @overload get_quality()
922
- # @return [Integer]
923
- def get_quality
924
- end
925
-
926
-
927
- # Export picture.
928
- # Starts group definition. Groups contain objects and other groups, they are used to select a part of a model to zoom to or to make invizible or to make semitransparent and so on.
929
- #
930
- # @overload start_group(name)
931
- # @param [String] name
932
- # @return [nil]
933
- def start_group
934
- end
935
-
936
-
937
- # Export picture.
938
- # Ends group definition.
939
- #
940
- # @overload end_group()
941
- # @return [nil]
942
- def end_group
943
- end
944
-
945
-
946
- # Export to file.
947
- # Exports current frame to a file fname which type is determined by the extension. Parameter descr adds description to file (can be ""). If fname="" then the file 'frame####.jpg' is used, where '####' is current frame id and name 'frame' is defined by plotid class property.
948
- #
949
- # @overload write_frame(fname="",descr="")
950
- # @param [String] fname default=""
951
- # @param [String] descr default=""
952
- # @return [nil]
953
- def write_frame
954
- end
955
-
956
-
957
- # Export to file.
958
- # Exports current frame to PNG file. Parameter fname specifies the file name, descr adds description to file, alpha gives the transparency type. By default there are no description added and semitransparent image used. This function does nothing if HAVE_PNG isn't defined during compilation of MathGL library.
959
- #
960
- # @overload write_png(fname,descr="",compr="",alpha=true)
961
- # @param [String] fname
962
- # @param [String] descr default=""
963
- # @param [Integer] compr default=""
964
- # @param [bool] alpha default=true
965
- # @return [nil]
966
- def write_png
967
- end
968
-
969
-
970
- # Export to file.
971
- # Exports current frame to JPEG file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. This function does nothing if HAVE_JPEG isn't defined during compilation of MathGL library.
972
- #
973
- # @overload write_jpeg(fname,descr="")
974
- # @param [String] fname
975
- # @param [String] descr default=""
976
- # @return [nil]
977
- def write_jpeg
978
- end
979
-
980
-
981
- # Export to file.
982
- # Exports current frame to GIF file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. This function does nothing if HAVE_GIF isn't defined during compilation of MathGL library.
983
- #
984
- # @overload write_gif(fname,descr="")
985
- # @param [String] fname
986
- # @param [String] descr default=""
987
- # @return [nil]
988
- def write_gif
989
- end
990
-
991
-
992
- # Export to file.
993
- # Exports current frame to BMP file. Parameter fname specifies the file name, descr adds description to file. There is no compression used.
994
- #
995
- # @overload write_bmp(fname,descr="")
996
- # @param [String] fname
997
- # @param [String] descr default=""
998
- # @return [nil]
999
- def write_bmp
1000
- end
1001
-
1002
-
1003
- # Export to file.
1004
- # Exports current frame to TGA file. Parameter fname specifies the file name, descr adds description to file. There is no compression used.
1005
- #
1006
- # @overload write_tga(fname,descr="")
1007
- # @param [String] fname
1008
- # @param [String] descr default=""
1009
- # @return [nil]
1010
- def write_tga
1011
- end
1012
-
1013
-
1014
- # Export to file.
1015
- # Exports current frame to EPS file using vector representation. So it is not recommended for the export of large data plot. It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by 'z' (for example, 'fname.eps.gz') then file will be compressed in gzip format.
1016
- #
1017
- # @overload write_eps(fname,descr="")
1018
- # @param [String] fname
1019
- # @param [String] descr default=""
1020
- # @return [nil]
1021
- def write_eps
1022
- end
1023
-
1024
-
1025
- # Export to file.
1026
- # Exports current frame to EPS file using bitmap representation. Parameter fname specifies the file name, descr adds description to file. By default there is no description added. If file name is terminated by 'z' (for example, 'fname.eps.gz') then file will be compressed in gzip format.
1027
- #
1028
- # @overload write_bps(fname,descr="")
1029
- # @param [String] fname
1030
- # @param [String] descr default=""
1031
- # @return [nil]
1032
- def write_bps
1033
- end
1034
-
1035
-
1036
- # Export to file.
1037
- # Exports current frame to SVG (Scalable Vector Graphics) file using vector representation. In difference of EPS format, SVG format support transparency that allows to correctly draw semitransparent plot (like surfa, surf3a or cloud). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If file name is terminated by 'z' (for example, 'fname.svgz') then file will be compressed in gzip format.
1038
- #
1039
- # @overload write_svg(fname,descr="")
1040
- # @param [String] fname
1041
- # @param [String] descr default=""
1042
- # @return [nil]
1043
- def write_svg
1044
- end
1045
-
1046
-
1047
- # Export to file.
1048
- # Exports current frame to LaTeX (package Tikz/PGF) file using vector representation. Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). Note, there is no text scaling now (for example, in subplots), what may produce miss-aligned labels.
1049
- #
1050
- # @overload write_tex(fname,descr="")
1051
- # @param [String] fname
1052
- # @param [String] descr default=""
1053
- # @return [nil]
1054
- def write_tex
1055
- end
1056
-
1057
-
1058
- # Export to file.
1059
- # Exports current frame to PRC file using vector representation (see http://en.wikipedia.org/wiki/PRC_%28file_format%29). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name). If parameter make_pdf=true and PDF was enabled at MathGL configure then corresponding PDF file with 3D image will be created.
1060
- #
1061
- # @overload write_prc(fname,descr="",make_pdf=true)
1062
- # @param [String] fname
1063
- # @param [String] descr default=""
1064
- # @param [bool] make_pdf default=true
1065
- # @return [nil]
1066
- def write_prc
1067
- end
1068
-
1069
-
1070
- # Export to file.
1071
- # Exports current frame to OBJ/MTL file using vector representation (see http://en.wikipedia.org/wiki/Wavefront_.obj_file, OBJ format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
1072
- #
1073
- # @overload write_obj(fname,descr="")
1074
- # @param [String] fname
1075
- # @param [String] descr default=""
1076
- # @return [nil]
1077
- def write_obj
1078
- end
1079
-
1080
-
1081
- # Export to file.
1082
- # Exports current frame to XYZ/XYZL/XYZF files using vector representation (see http://people.sc.fsu.edu/~jburkardt/data/xyz/xyz.html, XYZ format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
1083
- #
1084
- # @overload write_xyz(fname,descr="")
1085
- # @param [String] fname
1086
- # @param [String] descr default=""
1087
- # @return [nil]
1088
- def write_xyz
1089
- end
1090
-
1091
-
1092
- # Export to file.
1093
- # Exports current frame to STL file using vector representation (see http://en.wikipedia.org/wiki/STL_(file_format), STL format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name.
1094
- #
1095
- # @overload write_stl(fname,descr="")
1096
- # @param [String] fname
1097
- # @param [String] descr default=""
1098
- # @return [nil]
1099
- def write_stl
1100
- end
1101
-
1102
-
1103
- # Export to file.
1104
- # Exports current frame to OFF file using vector representation (see http://people.sc.fsu.edu/~jburkardt/data/off/off.html, OFF format for details). Note, the output file may be too large for graphic of large data array (especially for surfaces). It is better to use bitmap format (for example PNG or JPEG). However, program has no internal limitations for size of output file. Parameter fname specifies the file name, descr adds description to file (default is file name).
1105
- #
1106
- # @overload write_off(fname,descr="",colored=false)
1107
- # @param [String] fname
1108
- # @param [String] descr default=""
1109
- # @param [bool] colored default=false
1110
- # @return [nil]
1111
- def write_off
1112
- end
1113
-
1114
-
1115
- # Export to file.
1116
- # Displays the current picture using external program viewer for viewing. The function save the picture to temporary file and call viewer to display it. If nowait=true then the function return immediately (it will not wait while window will be closed).
1117
- #
1118
- # @overload show_image(viewer,nowait=false)
1119
- # @param [String] viewer
1120
- # @param [bool] nowait default=false
1121
- # @return [nil]
1122
- def show_image
1123
- end
1124
-
1125
-
1126
- # Export to file.
1127
- # Exports current frame to textual file using JSON format. Later this file can be used for faster loading and viewing by JavaScript script. Parameter fname specifies the file name, descr adds description to file.
1128
- #
1129
- # @overload write_json(fname,descr="")
1130
- # @param [String] fname
1131
- # @param [String] descr default=""
1132
- # @return [nil]
1133
- def write_json
1134
- end
1135
-
1136
-
1137
- # Export to file.
1138
- # Exports points and primitives in file using MGLD format. Later this file can be used for faster loading and viewing by mglview utility. Parameter fname specifies the file name, descr adds description to file (default is file name).
1139
- #
1140
- # @overload export_mgld(fname,descr="")
1141
- # @param [String] fname
1142
- # @param [String] descr default=""
1143
- # @return [nil]
1144
- def export_mgld
1145
- end
1146
-
1147
-
1148
- # Export to file.
1149
- # Imports points and primitives in file using MGLD format. Later this file can be used for faster loading and viewing by mglview utility. Parameter fname specifies the file name, add sets to append or replace primitives to existed ones.
1150
- #
1151
- # @overload import_mgld(fname,add=false)
1152
- # @param [String] fname
1153
- # @param [bool] add default=false
1154
- # @return [nil]
1155
- def import_mgld
1156
- end
1157
-
1158
-
1159
- # Frames/Animation.
1160
- # Creates new frame. Function returns current frame id. This is not thread safe function in OpenGL mode! Use direct list creation in multi-threading drawing. The function EndFrame() must be call after the finishing of the frame drawing for each call of this function.
1161
- #
1162
- # @overload new_frame()
1163
- # @return [nil]
1164
- def new_frame
1165
- end
1166
-
1167
-
1168
- # Frames/Animation.
1169
- # Finishes the frame drawing.
1170
- #
1171
- # @overload end_frame()
1172
- # @return [nil]
1173
- def end_frame
1174
- end
1175
-
1176
-
1177
- # Frames/Animation.
1178
- # Gets the number of created frames.
1179
- #
1180
- # @overload get_num_frame()
1181
- # @return [Integer]
1182
- def get_num_frame
1183
- end
1184
-
1185
-
1186
- # Frames/Animation.
1187
- # Finishes the frame drawing and sets drawing data to frame i, which should be in range (0, GetNumFrame()-1). This function is similar to EndFrame() but don't add frame to the GIF image.
1188
- #
1189
- # @overload set_frame(i)
1190
- # @param [Integer] i
1191
- # @return [nil]
1192
- def set_frame
1193
- end
1194
-
1195
-
1196
- # Frames/Animation.
1197
- # Replaces drawing data by one from frame i. Function work if MGL_VECT_FRAME is set on (by default).
1198
- #
1199
- # @overload get_frame(i)
1200
- # @param [Integer] i
1201
- # @return [nil]
1202
- def get_frame
1203
- end
1204
-
1205
-
1206
- # Frames/Animation.
1207
- # Appends drawing data from frame i to current one. Function work if MGL_VECT_FRAME is set on (by default).
1208
- #
1209
- # @overload show_frame(i)
1210
- # @param [Integer] i
1211
- # @return [nil]
1212
- def show_frame
1213
- end
1214
-
1215
-
1216
- # Frames/Animation.
1217
- # Deletes drawing data for frame i and shift all later frame indexes. Function work if MGL_VECT_FRAME is set on (by default). Do nothing in OpenGL mode.
1218
- #
1219
- # @overload del_frame(i)
1220
- # @param [Integer] i
1221
- # @return [nil]
1222
- def del_frame
1223
- end
1224
-
1225
-
1226
- # Frames/Animation.
1227
- # Reset frames counter (start it from zero).
1228
- #
1229
- # @overload reset_frames()
1230
- # @return [nil]
1231
- def reset_frames
1232
- end
1233
-
1234
-
1235
- # Frames/Animation.
1236
- # Start writing frames into animated GIF file fname. Parameter ms set the delay between frames in milliseconds. You should not change the picture size during writing the cinema. Use CloseGIF() to finalize writing. Note, that this function is disabled in OpenGL mode.
1237
- #
1238
- # @overload start_gif(fname,ms=100)
1239
- # @param [String] fname
1240
- # @param [Integer] ms default=100
1241
- # @return [nil]
1242
- def start_gif
1243
- end
1244
-
1245
-
1246
- # Frames/Animation.
1247
- # Finish writing animated GIF and close connected pointers.
1248
- #
1249
- # @overload close_gif()
1250
- # @return [nil]
1251
- def close_gif
1252
- end
1253
-
1254
-
1255
- # Bitmap in memory.
1256
- # Gets RGB bitmap of the current state of the image. Format of each element of bits is: (red, green, blue). Number of elements is Width*Height. Position of element (i,j) is (3*i + 3*Width*j) (or is (4*i + 4*Width*j) for GetBGRN()). You have to provide the proper size of the buffer, buf, i.e. the code for Python should look like
1257
- #
1258
- # @overload get_rgb()
1259
- # @return [unsigned char]
1260
- #
1261
- # @overload get_rgb(buf,size)
1262
- # @param [String] buf
1263
- # @param [Integer] size
1264
- # @return [nil]
1265
- def get_rgb
1266
- end
1267
-
1268
-
1269
- # Bitmap in memory.
1270
- # Gets RGB bitmap of the current state of the image. Format of each element of bits is: (red, green, blue). Number of elements is Width*Height. Position of element (i,j) is (3*i + 3*Width*j) (or is (4*i + 4*Width*j) for GetBGRN()). You have to provide the proper size of the buffer, buf, i.e. the code for Python should look like
1271
- #
1272
- # @overload get_bgrn(buf,size)
1273
- # @param [String] buf
1274
- # @param [Integer] size
1275
- # @return [nil]
1276
- def get_bgrn
1277
- end
1278
-
1279
-
1280
- # Bitmap in memory.
1281
- # Gets RGBA bitmap of the current state of the image. Format of each element of bits is: (red, green, blue, alpha). Number of elements is Width*Height. Position of element (i,j) is (4*i + 4*Width*j).
1282
- #
1283
- # @overload get_rgba()
1284
- # @return [unsigned char]
1285
- #
1286
- # @overload get_rgba(buf,size)
1287
- # @param [String] buf
1288
- # @param [Integer] size
1289
- # @return [nil]
1290
- def get_rgba
1291
- end
1292
-
1293
-
1294
- # Bitmap in memory.
1295
- # Gets width and height of the image.
1296
- #
1297
- # @overload get_width()
1298
- # @return [Integer]
1299
- def get_width
1300
- end
1301
-
1302
-
1303
- # Bitmap in memory.
1304
- # Gets width and height of the image.
1305
- #
1306
- # @overload get_height()
1307
- # @return [Integer]
1308
- def get_height
1309
- end
1310
-
1311
-
1312
- # Bitmap in memory.
1313
- # Calculate 3D coordinate (x,y,z) for screen point (xs,ys). At this moment it ignore perspective and transformation formulas (curvilinear coordinates). The calculation are done for the last used InPlot (see Subplots and rotation).
1314
- #
1315
- # @overload calc_xyz(xs,ys)
1316
- # @param [Integer] xs
1317
- # @param [Integer] ys
1318
- # @return [MglPoint]
1319
- def calc_xyz
1320
- end
1321
-
1322
-
1323
- # Bitmap in memory.
1324
- # Calculate screen point (xs,ys) for 3D coordinate (x,y,z). The calculation are done for the last used InPlot (see Subplots and rotation).
1325
- #
1326
- # @overload calc_scr(p)
1327
- # @param [MglPoint] p
1328
- # @return [MglPoint]
1329
- def calc_scr
1330
- end
1331
-
1332
-
1333
- # Bitmap in memory.
1334
- # Set the numeric id for object or subplot/inplot.
1335
- #
1336
- # @overload set_obj_id(id)
1337
- # @param [Integer] id
1338
- # @return [nil]
1339
- def set_obj_id
1340
- end
1341
-
1342
-
1343
- # Bitmap in memory.
1344
- # Get the numeric id for most upper object at pixel (xs, ys) of the picture.
1345
- #
1346
- # @overload get_obj_id(xs,ys)
1347
- # @param [Integer] xs
1348
- # @param [Integer] ys
1349
- # @return [Integer]
1350
- def get_obj_id
1351
- end
1352
-
1353
-
1354
- # Bitmap in memory.
1355
- # Get the numeric id for most subplot/inplot at pixel (xs, ys) of the picture.
1356
- #
1357
- # @overload get_spl_id(xs,ys)
1358
- # @param [Integer] xs
1359
- # @param [Integer] ys
1360
- # @return [Integer]
1361
- def get_spl_id
1362
- end
1363
-
1364
-
1365
- # Bitmap in memory.
1366
- # Highlight the object with given id.
1367
- #
1368
- # @overload highlight(id)
1369
- # @param [Integer] id
1370
- # @return [nil]
1371
- def highlight
1372
- end
1373
-
1374
-
1375
- # Bitmap in memory.
1376
- # Checks if point (xs, ys) is close to one of active point (i.e. mglBase::Act) with accuracy d and return its index or -1 if not found. Active points are special points which characterize primitives (like edges and so on). This function for advanced users only.
1377
- #
1378
- # @overload is_active(xs,ys,d=1)
1379
- # @param [Integer] xs
1380
- # @param [Integer] ys
1381
- # @param [Integer] d default=1
1382
- # @return [long]
1383
- def is_active
1384
- end
1385
-
1386
-
1387
- # Parallelization.
1388
- # Combine drawing from instance g with gr (or with this) taking into account Z-ordering of pixels. The width and height of both instances must be the same.
1389
- #
1390
- # @overload combine(g)
1391
- # @param [MglGraph] g
1392
- # @return [Integer]
1393
- def combine
1394
- end
1395
-
1396
-
1397
- # Parallelization.
1398
- # Send graphical information from node id using MPI. The width and height in both nodes must be the same.
1399
- #
1400
- # @overload mpi_send(id)
1401
- # @param [Integer] id
1402
- # @return [Integer]
1403
- def mpi_send
1404
- end
1405
-
1406
-
1407
- # Parallelization.
1408
- # Receive graphical information from node id using MPI. The width and height in both nodes must be the same.
1409
- #
1410
- # @overload mpi_recv(id)
1411
- # @param [Integer] id
1412
- # @return [Integer]
1413
- def mpi_recv
1414
- end
1415
-
1416
-
1417
- # Primitives.
1418
- # Clear the picture and fill it by color specified color.
1419
- #
1420
- # @overload clf()
1421
- # @return [nil]
1422
- #
1423
- # @overload clf(r,g,b)
1424
- # @param [Float] r
1425
- # @param [Float] g
1426
- # @param [Float] b
1427
- # @return [nil]
1428
- def clf
1429
- end
1430
-
1431
-
1432
- # Primitives.
1433
- # Draws a mark (point '.' by default) at position p=(x, y, z) with color col.
1434
- #
1435
- # @overload ball(p,col='r')
1436
- # @param [MglPoint] p
1437
- # @param [String] col default='r'
1438
- # @return [nil]
1439
- def ball
1440
- end
1441
-
1442
-
1443
- # Primitives.
1444
- # Draws a mark (point '.' by default) at position p=(x, y, z) with color col.
1445
- #
1446
- # @overload mark(p,mark)
1447
- # @param [MglPoint] p
1448
- # @param [String] mark
1449
- # @return [nil]
1450
- def mark
1451
- end
1452
-
1453
-
1454
- # Primitives.
1455
- # Draws a 3d error box at position p=(x, y, z) with sizes e=(ex, ey, ez) and style stl. Use NAN for component of e to reduce number of drawn elements.
1456
- #
1457
- # @overload error(p,e,stl="")
1458
- # @param [MglPoint] p
1459
- # @param [MglPoint] e
1460
- # @param [String] stl default=""
1461
- # @return [nil]
1462
- def error
1463
- end
1464
-
1465
-
1466
- # Primitives.
1467
- # Draws a geodesic line (straight line in Cartesian coordinates) from point p1 to p2 using line style stl. Parameter num define the ``quality'' of the line. If num=2 then the stright line will be drawn in all coordinate system (independently on transformation formulas (see Curved coordinates). Contrary, for large values (for example, =100) the geodesic line will be drawn in corresponding coordinate system (straight line in Cartesian coordinates, circle in polar coordinates and so on). Line will be drawn even if it lies out of bounding box.
1468
- #
1469
- # @overload line(p1,p2,stl="B",num=2)
1470
- # @param [MglPoint] p1
1471
- # @param [MglPoint] p2
1472
- # @param [String] stl default="B"
1473
- # @param [Integer] num default=2
1474
- # @return [nil]
1475
- def line
1476
- end
1477
-
1478
-
1479
- # Primitives.
1480
- # Draws Bezier-like curve from point p1 to p2 using line style stl. At this tangent is codirected with d1, d2 and proportional to its amplitude. Parameter num define the ``quality'' of the curve. If num=2 then the straight line will be drawn in all coordinate system (independently on transformation formulas, see Curved coordinates). Contrary, for large values (for example, =100) the spline like Bezier curve will be drawn in corresponding coordinate system. Curve will be drawn even if it lies out of bounding box.
1481
- #
1482
- # @overload curve(p1,d1,p2,d2,stl="B",num=100)
1483
- # @param [MglPoint] p1
1484
- # @param [MglPoint] d1
1485
- # @param [MglPoint] p2
1486
- # @param [MglPoint] d2
1487
- # @param [String] stl default="B"
1488
- # @param [Integer] num default=100
1489
- # @return [nil]
1490
- def curve
1491
- end
1492
-
1493
-
1494
- # Primitives.
1495
- # Draws the solid quadrangle (face) with vertexes p1, p2, p3, p4 and with color(s) stl. At this colors can be the same for all vertexes or different if all 4 colors are specified for each vertex. Face will be drawn even if it lies out of bounding box.
1496
- #
1497
- # @overload face(p1,p2,p3,p4,stl="w")
1498
- # @param [MglPoint] p1
1499
- # @param [MglPoint] p2
1500
- # @param [MglPoint] p3
1501
- # @param [MglPoint] p4
1502
- # @param [String] stl default="w"
1503
- # @return [nil]
1504
- def face
1505
- end
1506
-
1507
-
1508
- # Primitives.
1509
- # Draws the solid rectangle (face) perpendicular to (x,y,z)-axis correspondingly at position (x0, y0, z0) with color stl and with widths wx, wy, wz along corresponding directions. At this colors can be the same for all vertexes or separately if all 4 colors are specified for each vertex. Parameters d1!=0, d2!=0 set additional shift of the last vertex (i.e. to draw quadrangle). Face will be drawn even if it lies out of bounding box.
1510
- #
1511
- # @overload face_x(x0,y0,z0,wy,wz,stl="w",d1=0,d2=0)
1512
- # @param [Float] x0
1513
- # @param [Float] y0
1514
- # @param [Float] z0
1515
- # @param [Float] wy
1516
- # @param [Float] wz
1517
- # @param [String] stl default="w"
1518
- # @param [Float] d1 default=0
1519
- # @param [Float] d2 default=0
1520
- # @return [nil]
1521
- def face_x
1522
- end
1523
-
1524
-
1525
- # Primitives.
1526
- # Draws the solid rectangle (face) perpendicular to (x,y,z)-axis correspondingly at position (x0, y0, z0) with color stl and with widths wx, wy, wz along corresponding directions. At this colors can be the same for all vertexes or separately if all 4 colors are specified for each vertex. Parameters d1!=0, d2!=0 set additional shift of the last vertex (i.e. to draw quadrangle). Face will be drawn even if it lies out of bounding box.
1527
- #
1528
- # @overload face_y(x0,y0,z0,wx,wz,stl="w",d1=0,d2=0)
1529
- # @param [Float] x0
1530
- # @param [Float] y0
1531
- # @param [Float] z0
1532
- # @param [Float] wx
1533
- # @param [Float] wz
1534
- # @param [String] stl default="w"
1535
- # @param [Float] d1 default=0
1536
- # @param [Float] d2 default=0
1537
- # @return [nil]
1538
- def face_y
1539
- end
1540
-
1541
-
1542
- # Primitives.
1543
- # Draws the solid rectangle (face) perpendicular to (x,y,z)-axis correspondingly at position (x0, y0, z0) with color stl and with widths wx, wy, wz along corresponding directions. At this colors can be the same for all vertexes or separately if all 4 colors are specified for each vertex. Parameters d1!=0, d2!=0 set additional shift of the last vertex (i.e. to draw quadrangle). Face will be drawn even if it lies out of bounding box.
1544
- #
1545
- # @overload face_z(x0,y0,z0,wx,wy,stl="w",d1=0,d2=0)
1546
- # @param [Float] x0
1547
- # @param [Float] y0
1548
- # @param [Float] z0
1549
- # @param [Float] wx
1550
- # @param [Float] wy
1551
- # @param [String] stl default="w"
1552
- # @param [Float] d1 default=0
1553
- # @param [Float] d2 default=0
1554
- # @return [nil]
1555
- def face_z
1556
- end
1557
-
1558
-
1559
- # Primitives.
1560
- # Draw the sphere with radius r and center at point p=(x0, y0, z0) and color stl.
1561
- #
1562
- # @overload sphere(p,r,stl="r")
1563
- # @param [MglPoint] p
1564
- # @param [Float] r
1565
- # @param [String] stl default="r"
1566
- # @return [nil]
1567
- def sphere
1568
- end
1569
-
1570
-
1571
- # Primitives.
1572
- # Draw the drop with radius r at point p elongated in direction d and with color col. Parameter shift set the degree of drop oblongness: '0' is sphere, '1' is maximally oblongness drop. Parameter ap set relative width of the drop (this is analogue of ``ellipticity'' for the sphere).
1573
- #
1574
- # @overload drop(p,d,r,col="r",shift=1,ap=1)
1575
- # @param [MglPoint] p
1576
- # @param [MglPoint] d
1577
- # @param [Float] r
1578
- # @param [String] col default="r"
1579
- # @param [Float] shift default=1
1580
- # @param [Float] ap default=1
1581
- # @return [nil]
1582
- def drop
1583
- end
1584
-
1585
-
1586
- # Primitives.
1587
- # Draw tube (or truncated cone if edge=false) between points p1, p2 with radius at the edges r1, r2. If r2<0 then it is supposed that r2=r1. The cone color is defined by string stl. If style contain '@' then edges will be drawn.
1588
- #
1589
- # @overload cone(p1,p2,r1,r2=-1,stl="B")
1590
- # @param [MglPoint] p1
1591
- # @param [MglPoint] p2
1592
- # @param [Float] r1
1593
- # @param [Float] r2 default=-1
1594
- # @param [String] stl default="B"
1595
- # @return [nil]
1596
- def cone
1597
- end
1598
-
1599
-
1600
- # Primitives.
1601
- # Draw the circle with radius r and center at point p=(x0, y0, z0). Parameter col may contain
1602
- #
1603
- # @overload circle(p,r,stl="r")
1604
- # @param [MglPoint] p
1605
- # @param [Float] r
1606
- # @param [String] stl default="r"
1607
- # @return [nil]
1608
- def circle
1609
- end
1610
-
1611
-
1612
- # Primitives.
1613
- # Draw the ellipse with radius r and focal points p1, p2. Parameter col may contain
1614
- #
1615
- # @overload ellipse(p1,p2,r,col="r")
1616
- # @param [MglPoint] p1
1617
- # @param [MglPoint] p2
1618
- # @param [Float] r
1619
- # @param [String] col default="r"
1620
- # @return [nil]
1621
- def ellipse
1622
- end
1623
-
1624
-
1625
- # Primitives.
1626
- # Draw the rhombus with width r and edge points p1, p2. Parameter col may contain
1627
- #
1628
- # @overload rhomb(p1,p2,r,col="r")
1629
- # @param [MglPoint] p1
1630
- # @param [MglPoint] p2
1631
- # @param [Float] r
1632
- # @param [String] col default="r"
1633
- # @return [nil]
1634
- def rhomb
1635
- end
1636
-
1637
-
1638
- # Text printing.
1639
- # The function plots the string text at position p with fonts specifying by the criteria fnt. The size of font is set by size parameter (default is -1).
1640
- #
1641
- # @overload puts(p,text,fnt=":C",size=-1)
1642
- # @param [MglPoint] p
1643
- # @param [String] text
1644
- # @param [String] fnt default=":C"
1645
- # @param [Float] size default=-1
1646
- # @return [nil]
1647
- #
1648
- # @overload puts(x,y,text,fnt=":AC",size=-1)
1649
- # @param [Float] x
1650
- # @param [Float] y
1651
- # @param [String] text
1652
- # @param [String] fnt default=":AC"
1653
- # @param [Float] size default=-1
1654
- # @return [nil]
1655
- def puts
1656
- end
1657
-
1658
-
1659
- # Text printing.
1660
- # The function plots the string text at position p along direction d with specified size. Parameter fnt set text style and text position: above ('T') or under ('t') the line.
1661
- #
1662
- # @overload puts(p,d,text,fnt=":L",size=-1)
1663
- # @param [MglPoint] p
1664
- # @param [MglPoint] d
1665
- # @param [String] text
1666
- # @param [String] fnt default=":L"
1667
- # @param [Float] size default=-1
1668
- # @return [nil]
1669
- def puts
1670
- end
1671
-
1672
-
1673
- # Text printing.
1674
- # The function draws text along the curve between points (x(i), y(i), z(i)) by font style fnt. The string fnt may contain symbols 't' for printing the text under the curve (default), or 'T' for printing the text above the curve. The sizes of 1st dimension must be equal for all arrays x.nx=y.nx=z.nx. If array x is not specified then its an automatic array is used with values equidistantly distributed in interval (Min.x, Max.x) (see Ranges (bounding box)). If array z is not specified then z(i) = Min.z is used. String opt contain command options (see Command options).
1675
- #
1676
- # @overload text(y,text,fnt="",opt="")
1677
- # @param [MglData] y
1678
- # @param [String] text
1679
- # @param [String] fnt default=""
1680
- # @param [String] opt default=""
1681
- # @return [nil]
1682
- #
1683
- # @overload text(x,y,text,fnt="",opt="")
1684
- # @param [MglData] x
1685
- # @param [MglData] y
1686
- # @param [String] text
1687
- # @param [String] fnt default=""
1688
- # @param [String] opt default=""
1689
- # @return [nil]
1690
- #
1691
- # @overload text(x,y,z,text,fnt="",opt="")
1692
- # @param [MglData] x
1693
- # @param [MglData] y
1694
- # @param [MglData] z
1695
- # @param [String] text
1696
- # @param [String] fnt default=""
1697
- # @param [String] opt default=""
1698
- # @return [nil]
1699
- def text
1700
- end
1701
-
1702
-
1703
- # Axis and Colorbar.
1704
- # Draws axes with ticks (see Axis settings). Parameter dir may contain:
1705
- # Styles of ticks and axis can be overrided by using stl string. Axis and ticks
1706
- #
1707
- # @overload axis(dir="xyz",stl="",opt="")
1708
- # @param [String] dir default="xyz"
1709
- # @param [String] stl default=""
1710
- # @param [String] opt default=""
1711
- # @return [nil]
1712
- def axis
1713
- end
1714
-
1715
-
1716
- # Axis and Colorbar.
1717
- # Draws colorbar. Parameter sch may contain:
1718
- # Colorbars
1719
- #
1720
- # @overload colorbar(sch="")
1721
- # @param [String] sch default=""
1722
- # @return [nil]
1723
- def colorbar
1724
- end
1725
-
1726
-
1727
- # Axis and Colorbar.
1728
- # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1729
- #
1730
- # @overload colorbar(v,sch="")
1731
- # @param [MglData] v
1732
- # @param [String] sch default=""
1733
- # @return [nil]
1734
- def colorbar
1735
- end
1736
-
1737
-
1738
- # Axis and Colorbar.
1739
- # The same as first one but at arbitrary position of subplot (x, y) (supposed to be in range (0,1)). Parameters w, h set the relative width and height of the colorbar.
1740
- #
1741
- # @overload colorbar(sch,x,y,w=1,h=1)
1742
- # @param [String] sch
1743
- # @param [Float] x
1744
- # @param [Float] y
1745
- # @param [Float] w default=1
1746
- # @param [Float] h default=1
1747
- # @return [nil]
1748
- def colorbar
1749
- end
1750
-
1751
-
1752
- # Axis and Colorbar.
1753
- # The same as previous but with sharp colors sch (current palette if sch="") for values v. ContD sample
1754
- #
1755
- # @overload colorbar(v,sch,x,y,w=1,h=1)
1756
- # @param [MglData] v
1757
- # @param [String] sch
1758
- # @param [Float] x
1759
- # @param [Float] y
1760
- # @param [Float] w default=1
1761
- # @param [Float] h default=1
1762
- # @return [nil]
1763
- def colorbar
1764
- end
1765
-
1766
-
1767
- # Axis and Colorbar.
1768
- # Draws grid lines perpendicular to direction determined by string parameter dir. The step of grid lines is the same as tick step for axis. The style of lines is determined by pen parameter (default value is dark blue solid line 'B-').
1769
- #
1770
- # @overload grid(dir="xyz",pen="B",opt="")
1771
- # @param [String] dir default="xyz"
1772
- # @param [String] pen default="B"
1773
- # @param [String] opt default=""
1774
- # @return [nil]
1775
- def grid
1776
- end
1777
-
1778
-
1779
- # Axis and Colorbar.
1780
- # Draws bounding box outside the plotting volume with color col. If col contain '@' then filled faces are drawn. At this first color is used for faces (default is light yellow), last one for edges. Bounding box
1781
- #
1782
- # @overload box(col="",ticks=true)
1783
- # @param [String] col default=""
1784
- # @param [bool] ticks default=true
1785
- # @return [nil]
1786
- def box
1787
- end
1788
-
1789
-
1790
- # Axis and Colorbar.
1791
- # Prints the label text for axis dir='x','y','z','t' (here 't' is ``ternary'' axis t=1-x-y). The position of label is determined by pos parameter. If pos=0 then label is printed at the center of axis. If pos>0 then label is printed at the maximum of axis. If pos<0 then label is printed at the minimum of axis. Value option set additional shifting of the label. Text printing.
1792
- #
1793
- # @overload label(dir,text,pos=1,opt="")
1794
- # @param [String] dir
1795
- # @param [String] text
1796
- # @param [Float] pos default=1
1797
- # @param [String] opt default=""
1798
- # @return [nil]
1799
- def label
1800
- end
1801
-
1802
-
1803
- # Legend.
1804
- # Draws legend of accumulated legend entries by font fnt with size. Parameter pos sets the position of the legend: '0' is bottom left corner, '1' is bottom right corner, '2' is top left corner, '3' is top right corner (is default). Parameter fnt can contain colors for face (1st one), for border (2nd one) and for text (last one). If less than 3 colors are specified then the color for border is black (for 2 and less colors), and the color for face is white (for 1 or none colors). If string fnt contain '#' then border around the legend is drawn. If string fnt contain '-' then legend entries will arranged horizontally.
1805
- #
1806
- # @overload legend(pos=0x3,fnt="#",opt="")
1807
- # @param [Integer] pos default=0x3
1808
- # @param [String] fnt default="#"
1809
- # @param [String] opt default=""
1810
- # @return [nil]
1811
- def legend
1812
- end
1813
-
1814
-
1815
- # Legend.
1816
- # Draws legend of accumulated legend entries by font fnt with size. Position of legend is determined by parameter x, y which supposed to be normalized to interval (0,1).
1817
- #
1818
- # @overload legend(x,y,fnt="#",opt="")
1819
- # @param [Float] x
1820
- # @param [Float] y
1821
- # @param [String] fnt default="#"
1822
- # @param [String] opt default=""
1823
- # @return [nil]
1824
- def legend
1825
- end
1826
-
1827
-
1828
- # Legend.
1829
- # Adds string text to internal legend accumulator. The style of described line and mark is specified in string style (see Line styles).
1830
- #
1831
- # @overload add_legend(text,style)
1832
- # @param [String] text
1833
- # @param [String] style
1834
- # @return [nil]
1835
- def add_legend
1836
- end
1837
-
1838
-
1839
- # Legend.
1840
- # Clears saved legend strings.
1841
- #
1842
- # @overload clear_legend()
1843
- # @return [nil]
1844
- def clear_legend
1845
- end
1846
-
1847
-
1848
- # Legend.
1849
- # Set the number of marks in the legend. By default 1 mark is used.
1850
- #
1851
- # @overload set_legend_marks(num)
1852
- # @param [Integer] num
1853
- # @return [nil]
1854
- def set_legend_marks
1855
- end
1856
-
1857
-
1858
- # 1D plotting.
1859
- # These functions draw continuous lines between points (x(i), y(i), z(i)). See also area, step, stem, tube, mark, error, belt, tens, tape. Plot sample
1860
- #
1861
- # @overload plot(y,pen="",opt="")
1862
- # @param [MglData] y
1863
- # @param [String] pen default=""
1864
- # @param [String] opt default=""
1865
- # @return [nil]
1866
- #
1867
- # @overload plot(x,y,pen="",opt="")
1868
- # @param [MglData] x
1869
- # @param [MglData] y
1870
- # @param [String] pen default=""
1871
- # @param [String] opt default=""
1872
- # @return [nil]
1873
- #
1874
- # @overload plot(x,y,z,pen="",opt="")
1875
- # @param [MglData] x
1876
- # @param [MglData] y
1877
- # @param [MglData] z
1878
- # @param [String] pen default=""
1879
- # @param [String] opt default=""
1880
- # @return [nil]
1881
- def plot
1882
- end
1883
-
1884
-
1885
- # 1D plotting.
1886
- # This functions draws radar chart which is continuous lines between points located on an radial lines (like plot in Polar coordinates). Parameter value in options opt set the additional shift of data (i.e. the data a+value is used instead of a). If value<0 then r=max(0, -min(value). If pen containt '#' symbol then "grid" (radial lines and circle for r) is drawn. See also plot. Radar sample
1887
- #
1888
- # @overload radar(a,pen="",opt="")
1889
- # @param [MglData] a
1890
- # @param [String] pen default=""
1891
- # @param [String] opt default=""
1892
- # @return [nil]
1893
- def radar
1894
- end
1895
-
1896
-
1897
- # 1D plotting.
1898
- # These functions draw continuous stairs for points to axis plane. See also plot, stem, tile, boxs. Step sample
1899
- #
1900
- # @overload step(y,pen="",opt="")
1901
- # @param [MglData] y
1902
- # @param [String] pen default=""
1903
- # @param [String] opt default=""
1904
- # @return [nil]
1905
- #
1906
- # @overload step(x,y,pen="",opt="")
1907
- # @param [MglData] x
1908
- # @param [MglData] y
1909
- # @param [String] pen default=""
1910
- # @param [String] opt default=""
1911
- # @return [nil]
1912
- #
1913
- # @overload step(x,y,z,pen="",opt="")
1914
- # @param [MglData] x
1915
- # @param [MglData] y
1916
- # @param [MglData] z
1917
- # @param [String] pen default=""
1918
- # @param [String] opt default=""
1919
- # @return [nil]
1920
- def step
1921
- end
1922
-
1923
-
1924
- # 1D plotting.
1925
- # These functions draw continuous lines between points (x(i), y(i), z(i)) with color defined by the special array c(i) (look like tension plot). String pen specifies the color scheme (see Color scheme) and style and/or width of line (see Line styles). See also plot, mesh, fall. Tens sample
1926
- #
1927
- # @overload tens(y,c,pen="",opt="")
1928
- # @param [MglData] y
1929
- # @param [MglData] c
1930
- # @param [String] pen default=""
1931
- # @param [String] opt default=""
1932
- # @return [nil]
1933
- #
1934
- # @overload tens(x,y,c,pen="",opt="")
1935
- # @param [MglData] x
1936
- # @param [MglData] y
1937
- # @param [MglData] c
1938
- # @param [String] pen default=""
1939
- # @param [String] opt default=""
1940
- # @return [nil]
1941
- #
1942
- # @overload tens(x,y,z,c,pen="",opt="")
1943
- # @param [MglData] x
1944
- # @param [MglData] y
1945
- # @param [MglData] z
1946
- # @param [MglData] c
1947
- # @param [String] pen default=""
1948
- # @param [String] opt default=""
1949
- # @return [nil]
1950
- def tens
1951
- end
1952
-
1953
-
1954
- # 1D plotting.
1955
- # These functions draw tapes of normals for curve between points (x(i), y(i), z(i)). Initial tape(s) was selected in x-y plane (for 'x' in pen) and/or y-z plane (for 'x' in pen). The width of tape is proportional to barwidth. See also plot, flow, barwidth. Tape sample
1956
- #
1957
- # @overload tape(y,pen="",opt="")
1958
- # @param [MglData] y
1959
- # @param [String] pen default=""
1960
- # @param [String] opt default=""
1961
- # @return [nil]
1962
- #
1963
- # @overload tape(x,y,pen="",opt="")
1964
- # @param [MglData] x
1965
- # @param [MglData] y
1966
- # @param [String] pen default=""
1967
- # @param [String] opt default=""
1968
- # @return [nil]
1969
- #
1970
- # @overload tape(x,y,z,pen="",opt="")
1971
- # @param [MglData] x
1972
- # @param [MglData] y
1973
- # @param [MglData] z
1974
- # @param [String] pen default=""
1975
- # @param [String] opt default=""
1976
- # @return [nil]
1977
- def tape
1978
- end
1979
-
1980
-
1981
- # 1D plotting.
1982
- # These functions draw continuous lines between points and fills it to axis plane. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. See also plot, bars, stem, region. Area sample
1983
- #
1984
- # @overload area(y,pen="",opt="")
1985
- # @param [MglData] y
1986
- # @param [String] pen default=""
1987
- # @param [String] opt default=""
1988
- # @return [nil]
1989
- #
1990
- # @overload area(x,y,pen="",opt="")
1991
- # @param [MglData] x
1992
- # @param [MglData] y
1993
- # @param [String] pen default=""
1994
- # @param [String] opt default=""
1995
- # @return [nil]
1996
- #
1997
- # @overload area(x,y,z,pen="",opt="")
1998
- # @param [MglData] x
1999
- # @param [MglData] y
2000
- # @param [MglData] z
2001
- # @param [String] pen default=""
2002
- # @param [String] opt default=""
2003
- # @return [nil]
2004
- def area
2005
- end
2006
-
2007
-
2008
- # 1D plotting.
2009
- # These functions fill area between 2 curves. Dimensions of arrays y1 and y2 must be equal. Also you can use gradient filling if number of specified colors is equal to 2*number of curves. If pen contain symbol 'i' then only area with y1<y<y2 will be filled else the area with y2<y<y1 will be filled too. See also area, bars, stem. Region sample
2010
- #
2011
- # @overload region(y1,y2,pen="",opt="")
2012
- # @param [MglData] y1
2013
- # @param [MglData] y2
2014
- # @param [String] pen default=""
2015
- # @param [String] opt default=""
2016
- # @return [nil]
2017
- #
2018
- # @overload region(x,y1,y2,pen="",opt="")
2019
- # @param [MglData] x
2020
- # @param [MglData] y1
2021
- # @param [MglData] y2
2022
- # @param [String] pen default=""
2023
- # @param [String] opt default=""
2024
- # @return [nil]
2025
- def region
2026
- end
2027
-
2028
-
2029
- # 1D plotting.
2030
- # These functions draw vertical lines from points to axis plane. See also area, bars, plot, mark. Stem sample
2031
- #
2032
- # @overload stem(y,pen="",opt="")
2033
- # @param [MglData] y
2034
- # @param [String] pen default=""
2035
- # @param [String] opt default=""
2036
- # @return [nil]
2037
- #
2038
- # @overload stem(x,y,pen="",opt="")
2039
- # @param [MglData] x
2040
- # @param [MglData] y
2041
- # @param [String] pen default=""
2042
- # @param [String] opt default=""
2043
- # @return [nil]
2044
- #
2045
- # @overload stem(x,y,z,pen="",opt="")
2046
- # @param [MglData] x
2047
- # @param [MglData] y
2048
- # @param [MglData] z
2049
- # @param [String] pen default=""
2050
- # @param [String] opt default=""
2051
- # @return [nil]
2052
- def stem
2053
- end
2054
-
2055
-
2056
- # 1D plotting.
2057
- # These functions draw vertical bars from points to axis plane. If string pen contain symbol 'a' then lines are drawn one above another (like summation). If string contain symbol 'f' then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also barh, cones, area, stem, chart, barwidth. Bars sample
2058
- #
2059
- # @overload bars(y,pen="",opt="")
2060
- # @param [MglData] y
2061
- # @param [String] pen default=""
2062
- # @param [String] opt default=""
2063
- # @return [nil]
2064
- #
2065
- # @overload bars(x,y,pen="",opt="")
2066
- # @param [MglData] x
2067
- # @param [MglData] y
2068
- # @param [String] pen default=""
2069
- # @param [String] opt default=""
2070
- # @return [nil]
2071
- #
2072
- # @overload bars(x,y,z,pen="",opt="")
2073
- # @param [MglData] x
2074
- # @param [MglData] y
2075
- # @param [MglData] z
2076
- # @param [String] pen default=""
2077
- # @param [String] opt default=""
2078
- # @return [nil]
2079
- def bars
2080
- end
2081
-
2082
-
2083
- # 1D plotting.
2084
- # These functions draw horizontal bars from points to axis plane. If string contain symbol 'a' then lines are drawn one above another (like summation). If string contain symbol 'f' then waterfall chart is drawn for determining the cumulative effect of sequentially introduced positive or negative values. You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth. Barh sample
2085
- #
2086
- # @overload barh(v,pen="",opt="")
2087
- # @param [MglData] v
2088
- # @param [String] pen default=""
2089
- # @param [String] opt default=""
2090
- # @return [nil]
2091
- #
2092
- # @overload barh(y,v,pen="",opt="")
2093
- # @param [MglData] y
2094
- # @param [MglData] v
2095
- # @param [String] pen default=""
2096
- # @param [String] opt default=""
2097
- # @return [nil]
2098
- def barh
2099
- end
2100
-
2101
-
2102
- # 1D plotting.
2103
- # These functions draw cones from points to axis plane. If string contain symbol 'a' then cones are drawn one above another (like summation). You can give different colors for positive and negative values if number of specified colors is equal to 2*number of curves. See also bars, barwidth. Cones sample
2104
- #
2105
- # @overload cones(y,pen="",opt="")
2106
- # @param [MglData] y
2107
- # @param [String] pen default=""
2108
- # @param [String] opt default=""
2109
- # @return [nil]
2110
- #
2111
- # @overload cones(x,y,pen="",opt="")
2112
- # @param [MglData] x
2113
- # @param [MglData] y
2114
- # @param [String] pen default=""
2115
- # @param [String] opt default=""
2116
- # @return [nil]
2117
- #
2118
- # @overload cones(x,y,z,pen="",opt="")
2119
- # @param [MglData] x
2120
- # @param [MglData] y
2121
- # @param [MglData] z
2122
- # @param [String] pen default=""
2123
- # @param [String] opt default=""
2124
- # @return [nil]
2125
- def cones
2126
- end
2127
-
2128
-
2129
- # 1D plotting.
2130
- # The function draws colored stripes (boxes) for data in array a. The number of stripes is equal to the number of rows in a (equal to a.ny). The color of each next stripe is cyclically changed from colors specified in string col or in palette Pal (see Palette and colors). Spaces in colors denote transparent ``color'' (i.e. corresponding stripe(s) are not drawn). The stripe width is proportional to value of element in a. Chart is plotted only for data with non-negative elements. If string col have symbol '#' then black border lines are drawn. The most nice form the chart have in 3d (after rotation of coordinates) or in cylindrical coordinates (becomes so called Pie chart). Chart sample
2131
- #
2132
- # @overload chart(a,col="",opt="")
2133
- # @param [MglData] a
2134
- # @param [String] col default=""
2135
- # @param [String] opt default=""
2136
- # @return [nil]
2137
- def chart
2138
- end
2139
-
2140
-
2141
- # 1D plotting.
2142
- # These functions draw boxplot (also known as a box-and-whisker diagram) at points x(i). This is five-number summaries of data a(i,j) (minimum, lower quartile (Q1), median (Q2), upper quartile (Q3) and maximum) along second (j-th) direction. See also plot, error, bars, barwidth. BoxPlot sample
2143
- #
2144
- # @overload box_plot(a,pen="",opt="")
2145
- # @param [MglData] a
2146
- # @param [String] pen default=""
2147
- # @param [String] opt default=""
2148
- # @return [nil]
2149
- #
2150
- # @overload box_plot(x,a,pen="",opt="")
2151
- # @param [MglData] x
2152
- # @param [MglData] a
2153
- # @param [String] pen default=""
2154
- # @param [String] opt default=""
2155
- # @return [nil]
2156
- def box_plot
2157
- end
2158
-
2159
-
2160
- # 1D plotting.
2161
- # These functions draw candlestick chart at points x(i). This is a combination of a line-chart and a bar-chart, in that each bar represents the range of price movement over a given time interval. Wire (or white) candle correspond to price growth v1(i)<v2(i), opposite case -- solid (or dark) candle. "Shadows" show the minimal y1 and maximal y2 prices. If v2 is absent then it is determined as v2(i)=v1(i+1). See also plot, bars, barwidth. Candle sample
2162
- #
2163
- # @overload candle(v1,pen="",opt="")
2164
- # @param [MglData] v1
2165
- # @param [String] pen default=""
2166
- # @param [String] opt default=""
2167
- # @return [nil]
2168
- #
2169
- # @overload candle(v1,v2,pen="",opt="")
2170
- # @param [MglData] v1
2171
- # @param [MglData] v2
2172
- # @param [String] pen default=""
2173
- # @param [String] opt default=""
2174
- # @return [nil]
2175
- #
2176
- # @overload candle(v1,y1,y2,pen="",opt="")
2177
- # @param [MglData] v1
2178
- # @param [MglData] y1
2179
- # @param [MglData] y2
2180
- # @param [String] pen default=""
2181
- # @param [String] opt default=""
2182
- # @return [nil]
2183
- #
2184
- # @overload candle(v1,v2,y1,y2,pen="",opt="")
2185
- # @param [MglData] v1
2186
- # @param [MglData] v2
2187
- # @param [MglData] y1
2188
- # @param [MglData] y2
2189
- # @param [String] pen default=""
2190
- # @param [String] opt default=""
2191
- # @return [nil]
2192
- #
2193
- # @overload candle(x,v1,v2,y1,y2,pen="",opt="")
2194
- # @param [MglData] x
2195
- # @param [MglData] v1
2196
- # @param [MglData] v2
2197
- # @param [MglData] y1
2198
- # @param [MglData] y2
2199
- # @param [String] pen default=""
2200
- # @param [String] opt default=""
2201
- # @return [nil]
2202
- def candle
2203
- end
2204
-
2205
-
2206
- # 1D plotting.
2207
- # These functions draw error boxes (ex(i), ey(i)) at points (x(i), y(i)). This can be useful, for example, in experimental points, or to show numeric error or some estimations and so on. If string pen contain symbol '@' than large semitransparent mark is used instead of error box. See also plot, mark. Error sample
2208
- #
2209
- # @overload error(y,ey,pen="",opt="")
2210
- # @param [MglData] y
2211
- # @param [MglData] ey
2212
- # @param [String] pen default=""
2213
- # @param [String] opt default=""
2214
- # @return [nil]
2215
- #
2216
- # @overload error(x,y,ey,pen="",opt="")
2217
- # @param [MglData] x
2218
- # @param [MglData] y
2219
- # @param [MglData] ey
2220
- # @param [String] pen default=""
2221
- # @param [String] opt default=""
2222
- # @return [nil]
2223
- #
2224
- # @overload error(x,y,ex,ey,pen="",opt="")
2225
- # @param [MglData] x
2226
- # @param [MglData] y
2227
- # @param [MglData] ex
2228
- # @param [MglData] ey
2229
- # @param [String] pen default=""
2230
- # @param [String] opt default=""
2231
- # @return [nil]
2232
- def error
2233
- end
2234
-
2235
-
2236
- # 1D plotting.
2237
- # These functions draw marks with size r(i)*marksize at points (x(i), y(i), z(i)). If you need to draw markers of the same size then you can use plot function with empty line style ' '. For markers with size in axis range use error with style '@'. See also plot, textmark, error, stem. Mark sample
2238
- #
2239
- # @overload mark(y,r,pen="",opt="")
2240
- # @param [MglData] y
2241
- # @param [MglData] r
2242
- # @param [String] pen default=""
2243
- # @param [String] opt default=""
2244
- # @return [nil]
2245
- #
2246
- # @overload mark(x,y,r,pen="",opt="")
2247
- # @param [MglData] x
2248
- # @param [MglData] y
2249
- # @param [MglData] r
2250
- # @param [String] pen default=""
2251
- # @param [String] opt default=""
2252
- # @return [nil]
2253
- #
2254
- # @overload mark(x,y,z,r,pen="",opt="")
2255
- # @param [MglData] x
2256
- # @param [MglData] y
2257
- # @param [MglData] z
2258
- # @param [MglData] r
2259
- # @param [String] pen default=""
2260
- # @param [String] opt default=""
2261
- # @return [nil]
2262
- def mark
2263
- end
2264
-
2265
-
2266
- # 1D plotting.
2267
- # These functions draw string txt as marks with size proportional to r(i)*marksize at points (x(i), y(i), z(i)). By default (if omitted) r(i)=1. See also plot, mark, stem. TextMark sample
2268
- #
2269
- # @overload text_mark(y,txt,fnt="",opt="")
2270
- # @param [MglData] y
2271
- # @param [String] txt
2272
- # @param [String] fnt default=""
2273
- # @param [String] opt default=""
2274
- # @return [nil]
2275
- #
2276
- # @overload text_mark(y,r,txt,fnt="",opt="")
2277
- # @param [MglData] y
2278
- # @param [MglData] r
2279
- # @param [String] txt
2280
- # @param [String] fnt default=""
2281
- # @param [String] opt default=""
2282
- # @return [nil]
2283
- #
2284
- # @overload text_mark(x,y,r,txt,fnt="",opt="")
2285
- # @param [MglData] x
2286
- # @param [MglData] y
2287
- # @param [MglData] r
2288
- # @param [String] txt
2289
- # @param [String] fnt default=""
2290
- # @param [String] opt default=""
2291
- # @return [nil]
2292
- #
2293
- # @overload text_mark(x,y,z,r,txt,fnt="",opt="")
2294
- # @param [MglData] x
2295
- # @param [MglData] y
2296
- # @param [MglData] z
2297
- # @param [MglData] r
2298
- # @param [String] txt
2299
- # @param [String] fnt default=""
2300
- # @param [String] opt default=""
2301
- # @return [nil]
2302
- def text_mark
2303
- end
2304
-
2305
-
2306
- # 1D plotting.
2307
- # These functions draw string txt at points (x(i), y(i), z(i)). If string txt contain '%x', '%y', '%z' or '%n' then it will be replaced by the value of x-,y-,z-coordinate of the point or its index. See also plot, mark, textmark, table. Label sample
2308
- #
2309
- # @overload label(y,txt,fnt="",opt="")
2310
- # @param [MglData] y
2311
- # @param [String] txt
2312
- # @param [String] fnt default=""
2313
- # @param [String] opt default=""
2314
- # @return [nil]
2315
- #
2316
- # @overload label(x,y,txt,fnt="",opt="")
2317
- # @param [MglData] x
2318
- # @param [MglData] y
2319
- # @param [String] txt
2320
- # @param [String] fnt default=""
2321
- # @param [String] opt default=""
2322
- # @return [nil]
2323
- #
2324
- # @overload label(x,y,z,txt,fnt="",opt="")
2325
- # @param [MglData] x
2326
- # @param [MglData] y
2327
- # @param [MglData] z
2328
- # @param [String] txt
2329
- # @param [String] fnt default=""
2330
- # @param [String] opt default=""
2331
- # @return [nil]
2332
- def label
2333
- end
2334
-
2335
-
2336
- # 1D plotting.
2337
- # These functions draw table with values of val and captions from string txt (separated by newline symbol '\n') at points (x, y) (default at (0,0)) related to current subplot. If string fnt contain '#' then cell border will be drawn. If string fnt contain '|' then table width is limited by subplot width (equivalent option 'value 1'). If string fnt contain '=' then widths of all cells are the same. Option value set the width of the table (default is 1). See also plot, label. Table sample
2338
- #
2339
- # @overload table(val,txt,fnt="",opt="")
2340
- # @param [MglData] val
2341
- # @param [String] txt
2342
- # @param [String] fnt default=""
2343
- # @param [String] opt default=""
2344
- # @return [nil]
2345
- #
2346
- # @overload table(x,y,val,txt,fnt="",opt="")
2347
- # @param [Float] x
2348
- # @param [Float] y
2349
- # @param [MglData] val
2350
- # @param [String] txt
2351
- # @param [String] fnt default=""
2352
- # @param [String] opt default=""
2353
- # @return [nil]
2354
- def table
2355
- end
2356
-
2357
-
2358
- # 1D plotting.
2359
- # These functions draw the tube with variable radius r(i) along the curve between points (x(i), y(i), z(i)). See also plot. Tube sample
2360
- #
2361
- # @overload tube(y,r,pen="",opt="")
2362
- # @param [MglData] y
2363
- # @param [MglData] r
2364
- # @param [String] pen default=""
2365
- # @param [String] opt default=""
2366
- # @return [nil]
2367
- #
2368
- # @overload tube(y,r,pen="",opt="")
2369
- # @param [MglData] y
2370
- # @param [Float] r
2371
- # @param [String] pen default=""
2372
- # @param [String] opt default=""
2373
- # @return [nil]
2374
- #
2375
- # @overload tube(x,y,r,pen="",opt="")
2376
- # @param [MglData] x
2377
- # @param [MglData] y
2378
- # @param [MglData] r
2379
- # @param [String] pen default=""
2380
- # @param [String] opt default=""
2381
- # @return [nil]
2382
- #
2383
- # @overload tube(x,y,r,pen="",opt="")
2384
- # @param [MglData] x
2385
- # @param [MglData] y
2386
- # @param [Float] r
2387
- # @param [String] pen default=""
2388
- # @param [String] opt default=""
2389
- # @return [nil]
2390
- #
2391
- # @overload tube(x,y,z,r,pen="",opt="")
2392
- # @param [MglData] x
2393
- # @param [MglData] y
2394
- # @param [MglData] z
2395
- # @param [MglData] r
2396
- # @param [String] pen default=""
2397
- # @param [String] opt default=""
2398
- # @return [nil]
2399
- #
2400
- # @overload tube(x,y,z,r,pen="",opt="")
2401
- # @param [MglData] x
2402
- # @param [MglData] y
2403
- # @param [MglData] z
2404
- # @param [Float] r
2405
- # @param [String] pen default=""
2406
- # @param [String] opt default=""
2407
- # @return [nil]
2408
- def tube
2409
- end
2410
-
2411
-
2412
- # 1D plotting.
2413
- # These functions draw surface which is result of curve (r, z) rotation around axis. If string pen contain symbols 'x' or 'z' then rotation axis will be set to specified direction (default is 'y'). If string pen have symbol '#' then wire plot is produced. If string pen have symbol '.' then plot by dots is produced. See also plot, axial. Torus sample
2414
- #
2415
- # @overload torus(r,z,pen="",opt="")
2416
- # @param [MglData] r
2417
- # @param [MglData] z
2418
- # @param [String] pen default=""
2419
- # @param [String] opt default=""
2420
- # @return [nil]
2421
- def torus
2422
- end
2423
-
2424
-
2425
- # 2D plotting.
2426
- # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. See also mesh, dens, belt, tile, boxs, surfc, surfa. Surf sample
2427
- #
2428
- # @overload surf(z,sch="",opt="")
2429
- # @param [MglData] z
2430
- # @param [String] sch default=""
2431
- # @param [String] opt default=""
2432
- # @return [nil]
2433
- #
2434
- # @overload surf(x,y,z,sch="",opt="")
2435
- # @param [MglData] x
2436
- # @param [MglData] y
2437
- # @param [MglData] z
2438
- # @param [String] sch default=""
2439
- # @param [String] opt default=""
2440
- # @return [nil]
2441
- def surf
2442
- end
2443
-
2444
-
2445
- # 2D plotting.
2446
- # The function draws mesh lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)). See also surf, fall, meshnum, cont, tens. Mesh sample
2447
- #
2448
- # @overload mesh(z,sch="",opt="")
2449
- # @param [MglData] z
2450
- # @param [String] sch default=""
2451
- # @param [String] opt default=""
2452
- # @return [nil]
2453
- #
2454
- # @overload mesh(x,y,z,sch="",opt="")
2455
- # @param [MglData] x
2456
- # @param [MglData] y
2457
- # @param [MglData] z
2458
- # @param [String] sch default=""
2459
- # @param [String] opt default=""
2460
- # @return [nil]
2461
- def mesh
2462
- end
2463
-
2464
-
2465
- # 2D plotting.
2466
- # The function draws fall lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)). This plot can be used for plotting several curves shifted in depth one from another. If sch contain 'x' then lines are drawn along x-direction else (by default) lines are drawn along y-direction. See also belt, mesh, tens, meshnum. Fall sample
2467
- #
2468
- # @overload fall(z,sch="",opt="")
2469
- # @param [MglData] z
2470
- # @param [String] sch default=""
2471
- # @param [String] opt default=""
2472
- # @return [nil]
2473
- #
2474
- # @overload fall(x,y,z,sch="",opt="")
2475
- # @param [MglData] x
2476
- # @param [MglData] y
2477
- # @param [MglData] z
2478
- # @param [String] sch default=""
2479
- # @param [String] opt default=""
2480
- # @return [nil]
2481
- def fall
2482
- end
2483
-
2484
-
2485
- # 2D plotting.
2486
- # The function draws belts for surface specified parametrically (x(i,j), y(i,j), z(i,j)). This plot can be used as 3d generalization of plot). If sch contain 'x' then belts are drawn along x-direction else (by default) belts are drawn along y-direction. See also fall, surf, plot, meshnum. Belt sample
2487
- #
2488
- # @overload belt(z,sch="",opt="")
2489
- # @param [MglData] z
2490
- # @param [String] sch default=""
2491
- # @param [String] opt default=""
2492
- # @return [nil]
2493
- #
2494
- # @overload belt(x,y,z,sch="",opt="")
2495
- # @param [MglData] x
2496
- # @param [MglData] y
2497
- # @param [MglData] z
2498
- # @param [String] sch default=""
2499
- # @param [String] opt default=""
2500
- # @return [nil]
2501
- def belt
2502
- end
2503
-
2504
-
2505
- # 2D plotting.
2506
- # The function draws vertical boxes for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Symbol '@' in sch set to draw filled boxes. See also surf, dens, tile, step. Boxs sample
2507
- #
2508
- # @overload boxs(z,sch="",opt="")
2509
- # @param [MglData] z
2510
- # @param [String] sch default=""
2511
- # @param [String] opt default=""
2512
- # @return [nil]
2513
- #
2514
- # @overload boxs(x,y,z,sch="",opt="")
2515
- # @param [MglData] x
2516
- # @param [MglData] y
2517
- # @param [MglData] z
2518
- # @param [String] sch default=""
2519
- # @param [String] opt default=""
2520
- # @return [nil]
2521
- def boxs
2522
- end
2523
-
2524
-
2525
- # 2D plotting.
2526
- # The function draws horizontal tiles for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Such plot can be used as 3d generalization of step. See also surf, boxs, step, tiles. Tile sample
2527
- #
2528
- # @overload tile(z,sch="",opt="")
2529
- # @param [MglData] z
2530
- # @param [String] sch default=""
2531
- # @param [String] opt default=""
2532
- # @return [nil]
2533
- #
2534
- # @overload tile(x,y,z,sch="",opt="")
2535
- # @param [MglData] x
2536
- # @param [MglData] y
2537
- # @param [MglData] z
2538
- # @param [String] sch default=""
2539
- # @param [String] opt default=""
2540
- # @return [nil]
2541
- def tile
2542
- end
2543
-
2544
-
2545
- # 2D plotting.
2546
- # The function draws density plot for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z = Min.z. If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. See also surf, cont, contf, boxs, tile, dens(xyz). Dens sample
2547
- #
2548
- # @overload dens(z,sch="",opt="",zval=NAN)
2549
- # @param [MglData] z
2550
- # @param [String] sch default=""
2551
- # @param [String] opt default=""
2552
- # @param [Float] zval default=NAN
2553
- # @return [nil]
2554
- #
2555
- # @overload dens(x,y,z,sch="",opt="",zval=NAN)
2556
- # @param [MglData] x
2557
- # @param [MglData] y
2558
- # @param [MglData] z
2559
- # @param [String] sch default=""
2560
- # @param [String] opt default=""
2561
- # @param [Float] zval default=NAN
2562
- # @return [nil]
2563
- def dens
2564
- end
2565
-
2566
-
2567
- # 2D plotting.
2568
- # The function draws contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. If string sch have symbol 't' or 'T' then contour labels v(k) will be drawn below (or above) the contours. See also dens, contf, contd, axial, cont(xyz). Cont sample
2569
- #
2570
- # @overload cont(v,z,sch="",opt="")
2571
- # @param [MglData] v
2572
- # @param [MglData] z
2573
- # @param [String] sch default=""
2574
- # @param [String] opt default=""
2575
- # @return [nil]
2576
- #
2577
- # @overload cont(v,x,y,z,sch="",opt="")
2578
- # @param [MglData] v
2579
- # @param [MglData] x
2580
- # @param [MglData] y
2581
- # @param [MglData] z
2582
- # @param [String] sch default=""
2583
- # @param [String] opt default=""
2584
- # @return [nil]
2585
- def cont
2586
- end
2587
-
2588
-
2589
- # 2D plotting.
2590
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2591
- #
2592
- # @overload cont(z,sch="",opt="")
2593
- # @param [MglData] z
2594
- # @param [String] sch default=""
2595
- # @param [String] opt default=""
2596
- # @return [nil]
2597
- #
2598
- # @overload cont(x,y,z,sch="",opt="")
2599
- # @param [MglData] x
2600
- # @param [MglData] y
2601
- # @param [MglData] z
2602
- # @param [String] sch default=""
2603
- # @param [String] opt default=""
2604
- # @return [nil]
2605
- def cont
2606
- end
2607
-
2608
-
2609
- # 2D plotting.
2610
- # The function draws solid (or filled) contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v (must be v.nx>2). See also dens, cont, contd, contf(xyz). ContF sample
2611
- #
2612
- # @overload cont_f(v,z,sch="",opt="")
2613
- # @param [MglData] v
2614
- # @param [MglData] z
2615
- # @param [String] sch default=""
2616
- # @param [String] opt default=""
2617
- # @return [nil]
2618
- #
2619
- # @overload cont_f(v,x,y,z,sch="",opt="")
2620
- # @param [MglData] v
2621
- # @param [MglData] x
2622
- # @param [MglData] y
2623
- # @param [MglData] z
2624
- # @param [String] sch default=""
2625
- # @param [String] opt default=""
2626
- # @return [nil]
2627
- def cont_f
2628
- end
2629
-
2630
-
2631
- # 2D plotting.
2632
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2633
- #
2634
- # @overload cont_f(z,sch="",opt="")
2635
- # @param [MglData] z
2636
- # @param [String] sch default=""
2637
- # @param [String] opt default=""
2638
- # @return [nil]
2639
- #
2640
- # @overload cont_f(x,y,z,sch="",opt="")
2641
- # @param [MglData] x
2642
- # @param [MglData] y
2643
- # @param [MglData] z
2644
- # @param [String] sch default=""
2645
- # @param [String] opt default=""
2646
- # @return [nil]
2647
- def cont_f
2648
- end
2649
-
2650
-
2651
- # 2D plotting.
2652
- # The function draws solid (or filled) contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) (or at z = Min.z if sch contain symbol '_') with manual colors. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v (must be v.nx>2). String sch sets the contour colors: the color of k-th contour is determined by character sch(k%strlen(sch)). See also dens, cont, contf. ContD sample
2653
- #
2654
- # @overload cont_d(v,z,sch="",opt="")
2655
- # @param [MglData] v
2656
- # @param [MglData] z
2657
- # @param [String] sch default=""
2658
- # @param [String] opt default=""
2659
- # @return [nil]
2660
- #
2661
- # @overload cont_d(v,x,y,z,sch="",opt="")
2662
- # @param [MglData] v
2663
- # @param [MglData] x
2664
- # @param [MglData] y
2665
- # @param [MglData] z
2666
- # @param [String] sch default=""
2667
- # @param [String] opt default=""
2668
- # @return [nil]
2669
- def cont_d
2670
- end
2671
-
2672
-
2673
- # 2D plotting.
2674
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2675
- #
2676
- # @overload cont_d(z,sch="",opt="")
2677
- # @param [MglData] z
2678
- # @param [String] sch default=""
2679
- # @param [String] opt default=""
2680
- # @return [nil]
2681
- #
2682
- # @overload cont_d(x,y,z,sch="",opt="")
2683
- # @param [MglData] x
2684
- # @param [MglData] y
2685
- # @param [MglData] z
2686
- # @param [String] sch default=""
2687
- # @param [String] opt default=""
2688
- # @return [nil]
2689
- def cont_d
2690
- end
2691
-
2692
-
2693
- # 2D plotting.
2694
- # The function draws vertical cylinder (tube) at contour lines for surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z=v(k) or at z = Min.z if sch contain symbol '_'. Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. See also cont, contf. ContV sample
2695
- #
2696
- # @overload cont_v(v,z,sch="",opt="")
2697
- # @param [MglData] v
2698
- # @param [MglData] z
2699
- # @param [String] sch default=""
2700
- # @param [String] opt default=""
2701
- # @return [nil]
2702
- #
2703
- # @overload cont_v(v,x,y,z,sch="",opt="")
2704
- # @param [MglData] v
2705
- # @param [MglData] x
2706
- # @param [MglData] y
2707
- # @param [MglData] z
2708
- # @param [String] sch default=""
2709
- # @param [String] opt default=""
2710
- # @return [nil]
2711
- def cont_v
2712
- end
2713
-
2714
-
2715
- # 2D plotting.
2716
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2717
- #
2718
- # @overload cont_v(z,sch="",opt="")
2719
- # @param [MglData] z
2720
- # @param [String] sch default=""
2721
- # @param [String] opt default=""
2722
- # @return [nil]
2723
- #
2724
- # @overload cont_v(x,y,z,sch="",opt="")
2725
- # @param [MglData] x
2726
- # @param [MglData] y
2727
- # @param [MglData] z
2728
- # @param [String] sch default=""
2729
- # @param [String] opt default=""
2730
- # @return [nil]
2731
- def cont_v
2732
- end
2733
-
2734
-
2735
- # 2D plotting.
2736
- # The function draws surface which is result of contour plot rotation for surface specified parametrically (x(i,j), y(i,j), z(i,j)). Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. If string sch have symbol '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. If string contain symbols 'x' or 'z' then rotation axis will be set to specified direction (default is 'y'). See also cont, contf, torus, surf3. Axial sample
2737
- #
2738
- # @overload axial(v,z,sch="",opt="")
2739
- # @param [MglData] v
2740
- # @param [MglData] z
2741
- # @param [String] sch default=""
2742
- # @param [String] opt default=""
2743
- # @return [nil]
2744
- #
2745
- # @overload axial(v,x,y,z,sch="",opt="")
2746
- # @param [MglData] v
2747
- # @param [MglData] x
2748
- # @param [MglData] y
2749
- # @param [MglData] z
2750
- # @param [String] sch default=""
2751
- # @param [String] opt default=""
2752
- # @return [nil]
2753
- def axial
2754
- end
2755
-
2756
-
2757
- # 2D plotting.
2758
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 3).
2759
- #
2760
- # @overload axial(z,sch="",opt="",num=3)
2761
- # @param [MglData] z
2762
- # @param [String] sch default=""
2763
- # @param [String] opt default=""
2764
- # @param [Integer] num default=3
2765
- # @return [nil]
2766
- #
2767
- # @overload axial(x,y,z,sch="",opt="",num=3)
2768
- # @param [MglData] x
2769
- # @param [MglData] y
2770
- # @param [MglData] z
2771
- # @param [String] sch default=""
2772
- # @param [String] opt default=""
2773
- # @param [Integer] num default=3
2774
- # @return [nil]
2775
- def axial
2776
- end
2777
-
2778
-
2779
- # 2D plotting.
2780
- # The function draws grid lines for density plot of surface specified parametrically (x(i,j), y(i,j), z(i,j)) at z = Min.z. See also dens, cont, contf, meshnum.
2781
- #
2782
- # @overload grid(z,sch="",opt="")
2783
- # @param [MglData] z
2784
- # @param [String] sch default=""
2785
- # @param [String] opt default=""
2786
- # @return [nil]
2787
- #
2788
- # @overload grid(x,y,z,sch="",opt="")
2789
- # @param [MglData] x
2790
- # @param [MglData] y
2791
- # @param [MglData] z
2792
- # @param [String] sch default=""
2793
- # @param [String] opt default=""
2794
- # @return [nil]
2795
- def grid
2796
- end
2797
-
2798
-
2799
- # 3D plotting.
2800
- # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. If string contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. Note, that there is possibility of incorrect plotting due to uncertainty of cross-section defining if there are two or more isosurface intersections inside one cell. See also cloud, dens3, surf3c, surf3a, axial. Surf3 sample
2801
- #
2802
- # @overload surf3(val,a,sch="",opt="")
2803
- # @param [Float] val
2804
- # @param [MglData] a
2805
- # @param [String] sch default=""
2806
- # @param [String] opt default=""
2807
- # @return [nil]
2808
- #
2809
- # @overload surf3(val,x,y,z,a,sch="",opt="")
2810
- # @param [Float] val
2811
- # @param [MglData] x
2812
- # @param [MglData] y
2813
- # @param [MglData] z
2814
- # @param [MglData] a
2815
- # @param [String] sch default=""
2816
- # @param [String] opt default=""
2817
- # @return [nil]
2818
- def surf3
2819
- end
2820
-
2821
-
2822
- # 3D plotting.
2823
- # Draws num-th uniformly distributed in color range isosurfaces for 3d data. Here num is equal to parameter value in options opt (default is 3).
2824
- #
2825
- # @overload surf3(a,sch="",opt="")
2826
- # @param [MglData] a
2827
- # @param [String] sch default=""
2828
- # @param [String] opt default=""
2829
- # @return [nil]
2830
- #
2831
- # @overload surf3(x,y,z,a,sch="",opt="")
2832
- # @param [MglData] x
2833
- # @param [MglData] y
2834
- # @param [MglData] z
2835
- # @param [MglData] a
2836
- # @param [String] sch default=""
2837
- # @param [String] opt default=""
2838
- # @return [nil]
2839
- def surf3
2840
- end
2841
-
2842
-
2843
- # 3D plotting.
2844
- # The function draws cloud plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). This plot is a set of cubes with color and transparency proportional to value of a. The resulting plot is like cloud -- low value is transparent but higher ones are not. The number of plotting cells depend on meshnum. If string sch contain symbol '.' then lower quality plot will produced with much low memory usage. If string sch contain symbol 'i' then transparency will be inversed, i.e. higher become transparent and lower become not transparent. See also surf3, meshnum. Cloud sample
2845
- #
2846
- # @overload cloud(a,sch="",opt="")
2847
- # @param [MglData] a
2848
- # @param [String] sch default=""
2849
- # @param [String] opt default=""
2850
- # @return [nil]
2851
- #
2852
- # @overload cloud(x,y,z,a,sch="",opt="")
2853
- # @param [MglData] x
2854
- # @param [MglData] y
2855
- # @param [MglData] z
2856
- # @param [MglData] a
2857
- # @param [String] sch default=""
2858
- # @param [String] opt default=""
2859
- # @return [nil]
2860
- def cloud
2861
- end
2862
-
2863
-
2864
- # 3D plotting.
2865
- # The function draws density plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Density is plotted at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string stl have symbol '#' then grid lines are drawn. See also cont3, contf3, dens, grid3. Dens3 sample
2866
- #
2867
- # @overload dens3(a,sch="",sval=-1,opt="")
2868
- # @param [MglData] a
2869
- # @param [String] sch default=""
2870
- # @param [Float] sval default=-1
2871
- # @param [String] opt default=""
2872
- # @return [nil]
2873
- #
2874
- # @overload dens3(x,y,z,a,sch="",sval=-1,opt="")
2875
- # @param [MglData] x
2876
- # @param [MglData] y
2877
- # @param [MglData] z
2878
- # @param [MglData] a
2879
- # @param [String] sch default=""
2880
- # @param [Float] sval default=-1
2881
- # @param [String] opt default=""
2882
- # @return [nil]
2883
- def dens3
2884
- end
2885
-
2886
-
2887
- # 3D plotting.
2888
- # The function draws contour plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Contours are plotted for values specified in array v at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol 't' or 'T' then contour labels will be drawn below (or above) the contours. See also dens3, contf3, cont, grid3. Cont3 sample
2889
- #
2890
- # @overload cont3(v,a,sch="",sval=-1,opt="")
2891
- # @param [MglData] v
2892
- # @param [MglData] a
2893
- # @param [String] sch default=""
2894
- # @param [Float] sval default=-1
2895
- # @param [String] opt default=""
2896
- # @return [nil]
2897
- #
2898
- # @overload cont3(v,x,y,z,a,sch="",sval=-1,opt="")
2899
- # @param [MglData] v
2900
- # @param [MglData] x
2901
- # @param [MglData] y
2902
- # @param [MglData] z
2903
- # @param [MglData] a
2904
- # @param [String] sch default=""
2905
- # @param [Float] sval default=-1
2906
- # @param [String] opt default=""
2907
- # @return [nil]
2908
- def cont3
2909
- end
2910
-
2911
-
2912
- # 3D plotting.
2913
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2914
- #
2915
- # @overload cont3(a,sch="",sval=-1,opt="",opt="")
2916
- # @param [MglData] a
2917
- # @param [String] sch default=""
2918
- # @param [Float] sval default=-1
2919
- # @param [String] opt default=""
2920
- # @param [String] opt default=""
2921
- # @return [nil]
2922
- #
2923
- # @overload cont3(x,y,z,a,sch="",sval=-1,opt="")
2924
- # @param [MglData] x
2925
- # @param [MglData] y
2926
- # @param [MglData] z
2927
- # @param [MglData] a
2928
- # @param [String] sch default=""
2929
- # @param [Float] sval default=-1
2930
- # @param [String] opt default=""
2931
- # @return [nil]
2932
- def cont3
2933
- end
2934
-
2935
-
2936
- # 3D plotting.
2937
- # The function draws solid (or filled) contour plot for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Contours are plotted for values specified in array v at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). If string sch have symbol '#' then grid lines are drawn. See also dens3, cont3, contf, grid3. ContF3 sample
2938
- #
2939
- # @overload contf3(v,a,sch="",sval=-1,opt="")
2940
- # @param [MglData] v
2941
- # @param [MglData] a
2942
- # @param [String] sch default=""
2943
- # @param [Float] sval default=-1
2944
- # @param [String] opt default=""
2945
- # @return [nil]
2946
- #
2947
- # @overload contf3(v,x,y,z,a,sch="",sval=-1,opt="")
2948
- # @param [MglData] v
2949
- # @param [MglData] x
2950
- # @param [MglData] y
2951
- # @param [MglData] z
2952
- # @param [MglData] a
2953
- # @param [String] sch default=""
2954
- # @param [Float] sval default=-1
2955
- # @param [String] opt default=""
2956
- # @return [nil]
2957
- def contf3
2958
- end
2959
-
2960
-
2961
- # 3D plotting.
2962
- # The same as previous with vector v of num-th elements equidistantly distributed in color range. Here num is equal to parameter value in options opt (default is 7).
2963
- #
2964
- # @overload contf3(a,sch="",sval=-1,opt="",opt="")
2965
- # @param [MglData] a
2966
- # @param [String] sch default=""
2967
- # @param [Float] sval default=-1
2968
- # @param [String] opt default=""
2969
- # @param [String] opt default=""
2970
- # @return [nil]
2971
- #
2972
- # @overload contf3(x,y,z,a,sch="",sval=-1,opt="")
2973
- # @param [MglData] x
2974
- # @param [MglData] y
2975
- # @param [MglData] z
2976
- # @param [MglData] a
2977
- # @param [String] sch default=""
2978
- # @param [Float] sval default=-1
2979
- # @param [String] opt default=""
2980
- # @return [nil]
2981
- def contf3
2982
- end
2983
-
2984
-
2985
- # 3D plotting.
2986
- # The function draws grid for 3d data specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)). Grid is plotted at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). See also cont3, contf3, dens3, grid2, meshnum.
2987
- #
2988
- # @overload grid3(a,sch="",sval=-1,opt="")
2989
- # @param [MglData] a
2990
- # @param [String] sch default=""
2991
- # @param [Float] sval default=-1
2992
- # @param [String] opt default=""
2993
- # @return [nil]
2994
- #
2995
- # @overload grid3(x,y,z,a,sch="",sval=-1,opt="")
2996
- # @param [MglData] x
2997
- # @param [MglData] y
2998
- # @param [MglData] z
2999
- # @param [MglData] a
3000
- # @param [String] sch default=""
3001
- # @param [Float] sval default=-1
3002
- # @param [String] opt default=""
3003
- # @return [nil]
3004
- def grid3
3005
- end
3006
-
3007
-
3008
- # 3D plotting.
3009
- # Draws the isosurface for 3d array a at constant values of a=val. This is special kind of plot for a specified in accompanied coordinates along curve tr with orts g1, g2 and with transverse scale r. Variable flag is bitwise: '0x1' - draw in accompanied (not laboratory) coordinates; '0x2' - draw projection to \rho-z plane; '0x4' - draw normalized in each slice field. The x-size of data arrays tr, g1, g2 must be nx>2. The y-size of data arrays tr, g1, g2 and z-size of the data array a must be equal. See also surf3.
3010
- #
3011
- # @overload beam(tr,g1,g2,a,r,stl="",flag=0,num=3)
3012
- # @param [MglData] tr
3013
- # @param [MglData] g1
3014
- # @param [MglData] g2
3015
- # @param [MglData] a
3016
- # @param [Float] r
3017
- # @param [String] stl default=""
3018
- # @param [Integer] flag default=0
3019
- # @param [Integer] num default=3
3020
- # @return [nil]
3021
- #
3022
- # @overload beam(val,tr,g1,g2,a,r,stl="",flag=0)
3023
- # @param [Float] val
3024
- # @param [MglData] tr
3025
- # @param [MglData] g1
3026
- # @param [MglData] g2
3027
- # @param [MglData] a
3028
- # @param [Float] r
3029
- # @param [String] stl default=""
3030
- # @param [Integer] flag default=0
3031
- # @return [nil]
3032
- def beam
3033
- end
3034
-
3035
-
3036
- # Dual plotting.
3037
- # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)) and color it by matrix c(i,j). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfa, surf3c. SurfC sample
3038
- #
3039
- # @overload surf_c(z,c,sch="",opt="")
3040
- # @param [MglData] z
3041
- # @param [MglData] c
3042
- # @param [String] sch default=""
3043
- # @param [String] opt default=""
3044
- # @return [nil]
3045
- #
3046
- # @overload surf_c(x,y,z,c,sch="",opt="")
3047
- # @param [MglData] x
3048
- # @param [MglData] y
3049
- # @param [MglData] z
3050
- # @param [MglData] c
3051
- # @param [String] sch default=""
3052
- # @param [String] opt default=""
3053
- # @return [nil]
3054
- def surf_c
3055
- end
3056
-
3057
-
3058
- # Dual plotting.
3059
- # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. See also surf3, surfc, surf3a. Surf3C sample
3060
- #
3061
- # @overload surf_3c(val,a,c,sch="",opt="")
3062
- # @param [Float] val
3063
- # @param [MglData] a
3064
- # @param [MglData] c
3065
- # @param [String] sch default=""
3066
- # @param [String] opt default=""
3067
- # @return [nil]
3068
- #
3069
- # @overload surf_3c(val,x,y,z,a,c,sch="",opt="")
3070
- # @param [Float] val
3071
- # @param [MglData] x
3072
- # @param [MglData] y
3073
- # @param [MglData] z
3074
- # @param [MglData] a
3075
- # @param [MglData] c
3076
- # @param [String] sch default=""
3077
- # @param [String] opt default=""
3078
- # @return [nil]
3079
- def surf_3c
3080
- end
3081
-
3082
-
3083
- # Dual plotting.
3084
- # Draws num-th uniformly distributed in color range isosurfaces for 3d data. Here num is equal to parameter value in options opt (default is 3).
3085
- #
3086
- # @overload surf_3c(a,c,sch="",opt="")
3087
- # @param [MglData] a
3088
- # @param [MglData] c
3089
- # @param [String] sch default=""
3090
- # @param [String] opt default=""
3091
- # @return [nil]
3092
- #
3093
- # @overload surf_3c(x,y,z,a,c,sch="",opt="")
3094
- # @param [MglData] x
3095
- # @param [MglData] y
3096
- # @param [MglData] z
3097
- # @param [MglData] a
3098
- # @param [MglData] c
3099
- # @param [String] sch default=""
3100
- # @param [String] opt default=""
3101
- # @return [nil]
3102
- def surf_3c
3103
- end
3104
-
3105
-
3106
- # Dual plotting.
3107
- # The function draws surface specified parametrically (x(i,j), y(i,j), z(i,j)) and transparent it by matrix c(i,j). If string sch have symbol '#' then grid lines are drawn. If string sch have symbol '.' then plot by dots is produced. All dimensions of arrays z and c must be equal. Surface is plotted for each z slice of the data. See also surf, surfc, surf3a. SurfA sample
3108
- #
3109
- # @overload surf_a(z,c,sch="",opt="")
3110
- # @param [MglData] z
3111
- # @param [MglData] c
3112
- # @param [String] sch default=""
3113
- # @param [String] opt default=""
3114
- # @return [nil]
3115
- #
3116
- # @overload surf_a(x,y,z,c,sch="",opt="")
3117
- # @param [MglData] x
3118
- # @param [MglData] y
3119
- # @param [MglData] z
3120
- # @param [MglData] c
3121
- # @param [String] sch default=""
3122
- # @param [String] opt default=""
3123
- # @return [nil]
3124
- def surf_a
3125
- end
3126
-
3127
-
3128
- # Dual plotting.
3129
- # The function draws isosurface plot for 3d array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) at a(x,y,z)=val. It is mostly the same as surf3 function but the color of isosurface depends on values of array c. If string sch contain '#' then wire plot is produced. If string sch have symbol '.' then plot by dots is produced. See also surf3, surfc, surf3a. Surf3A sample
3130
- #
3131
- # @overload surf_3a(val,a,c,sch="",opt="")
3132
- # @param [Float] val
3133
- # @param [MglData] a
3134
- # @param [MglData] c
3135
- # @param [String] sch default=""
3136
- # @param [String] opt default=""
3137
- # @return [nil]
3138
- #
3139
- # @overload surf_3a(val,x,y,z,a,c,sch="",opt="")
3140
- # @param [Float] val
3141
- # @param [MglData] x
3142
- # @param [MglData] y
3143
- # @param [MglData] z
3144
- # @param [MglData] a
3145
- # @param [MglData] c
3146
- # @param [String] sch default=""
3147
- # @param [String] opt default=""
3148
- # @return [nil]
3149
- def surf_3a
3150
- end
3151
-
3152
-
3153
- # Dual plotting.
3154
- # Draws num-th uniformly distributed in color range isosurfaces for 3d data. At this array c can be vector with values of transparency and num=c.nx. In opposite case num is equal to parameter value in options opt (default is 3).
3155
- #
3156
- # @overload surf_3a(a,c,sch="",opt="")
3157
- # @param [MglData] a
3158
- # @param [MglData] c
3159
- # @param [String] sch default=""
3160
- # @param [String] opt default=""
3161
- # @return [nil]
3162
- #
3163
- # @overload surf_3a(x,y,z,a,c,sch="",opt="")
3164
- # @param [MglData] x
3165
- # @param [MglData] y
3166
- # @param [MglData] z
3167
- # @param [MglData] a
3168
- # @param [MglData] c
3169
- # @param [String] sch default=""
3170
- # @param [String] opt default=""
3171
- # @return [nil]
3172
- def surf_3a
3173
- end
3174
-
3175
-
3176
- # Dual plotting.
3177
- # The function draws horizontal tiles for surface specified parametrically (x(i,j), y(i,j), z(i,j)). It is mostly the same as tile but the size of tiles is determined by r array. This is some kind of ``transparency'' useful for exporting to EPS files. Tiles is plotted for each z slice of the data. See also surfa, tile. TileS sample
3178
- #
3179
- # @overload tile_s(z,c,sch="",opt="")
3180
- # @param [MglData] z
3181
- # @param [MglData] c
3182
- # @param [String] sch default=""
3183
- # @param [String] opt default=""
3184
- # @return [nil]
3185
- #
3186
- # @overload tile_s(x,y,z,r,sch="",opt="")
3187
- # @param [MglData] x
3188
- # @param [MglData] y
3189
- # @param [MglData] z
3190
- # @param [MglData] r
3191
- # @param [String] sch default=""
3192
- # @param [String] opt default=""
3193
- # @return [nil]
3194
- def tile_s
3195
- end
3196
-
3197
-
3198
- # Dual plotting.
3199
- # The function draws mapping plot for matrices (ax, ay ) which parametrically depend on coordinates x, y. The initial position of the cell (point) is marked by color. Height is proportional to Jacobian(ax,ay). This plot is like Arnold diagram ??? If string sch contain symbol '.' then the color ball at matrix knots are drawn otherwise face is drawn. Mapping visualization
3200
- #
3201
- # @overload map(ax,ay,sch="",opt="")
3202
- # @param [MglData] ax
3203
- # @param [MglData] ay
3204
- # @param [String] sch default=""
3205
- # @param [String] opt default=""
3206
- # @return [nil]
3207
- #
3208
- # @overload map(x,y,ax,ay,sch="",opt="")
3209
- # @param [MglData] x
3210
- # @param [MglData] y
3211
- # @param [MglData] ax
3212
- # @param [MglData] ay
3213
- # @param [String] sch default=""
3214
- # @param [String] opt default=""
3215
- # @return [nil]
3216
- def map
3217
- end
3218
-
3219
-
3220
- # Dual plotting.
3221
- # Draws spectrogram of complex array re+i*im for Fourier size of dn points at plane z=Min.z. For example in 1D case, result is density plot of data res(i,j)=|\sum_d^dn exp(I*j*d)*(re(i*dn+d)+I*im(i*dn+d))|/dn with size (int(nx/dn), dn, ny). At this array re, im parametrically depend on coordinates x, y. The size of re and im must be the same. The minor dimensions of arrays x, y, re should be equal. Arrays x, y can be vectors (not matrix as re). STFA sample
3222
- #
3223
- # @overload stfa(re,im,dn,sch="",opt="")
3224
- # @param [MglData] re
3225
- # @param [MglData] im
3226
- # @param [Integer] dn
3227
- # @param [String] sch default=""
3228
- # @param [String] opt default=""
3229
- # @return [nil]
3230
- #
3231
- # @overload stfa(x,y,re,im,dn,sch="",opt="")
3232
- # @param [MglData] x
3233
- # @param [MglData] y
3234
- # @param [MglData] re
3235
- # @param [MglData] im
3236
- # @param [Integer] dn
3237
- # @param [String] sch default=""
3238
- # @param [String] opt default=""
3239
- # @return [nil]
3240
- def stfa
3241
- end
3242
-
3243
-
3244
- # Vector fields.
3245
- # The function draws vectors (ax, ay, az) along a curve (x, y, z). The length of arrows are proportional to \sqrt(ax^2+ay^2+az^2). String pen specifies the color (see Line styles). By default (pen="") color from palette is used (see Palette and colors). Option value set the vector length factor (if non-zero) or vector length to be proportional the distance between curve points (if value=0). The minor sizes of all arrays must be equal and large 2. The plots are drawn for each row if one of the data is the matrix. See also vect. Traj sample
3246
- #
3247
- # @overload traj(x,y,ax,ay,sch="",opt="")
3248
- # @param [MglData] x
3249
- # @param [MglData] y
3250
- # @param [MglData] ax
3251
- # @param [MglData] ay
3252
- # @param [String] sch default=""
3253
- # @param [String] opt default=""
3254
- # @return [nil]
3255
- #
3256
- # @overload traj(x,y,z,ax,ay,az,sch="",opt="")
3257
- # @param [MglData] x
3258
- # @param [MglData] y
3259
- # @param [MglData] z
3260
- # @param [MglData] ax
3261
- # @param [MglData] ay
3262
- # @param [MglData] az
3263
- # @param [String] sch default=""
3264
- # @param [String] opt default=""
3265
- # @return [nil]
3266
- def traj
3267
- end
3268
-
3269
-
3270
- # Vector fields.
3271
- # The function draws plane vector field plot for the field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. The length and color of arrows are proportional to \sqrt(ax^2+ay^2). The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
3272
- # See also flow, dew. Vect sample
3273
- #
3274
- # @overload vect(ax,ay,sch="",opt="")
3275
- # @param [MglData] ax
3276
- # @param [MglData] ay
3277
- # @param [String] sch default=""
3278
- # @param [String] opt default=""
3279
- # @return [nil]
3280
- #
3281
- # @overload vect(x,y,ax,ay,sch="",opt="")
3282
- # @param [MglData] x
3283
- # @param [MglData] y
3284
- # @param [MglData] ax
3285
- # @param [MglData] ay
3286
- # @param [String] sch default=""
3287
- # @param [String] opt default=""
3288
- # @return [nil]
3289
- def vect
3290
- end
3291
-
3292
-
3293
- # Vector fields.
3294
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the length and color of arrows is proportional to \sqrt(ax^2+ay^2+az^2).
3295
- #
3296
- # @overload vect(ax,ay,az,sch="",opt="")
3297
- # @param [MglData] ax
3298
- # @param [MglData] ay
3299
- # @param [MglData] az
3300
- # @param [String] sch default=""
3301
- # @param [String] opt default=""
3302
- # @return [nil]
3303
- #
3304
- # @overload vect(x,y,z,ax,ay,az,sch="",opt="")
3305
- # @param [MglData] x
3306
- # @param [MglData] y
3307
- # @param [MglData] z
3308
- # @param [MglData] ax
3309
- # @param [MglData] ay
3310
- # @param [MglData] az
3311
- # @param [String] sch default=""
3312
- # @param [String] opt default=""
3313
- # @return [nil]
3314
- def vect
3315
- end
3316
-
3317
-
3318
- # Vector fields.
3319
- # The function draws 3D vector field plot for the field (ax, ay, az) depending parametrically on coordinates x, y, z. Vector field is drawn at slice sVal in direction ('x', 'y', 'z') if sch contain corresponding symbol (by default, 'y' direction is used). The length and color of arrows are proportional to \sqrt(ax^2+ay^2+az^2). The number of arrows depend on meshnum. The appearance of the hachures (arrows) can be changed by symbols:
3320
- # See also vect, flow, dew. Vect3 sample
3321
- #
3322
- # @overload vect3(ax,ay,az,sch="",sval=-1,opt="")
3323
- # @param [MglData] ax
3324
- # @param [MglData] ay
3325
- # @param [MglData] az
3326
- # @param [String] sch default=""
3327
- # @param [Float] sval default=-1
3328
- # @param [String] opt default=""
3329
- # @return [nil]
3330
- #
3331
- # @overload vect3(x,y,z,ax,ay,az,sch="",sval=-1,opt="")
3332
- # @param [MglData] x
3333
- # @param [MglData] y
3334
- # @param [MglData] z
3335
- # @param [MglData] ax
3336
- # @param [MglData] ay
3337
- # @param [MglData] az
3338
- # @param [String] sch default=""
3339
- # @param [Float] sval default=-1
3340
- # @param [String] opt default=""
3341
- # @return [nil]
3342
- def vect3
3343
- end
3344
-
3345
-
3346
- # Vector fields.
3347
- # The function draws dew-drops for plane vector field (ax, ay) depending parametrically on coordinates x, y at level z=Min.z. Note that this is very expensive plot in memory usage and creation time! The color of drops is proportional to \sqrt(ax^2+ay^2). The number of drops depend on meshnum. See also vect. Dew sample
3348
- #
3349
- # @overload dew(ax,ay,sch="",opt="")
3350
- # @param [MglData] ax
3351
- # @param [MglData] ay
3352
- # @param [String] sch default=""
3353
- # @param [String] opt default=""
3354
- # @return [nil]
3355
- #
3356
- # @overload dew(x,y,ax,ay,sch="",opt="")
3357
- # @param [MglData] x
3358
- # @param [MglData] y
3359
- # @param [MglData] ax
3360
- # @param [MglData] ay
3361
- # @param [String] sch default=""
3362
- # @param [String] opt default=""
3363
- # @return [nil]
3364
- def dew
3365
- end
3366
-
3367
-
3368
- # Vector fields.
3369
- # The function draws flow threads for the plane vector field (ax, ay) parametrically depending on coordinates x, y at level z = Min.z. Number of threads is proportional to value option (default is 5). String sch may contain:
3370
- # See also pipe, vect, tape, barwidth. Flow sample
3371
- #
3372
- # @overload flow(ax,ay,sch="",opt="")
3373
- # @param [MglData] ax
3374
- # @param [MglData] ay
3375
- # @param [String] sch default=""
3376
- # @param [String] opt default=""
3377
- # @return [nil]
3378
- #
3379
- # @overload flow(x,y,ax,ay,sch="",opt="")
3380
- # @param [MglData] x
3381
- # @param [MglData] y
3382
- # @param [MglData] ax
3383
- # @param [MglData] ay
3384
- # @param [String] sch default=""
3385
- # @param [String] opt default=""
3386
- # @return [nil]
3387
- def flow
3388
- end
3389
-
3390
-
3391
- # Vector fields.
3392
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to \sqrt(ax^2+ay^2+az^2).
3393
- #
3394
- # @overload flow(ax,ay,az,sch="",opt="")
3395
- # @param [MglData] ax
3396
- # @param [MglData] ay
3397
- # @param [MglData] az
3398
- # @param [String] sch default=""
3399
- # @param [String] opt default=""
3400
- # @return [nil]
3401
- #
3402
- # @overload flow(x,y,z,ax,ay,az,sch="",opt="")
3403
- # @param [MglData] x
3404
- # @param [MglData] y
3405
- # @param [MglData] z
3406
- # @param [MglData] ax
3407
- # @param [MglData] ay
3408
- # @param [MglData] az
3409
- # @param [String] sch default=""
3410
- # @param [String] opt default=""
3411
- # @return [nil]
3412
- def flow
3413
- end
3414
-
3415
-
3416
- # Vector fields.
3417
- # The same as first one (flow) but draws single flow thread starting from point p0=(x0,y0,z0).
3418
- #
3419
- # @overload flow_p(p0,ax,ay,sch="",opt="")
3420
- # @param [MglPoint] p0
3421
- # @param [MglData] ax
3422
- # @param [MglData] ay
3423
- # @param [String] sch default=""
3424
- # @param [String] opt default=""
3425
- # @return [nil]
3426
- #
3427
- # @overload flow_p(p0,x,y,ax,ay,sch="",opt="")
3428
- # @param [MglPoint] p0
3429
- # @param [MglData] x
3430
- # @param [MglData] y
3431
- # @param [MglData] ax
3432
- # @param [MglData] ay
3433
- # @param [String] sch default=""
3434
- # @param [String] opt default=""
3435
- # @return [nil]
3436
- def flow_p
3437
- end
3438
-
3439
-
3440
- # Vector fields.
3441
- # This is 3D version of the previous functions.
3442
- #
3443
- # @overload flow_p(p0,ax,ay,az,sch="",opt="")
3444
- # @param [MglPoint] p0
3445
- # @param [MglData] ax
3446
- # @param [MglData] ay
3447
- # @param [MglData] az
3448
- # @param [String] sch default=""
3449
- # @param [String] opt default=""
3450
- # @return [nil]
3451
- #
3452
- # @overload flow_p(p0,x,y,z,ax,ay,az,sch="",opt="")
3453
- # @param [MglPoint] p0
3454
- # @param [MglData] x
3455
- # @param [MglData] y
3456
- # @param [MglData] z
3457
- # @param [MglData] ax
3458
- # @param [MglData] ay
3459
- # @param [MglData] az
3460
- # @param [String] sch default=""
3461
- # @param [String] opt default=""
3462
- # @return [nil]
3463
- def flow_p
3464
- end
3465
-
3466
-
3467
- # Vector fields.
3468
- # The function draws gradient lines for scalar field phi(i,j) (or phi(i,j,k) in 3d case) specified parametrically (x(i,j,k), y(i,j,k), z(i,j,k)). Number of lines is proportional to value option (default is 5). See also dens, cont, flow.
3469
- #
3470
- # @overload grad(phi,sch="",opt="")
3471
- # @param [MglData] phi
3472
- # @param [String] sch default=""
3473
- # @param [String] opt default=""
3474
- # @return [nil]
3475
- #
3476
- # @overload grad(x,y,phi,sch="",opt="")
3477
- # @param [MglData] x
3478
- # @param [MglData] y
3479
- # @param [MglData] phi
3480
- # @param [String] sch default=""
3481
- # @param [String] opt default=""
3482
- # @return [nil]
3483
- #
3484
- # @overload grad(x,y,z,phi,sch="",opt="")
3485
- # @param [MglData] x
3486
- # @param [MglData] y
3487
- # @param [MglData] z
3488
- # @param [MglData] phi
3489
- # @param [String] sch default=""
3490
- # @param [String] opt default=""
3491
- # @return [nil]
3492
- def grad
3493
- end
3494
-
3495
-
3496
- # Vector fields.
3497
- # The function draws flow pipes for the plane vector field (ax, ay) parametrically depending on coordinates x, y at level z = Min.z. Number of pipes is proportional to value option (default is 5). If '#' symbol is specified then pipes start only from edges of axis range. The color of lines is proportional to \sqrt(ax^2+ay^2). Warm color corresponds to normal flow (like attractor). Cold one corresponds to inverse flow (like source). Parameter r0 set the base pipe radius. If r0<0 or symbol 'i' is specified then pipe radius is inverse proportional to amplitude. The vector field is plotted for each z slice of ax, ay. See also flow, vect. Pipe sample
3498
- #
3499
- # @overload pipe(ax,ay,sch="",r0=0.05,opt="")
3500
- # @param [MglData] ax
3501
- # @param [MglData] ay
3502
- # @param [String] sch default=""
3503
- # @param [Float] r0 default=0.05
3504
- # @param [String] opt default=""
3505
- # @return [nil]
3506
- #
3507
- # @overload pipe(x,y,ax,ay,sch="",r0=0.05,opt="")
3508
- # @param [MglData] x
3509
- # @param [MglData] y
3510
- # @param [MglData] ax
3511
- # @param [MglData] ay
3512
- # @param [String] sch default=""
3513
- # @param [Float] r0 default=0.05
3514
- # @param [String] opt default=""
3515
- # @return [nil]
3516
- def pipe
3517
- end
3518
-
3519
-
3520
- # Vector fields.
3521
- # This is 3D version of the first functions. Here arrays ax, ay, az must be 3-ranged tensors with equal sizes and the color of line is proportional to \sqrt(ax^2+ay^2+az^2).
3522
- #
3523
- # @overload pipe(ax,ay,az,sch="",r0=0.05,opt="")
3524
- # @param [MglData] ax
3525
- # @param [MglData] ay
3526
- # @param [MglData] az
3527
- # @param [String] sch default=""
3528
- # @param [Float] r0 default=0.05
3529
- # @param [String] opt default=""
3530
- # @return [nil]
3531
- #
3532
- # @overload pipe(x,y,z,ax,ay,az,sch="",r0=0.05,opt="")
3533
- # @param [MglData] x
3534
- # @param [MglData] y
3535
- # @param [MglData] z
3536
- # @param [MglData] ax
3537
- # @param [MglData] ay
3538
- # @param [MglData] az
3539
- # @param [String] sch default=""
3540
- # @param [Float] r0 default=0.05
3541
- # @param [String] opt default=""
3542
- # @return [nil]
3543
- def pipe
3544
- end
3545
-
3546
-
3547
- # Other plotting.
3548
- # These plotting functions draw density plot in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContXYZ, ContFXYZ, dens, Data manipulation. Dens projection sample
3549
- #
3550
- # @overload dens_x(a,stl="",sval=NAN,opt="")
3551
- # @param [MglData] a
3552
- # @param [String] stl default=""
3553
- # @param [Float] sval default=NAN
3554
- # @param [String] opt default=""
3555
- # @return [nil]
3556
- def dens_x
3557
- end
3558
-
3559
-
3560
- # Other plotting.
3561
- # These plotting functions draw density plot in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContXYZ, ContFXYZ, dens, Data manipulation. Dens projection sample
3562
- #
3563
- # @overload dens_y(a,stl="",sval=NAN,opt="")
3564
- # @param [MglData] a
3565
- # @param [String] stl default=""
3566
- # @param [Float] sval default=NAN
3567
- # @param [String] opt default=""
3568
- # @return [nil]
3569
- def dens_y
3570
- end
3571
-
3572
-
3573
- # Other plotting.
3574
- # These plotting functions draw density plot in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContXYZ, ContFXYZ, dens, Data manipulation. Dens projection sample
3575
- #
3576
- # @overload dens_z(a,stl="",sval=NAN,opt="")
3577
- # @param [MglData] a
3578
- # @param [String] stl default=""
3579
- # @param [Float] sval default=NAN
3580
- # @param [String] opt default=""
3581
- # @return [nil]
3582
- def dens_z
3583
- end
3584
-
3585
-
3586
- # Other plotting.
3587
- # These plotting functions draw contour lines in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. Cont projection sample
3588
- #
3589
- # @overload cont_x(a,stl="",sval=NAN,opt="")
3590
- # @param [MglData] a
3591
- # @param [String] stl default=""
3592
- # @param [Float] sval default=NAN
3593
- # @param [String] opt default=""
3594
- # @return [nil]
3595
- def cont_x
3596
- end
3597
-
3598
-
3599
- # Other plotting.
3600
- # These plotting functions draw contour lines in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. Cont projection sample
3601
- #
3602
- # @overload cont_y(a,stl="",sval=NAN,opt="")
3603
- # @param [MglData] a
3604
- # @param [String] stl default=""
3605
- # @param [Float] sval default=NAN
3606
- # @param [String] opt default=""
3607
- # @return [nil]
3608
- def cont_y
3609
- end
3610
-
3611
-
3612
- # Other plotting.
3613
- # These plotting functions draw contour lines in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. Cont projection sample
3614
- #
3615
- # @overload cont_z(a,stl="",sval=NAN,opt="")
3616
- # @param [MglData] a
3617
- # @param [String] stl default=""
3618
- # @param [Float] sval default=NAN
3619
- # @param [String] opt default=""
3620
- # @return [nil]
3621
- def cont_z
3622
- end
3623
-
3624
-
3625
- # Other plotting.
3626
- # The same as previous with manual contour levels.
3627
- #
3628
- # @overload cont_x(v,a,stl="",sval=NAN,opt="")
3629
- # @param [MglData] v
3630
- # @param [MglData] a
3631
- # @param [String] stl default=""
3632
- # @param [Float] sval default=NAN
3633
- # @param [String] opt default=""
3634
- # @return [nil]
3635
- def cont_x
3636
- end
3637
-
3638
-
3639
- # Other plotting.
3640
- # The same as previous with manual contour levels.
3641
- #
3642
- # @overload cont_y(v,a,stl="",sval=NAN,opt="")
3643
- # @param [MglData] v
3644
- # @param [MglData] a
3645
- # @param [String] stl default=""
3646
- # @param [Float] sval default=NAN
3647
- # @param [String] opt default=""
3648
- # @return [nil]
3649
- def cont_y
3650
- end
3651
-
3652
-
3653
- # Other plotting.
3654
- # The same as previous with manual contour levels.
3655
- #
3656
- # @overload cont_z(v,a,stl="",sval=NAN,opt="")
3657
- # @param [MglData] v
3658
- # @param [MglData] a
3659
- # @param [String] stl default=""
3660
- # @param [Float] sval default=NAN
3661
- # @param [String] opt default=""
3662
- # @return [nil]
3663
- def cont_z
3664
- end
3665
-
3666
-
3667
- # Other plotting.
3668
- # These plotting functions draw solid contours in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. ContF projection sample
3669
- #
3670
- # @overload cont_fx(a,stl="",sval=NAN,opt="")
3671
- # @param [MglData] a
3672
- # @param [String] stl default=""
3673
- # @param [Float] sval default=NAN
3674
- # @param [String] opt default=""
3675
- # @return [nil]
3676
- def cont_fx
3677
- end
3678
-
3679
-
3680
- # Other plotting.
3681
- # These plotting functions draw solid contours in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. ContF projection sample
3682
- #
3683
- # @overload cont_fy(a,stl="",sval=NAN,opt="")
3684
- # @param [MglData] a
3685
- # @param [String] stl default=""
3686
- # @param [Float] sval default=NAN
3687
- # @param [String] opt default=""
3688
- # @return [nil]
3689
- def cont_fy
3690
- end
3691
-
3692
-
3693
- # Other plotting.
3694
- # These plotting functions draw solid contours in x, y, or z plain. If a is a tensor (3-dimensional data) then interpolation to a given sVal is performed. These functions are useful for creating projections of the 3D data array to the bounding box. See also ContFXYZ, DensXYZ, cont, Data manipulation. ContF projection sample
3695
- #
3696
- # @overload cont_fz(a,stl="",sval=NAN,opt="")
3697
- # @param [MglData] a
3698
- # @param [String] stl default=""
3699
- # @param [Float] sval default=NAN
3700
- # @param [String] opt default=""
3701
- # @return [nil]
3702
- def cont_fz
3703
- end
3704
-
3705
-
3706
- # Other plotting.
3707
- # The same as previous with manual contour levels.
3708
- #
3709
- # @overload cont_fx(v,a,stl="",sval=NAN,opt="")
3710
- # @param [MglData] v
3711
- # @param [MglData] a
3712
- # @param [String] stl default=""
3713
- # @param [Float] sval default=NAN
3714
- # @param [String] opt default=""
3715
- # @return [nil]
3716
- def cont_fx
3717
- end
3718
-
3719
-
3720
- # Other plotting.
3721
- # The same as previous with manual contour levels.
3722
- #
3723
- # @overload cont_fy(v,a,stl="",sval=NAN,opt="")
3724
- # @param [MglData] v
3725
- # @param [MglData] a
3726
- # @param [String] stl default=""
3727
- # @param [Float] sval default=NAN
3728
- # @param [String] opt default=""
3729
- # @return [nil]
3730
- def cont_fy
3731
- end
3732
-
3733
-
3734
- # Other plotting.
3735
- # The same as previous with manual contour levels.
3736
- #
3737
- # @overload cont_fz(v,a,stl="",sval=NAN,opt="")
3738
- # @param [MglData] v
3739
- # @param [MglData] a
3740
- # @param [String] stl default=""
3741
- # @param [Float] sval default=NAN
3742
- # @param [String] opt default=""
3743
- # @return [nil]
3744
- def cont_fz
3745
- end
3746
-
3747
-
3748
- # Other plotting.
3749
- # Draws command function 'y(x)' at plane z=Min.z where 'x' variable is changed in xrange. You do not need to create the data arrays to plot it. See also plot.
3750
- #
3751
- # @overload fplot(eqy,pen="",opt="")
3752
- # @param [String] eqy
3753
- # @param [String] pen default=""
3754
- # @param [String] opt default=""
3755
- # @return [nil]
3756
- def fplot
3757
- end
3758
-
3759
-
3760
- # Other plotting.
3761
- # Draws command parametrical curve ('x(t)', 'y(t)', 'z(t)') where 't' variable is changed in range (0, 1). You do not need to create the data arrays to plot it. See also plot.
3762
- #
3763
- # @overload fplot(eqx,eqy,eqz,pen,opt="")
3764
- # @param [String] eqx
3765
- # @param [String] eqy
3766
- # @param [String] eqz
3767
- # @param [String] pen
3768
- # @param [String] opt default=""
3769
- # @return [nil]
3770
- def fplot
3771
- end
3772
-
3773
-
3774
- # Other plotting.
3775
- # Draws command surface for function 'z(x,y)' where 'x', 'y' variable are changed in xrange, yrange. You do not need to create the data arrays to plot it. See also surf.
3776
- #
3777
- # @overload fsurf(eqz,sch="",opt="")
3778
- # @param [String] eqz
3779
- # @param [String] sch default=""
3780
- # @param [String] opt default=""
3781
- # @return [nil]
3782
- def fsurf
3783
- end
3784
-
3785
-
3786
- # Other plotting.
3787
- # Draws command parametrical surface ('x(u,v)', 'y(u,v)', 'z(u,v)') where 'u', 'v' variable are changed in range (0, 1). You do not need to create the data arrays to plot it. See also surf.
3788
- #
3789
- # @overload fsurf(eqx,eqy,eqz,sch="",opt="")
3790
- # @param [String] eqx
3791
- # @param [String] eqy
3792
- # @param [String] eqz
3793
- # @param [String] sch default=""
3794
- # @param [String] opt default=""
3795
- # @return [nil]
3796
- def fsurf
3797
- end
3798
-
3799
-
3800
- # Other plotting.
3801
- # The function draws the surface of triangles. Triangle vertexes are set by indexes id of data points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also dots, crust, quadplot, triangulation. TriPlot and QuadPlot
3802
- #
3803
- # @overload tri_plot(id,x,y,sch="",opt="")
3804
- # @param [MglData] id
3805
- # @param [MglData] x
3806
- # @param [MglData] y
3807
- # @param [String] sch default=""
3808
- # @param [String] opt default=""
3809
- # @return [nil]
3810
- #
3811
- # @overload tri_plot(id,x,y,z,c,sch="",opt="")
3812
- # @param [MglData] id
3813
- # @param [MglData] x
3814
- # @param [MglData] y
3815
- # @param [MglData] z
3816
- # @param [MglData] c
3817
- # @param [String] sch default=""
3818
- # @param [String] opt default=""
3819
- # @return [nil]
3820
- #
3821
- # @overload tri_plot(id,x,y,z,sch="",opt="")
3822
- # @param [MglData] id
3823
- # @param [MglData] x
3824
- # @param [MglData] y
3825
- # @param [MglData] z
3826
- # @param [String] sch default=""
3827
- # @param [String] opt default=""
3828
- # @return [nil]
3829
- def tri_plot
3830
- end
3831
-
3832
-
3833
- # Other plotting.
3834
- # The function draws contour lines for surface of triangles at z=v(k) (or at z = Min.z if sch contain symbol '_'). Triangle vertexes are set by indexes id of data points (x(i), y(i), z(i)). Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. String sch sets the color scheme. Array c (if specified) is used for contour coloring. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot, cont, triangulation.
3835
- #
3836
- # @overload tri_cont(id,x,y,z,c,sch="",opt="")
3837
- # @param [MglData] id
3838
- # @param [MglData] x
3839
- # @param [MglData] y
3840
- # @param [MglData] z
3841
- # @param [MglData] c
3842
- # @param [String] sch default=""
3843
- # @param [String] opt default=""
3844
- # @return [nil]
3845
- #
3846
- # @overload tri_cont(id,x,y,z,sch="",opt="")
3847
- # @param [MglData] id
3848
- # @param [MglData] x
3849
- # @param [MglData] y
3850
- # @param [MglData] z
3851
- # @param [String] sch default=""
3852
- # @param [String] opt default=""
3853
- # @return [nil]
3854
- def tri_cont
3855
- end
3856
-
3857
-
3858
- # Other plotting.
3859
- # The function draws contour lines for surface of triangles at z=v(k) (or at z = Min.z if sch contain symbol '_'). Triangle vertexes are set by indexes id of data points (x(i), y(i), z(i)). Contours are plotted for z(i,j)=v(k) where v(k) are values of data array v. String sch sets the color scheme. Array c (if specified) is used for contour coloring. First dimensions of id must be 3 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of triangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot, cont, triangulation.
3860
- #
3861
- # @overload tri_cont_v(v,id,x,y,z,c,sch="",opt="")
3862
- # @param [MglData] v
3863
- # @param [MglData] id
3864
- # @param [MglData] x
3865
- # @param [MglData] y
3866
- # @param [MglData] z
3867
- # @param [MglData] c
3868
- # @param [String] sch default=""
3869
- # @param [String] opt default=""
3870
- # @return [nil]
3871
- #
3872
- # @overload tri_cont_v(v,id,x,y,z,sch="",opt="")
3873
- # @param [MglData] v
3874
- # @param [MglData] id
3875
- # @param [MglData] x
3876
- # @param [MglData] y
3877
- # @param [MglData] z
3878
- # @param [String] sch default=""
3879
- # @param [String] opt default=""
3880
- # @return [nil]
3881
- def tri_cont_v
3882
- end
3883
-
3884
-
3885
- # Other plotting.
3886
- # The function draws the surface of quadrangles. Quadrangles vertexes are set by indexes id of data points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. First dimensions of id must be 4 or greater. Arrays x, y, z must have equal sizes. Parameter c set the colors of quadrangles (if id.ny=c.nx) or colors of vertexes (if x.nx=c.nx). See also triplot. TriPlot and QuadPlot
3887
- #
3888
- # @overload quad_plot(id,x,y,sch="",opt="")
3889
- # @param [MglData] id
3890
- # @param [MglData] x
3891
- # @param [MglData] y
3892
- # @param [String] sch default=""
3893
- # @param [String] opt default=""
3894
- # @return [nil]
3895
- #
3896
- # @overload quad_plot(id,x,y,z,c,sch="",opt="")
3897
- # @param [MglData] id
3898
- # @param [MglData] x
3899
- # @param [MglData] y
3900
- # @param [MglData] z
3901
- # @param [MglData] c
3902
- # @param [String] sch default=""
3903
- # @param [String] opt default=""
3904
- # @return [nil]
3905
- #
3906
- # @overload quad_plot(id,x,y,z,sch="",opt="")
3907
- # @param [MglData] id
3908
- # @param [MglData] x
3909
- # @param [MglData] y
3910
- # @param [MglData] z
3911
- # @param [String] sch default=""
3912
- # @param [String] opt default=""
3913
- # @return [nil]
3914
- def quad_plot
3915
- end
3916
-
3917
-
3918
- # Other plotting.
3919
- # The function draws the arbitrary placed points (x(i), y(i), z(i)). String sch sets the color scheme. If array a is specified then it define colors of dots. Arrays x, y, z, a must have equal sizes. See also crust, mark, plot. Dots sample
3920
- #
3921
- # @overload dots(x,y,z,sch="",opt="")
3922
- # @param [MglData] x
3923
- # @param [MglData] y
3924
- # @param [MglData] z
3925
- # @param [String] sch default=""
3926
- # @param [String] opt default=""
3927
- # @return [nil]
3928
- #
3929
- # @overload dots(x,y,z,a,sch="",opt="")
3930
- # @param [MglData] x
3931
- # @param [MglData] y
3932
- # @param [MglData] z
3933
- # @param [MglData] a
3934
- # @param [String] sch default=""
3935
- # @param [String] opt default=""
3936
- # @return [nil]
3937
- def dots
3938
- end
3939
-
3940
-
3941
- # Other plotting.
3942
- # The function reconstruct and draws the surface for arbitrary placed points (x(i), y(i), z(i)). String sch sets the color scheme. If string contain '#' then wire plot is produced. Arrays x, y, z must have equal sizes. See also dots, triplot. @c Crust sample
3943
- #
3944
- # @overload crust(x,y,z,sch="",opt="")
3945
- # @param [MglData] x
3946
- # @param [MglData] y
3947
- # @param [MglData] z
3948
- # @param [String] sch default=""
3949
- # @param [String] opt default=""
3950
- # @return [nil]
3951
- def crust
3952
- end
3953
-
3954
-
3955
- # Nonlinear fitting.
3956
- # Fit data along x-, y- and z-directions for array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) with weight factor s(i,j,k).
3957
- #
3958
- # @overload fit_s(a,s,func,var,opt="")
3959
- # @param [MglData] a
3960
- # @param [MglData] s
3961
- # @param [String] func
3962
- # @param [String] var
3963
- # @param [String] opt default=""
3964
- # @return [MglData]
3965
- #
3966
- # @overload fit_s(a,s,func,var,ini,opt="")
3967
- # @param [MglData] a
3968
- # @param [MglData] s
3969
- # @param [String] func
3970
- # @param [String] var
3971
- # @param [MglData] ini
3972
- # @param [String] opt default=""
3973
- # @return [MglData]
3974
- #
3975
- # @overload fit_s(x,a,s,func,var,opt="")
3976
- # @param [MglData] x
3977
- # @param [MglData] a
3978
- # @param [MglData] s
3979
- # @param [String] func
3980
- # @param [String] var
3981
- # @param [String] opt default=""
3982
- # @return [MglData]
3983
- #
3984
- # @overload fit_s(x,a,s,func,var,ini,opt="")
3985
- # @param [MglData] x
3986
- # @param [MglData] a
3987
- # @param [MglData] s
3988
- # @param [String] func
3989
- # @param [String] var
3990
- # @param [MglData] ini
3991
- # @param [String] opt default=""
3992
- # @return [MglData]
3993
- #
3994
- # @overload fit_s(x,y,a,s,func,var,opt="")
3995
- # @param [MglData] x
3996
- # @param [MglData] y
3997
- # @param [MglData] a
3998
- # @param [MglData] s
3999
- # @param [String] func
4000
- # @param [String] var
4001
- # @param [String] opt default=""
4002
- # @return [MglData]
4003
- #
4004
- # @overload fit_s(x,y,a,s,func,var,ini,opt="")
4005
- # @param [MglData] x
4006
- # @param [MglData] y
4007
- # @param [MglData] a
4008
- # @param [MglData] s
4009
- # @param [String] func
4010
- # @param [String] var
4011
- # @param [MglData] ini
4012
- # @param [String] opt default=""
4013
- # @return [MglData]
4014
- #
4015
- # @overload fit_s(x,y,z,a,s,func,var,opt="")
4016
- # @param [MglData] x
4017
- # @param [MglData] y
4018
- # @param [MglData] z
4019
- # @param [MglData] a
4020
- # @param [MglData] s
4021
- # @param [String] func
4022
- # @param [String] var
4023
- # @param [String] opt default=""
4024
- # @return [MglData]
4025
- #
4026
- # @overload fit_s(x,y,z,a,s,func,var,ini,opt="")
4027
- # @param [MglData] x
4028
- # @param [MglData] y
4029
- # @param [MglData] z
4030
- # @param [MglData] a
4031
- # @param [MglData] s
4032
- # @param [String] func
4033
- # @param [String] var
4034
- # @param [MglData] ini
4035
- # @param [String] opt default=""
4036
- # @return [MglData]
4037
- def fit_s
4038
- end
4039
-
4040
-
4041
- # Nonlinear fitting.
4042
- # Fit data along x-, y- and z-directions for array specified parametrically a(i,j,k)(x(i,j,k), y(i,j,k), z(i,j,k)) with weight factor 1.
4043
- #
4044
- # @overload fit(a,func,var,opt="")
4045
- # @param [MglData] a
4046
- # @param [String] func
4047
- # @param [String] var
4048
- # @param [String] opt default=""
4049
- # @return [MglData]
4050
- #
4051
- # @overload fit(a,func,var,ini,opt="")
4052
- # @param [MglData] a
4053
- # @param [String] func
4054
- # @param [String] var
4055
- # @param [MglData] ini
4056
- # @param [String] opt default=""
4057
- # @return [MglData]
4058
- #
4059
- # @overload fit(x,a,func,var,opt="")
4060
- # @param [MglData] x
4061
- # @param [MglData] a
4062
- # @param [String] func
4063
- # @param [String] var
4064
- # @param [String] opt default=""
4065
- # @return [MglData]
4066
- #
4067
- # @overload fit(x,a,func,var,ini,opt="")
4068
- # @param [MglData] x
4069
- # @param [MglData] a
4070
- # @param [String] func
4071
- # @param [String] var
4072
- # @param [MglData] ini
4073
- # @param [String] opt default=""
4074
- # @return [MglData]
4075
- #
4076
- # @overload fit(x,y,a,func,var,opt="")
4077
- # @param [MglData] x
4078
- # @param [MglData] y
4079
- # @param [MglData] a
4080
- # @param [String] func
4081
- # @param [String] var
4082
- # @param [String] opt default=""
4083
- # @return [MglData]
4084
- #
4085
- # @overload fit(x,y,a,func,var,ini,opt="")
4086
- # @param [MglData] x
4087
- # @param [MglData] y
4088
- # @param [MglData] a
4089
- # @param [String] func
4090
- # @param [String] var
4091
- # @param [MglData] ini
4092
- # @param [String] opt default=""
4093
- # @return [MglData]
4094
- #
4095
- # @overload fit(x,y,z,a,func,var,opt="")
4096
- # @param [MglData] x
4097
- # @param [MglData] y
4098
- # @param [MglData] z
4099
- # @param [MglData] a
4100
- # @param [String] func
4101
- # @param [String] var
4102
- # @param [String] opt default=""
4103
- # @return [MglData]
4104
- #
4105
- # @overload fit(x,y,z,a,func,var,ini,opt="")
4106
- # @param [MglData] x
4107
- # @param [MglData] y
4108
- # @param [MglData] z
4109
- # @param [MglData] a
4110
- # @param [String] func
4111
- # @param [String] var
4112
- # @param [MglData] ini
4113
- # @param [String] opt default=""
4114
- # @return [MglData]
4115
- def fit
4116
- end
4117
-
4118
-
4119
- # Nonlinear fitting.
4120
- # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval (Min, Max).
4121
- #
4122
- # @overload fit2(a,func,var,opt="")
4123
- # @param [MglData] a
4124
- # @param [String] func
4125
- # @param [String] var
4126
- # @param [String] opt default=""
4127
- # @return [MglData]
4128
- #
4129
- # @overload fit2(fit,a,func,var,ini,opt="")
4130
- # @param [MglData] fit
4131
- # @param [MglData] a
4132
- # @param [String] func
4133
- # @param [String] var
4134
- # @param [MglData] ini
4135
- # @param [String] opt default=""
4136
- # @return [MglData]
4137
- def fit2
4138
- end
4139
-
4140
-
4141
- # Nonlinear fitting.
4142
- # Fit data along all directions for 2d or 3d arrays a with s=1 and x, y, z equidistantly distributed in interval (Min, Max).
4143
- #
4144
- # @overload fit3(fit,a,func,var,opt="")
4145
- # @param [MglData] fit
4146
- # @param [MglData] a
4147
- # @param [String] func
4148
- # @param [String] var
4149
- # @param [String] opt default=""
4150
- # @return [MglData]
4151
- #
4152
- # @overload fit3(fit,a,func,var,ini,opt="")
4153
- # @param [MglData] fit
4154
- # @param [MglData] a
4155
- # @param [String] func
4156
- # @param [String] var
4157
- # @param [MglData] ini
4158
- # @param [String] opt default=""
4159
- # @return [MglData]
4160
- def fit3
4161
- end
4162
-
4163
-
4164
- # Nonlinear fitting.
4165
- # Print last fitted formula with found coefficients (as numbers) at position p0. The string prefix will be printed before formula. All other parameters are the same as in Text printing.
4166
- #
4167
- # @overload puts_fit(p,prefix="",font="",size=-1)
4168
- # @param [MglPoint] p
4169
- # @param [String] prefix default=""
4170
- # @param [String] font default=""
4171
- # @param [Float] size default=-1
4172
- # @return [nil]
4173
- def puts_fit
4174
- end
4175
-
4176
-
4177
- # Nonlinear fitting.
4178
- # Get last fitted formula with found coefficients (as numbers).
4179
- #
4180
- # @overload get_fit()
4181
- # @return [String]
4182
- def get_fit
4183
- end
4184
-
4185
-
4186
- # Data manipulation.
4187
- # These functions make distribution (histogram) of data. They do not draw the obtained data themselves. These functions can be useful if user have data defined for random points (for example, after PIC simulation) and he want to produce a plot which require regular data (defined on grid(s)). The range for grids is always selected as axis range. Arrays x, y, z define the positions (coordinates) of random points. Array a define the data value. Number of points in output array res is selected as maximal value of res size and the value of mglFitPnts.
4188
- #
4189
- # @overload hist(x,a,opt="")
4190
- # @param [MglData] x
4191
- # @param [MglData] a
4192
- # @param [String] opt default=""
4193
- # @return [MglData]
4194
- #
4195
- # @overload hist(x,y,a,opt="")
4196
- # @param [MglData] x
4197
- # @param [MglData] y
4198
- # @param [MglData] a
4199
- # @param [String] opt default=""
4200
- # @return [MglData]
4201
- #
4202
- # @overload hist(x,y,z,a,opt="")
4203
- # @param [MglData] x
4204
- # @param [MglData] y
4205
- # @param [MglData] z
4206
- # @param [MglData] a
4207
- # @param [String] opt default=""
4208
- # @return [MglData]
4209
- def hist
4210
- end
4211
-
4212
-
4213
- # Data manipulation.
4214
- # Fills the value of array 'u' according to the formula in string eq. Formula is an arbitrary expression depending on variables 'x', 'y', 'z', 'u', 'v', 'w'. Coordinates 'x', 'y', 'z' are supposed to be normalized in axis range. Variable 'u' is the original value of the array. Variables 'v' and 'w' are values of arrays v, w which can be NULL (i.e. can be omitted).
4215
- #
4216
- # @overload fill(u,eq,opt="")
4217
- # @param [MglData] u
4218
- # @param [String] eq
4219
- # @param [String] opt default=""
4220
- # @return [nil]
4221
- #
4222
- # @overload fill(u,eq,v,opt="")
4223
- # @param [MglData] u
4224
- # @param [String] eq
4225
- # @param [MglData] v
4226
- # @param [String] opt default=""
4227
- # @return [nil]
4228
- #
4229
- # @overload fill(u,eq,v,w,opt="")
4230
- # @param [MglData] u
4231
- # @param [String] eq
4232
- # @param [MglData] v
4233
- # @param [MglData] w
4234
- # @param [String] opt default=""
4235
- # @return [nil]
4236
- def fill
4237
- end
4238
-
4239
-
4240
- # Data manipulation.
4241
- # Fills the value of array 'u' according to the linear interpolation of triangulated surface, found for arbitrary placed points 'x', 'y', 'z'. Interpolation is done at points equidistantly distributed in axis range. NAN value is used for grid points placed outside of triangulated surface.
4242
- #
4243
- # @overload data_grid(u,x,y,z,opt="")
4244
- # @param [MglData] u
4245
- # @param [MglData] x
4246
- # @param [MglData] y
4247
- # @param [MglData] z
4248
- # @param [String] opt default=""
4249
- # @return [nil]
4250
- def data_grid
4251
- end
4252
-
4253
-
4254
- # Data manipulation.
4255
- # Solves equation du/dz = i*k0*ham(p,q,x,y,z,|u|)(u), where p=-i/k0*d/dx, q=-i/k0*d/dy are pseudo-differential operators. Parameters ini_re, ini_im specify real and imaginary part of initial field distribution. Coordinates 'x', 'y', 'z' are supposed to be normalized in axis range. Note, that really this ranges are increased by factor 3/2 for purpose of reducing reflection from boundaries. Parameter dz set the step along evolutionary coordinate z. At this moment, simplified form of function ham is supported -- all ``mixed'' terms (like 'x*p'->x*d/dx) are excluded. For example, in 2D case this function is effectively ham = f(p,z) + g(x,z,u). However commutable combinations (like 'x*q'->x*d/dy) are allowed. Here variable 'u' is used for field amplitude |u|. This allow one solve nonlinear problems -- for example, for nonlinear Shrodinger equation you may set ham="p^2 + q^2 - u^2". You may specify imaginary part for wave absorption, like ham = "p^2 + i*x*(x>0)", but only if dependence on variable 'i' is linear (i.e. ham = hre+i*him). PDE solving hints
4256
- #
4257
- # @overload pde(ham,ini_re,ini_im,dz=0.1,k0=100,opt="")
4258
- # @param [String] ham
4259
- # @param [MglData] ini_re
4260
- # @param [MglData] ini_im
4261
- # @param [Float] dz default=0.1
4262
- # @param [Float] k0 default=100
4263
- # @param [String] opt default=""
4264
- # @return [MglData]
4265
- def pde
4266
- end
4267
-
4268
-
4269
- end # MglGraph
4270
-
4271
- end