ruby-gr 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb0e07aec1fa9f4377df0a4c6c0765802f56ca299975970716b86d8aebf2273
-  data.tar.gz: 61a995043b20ba81623a96f45ca4689a9be49e8a5451497bc997cbbdee412361
+  metadata.gz: 1d9ef46d38e4a4cb1d52b933af0b1d3a44de17e780bbb0dc404ac62a40026827
+  data.tar.gz: 9084d96ecd560a87d7540d736e87312cc3351f85bcdc4a2ed1a4eb5b590b3ed0
 SHA512:
-  metadata.gz: 168285500cbd4c3a343001f3ad7649d03f37155da471546796569bf107018bd83d9c0b9af5c2a9c58b03b49163fc211f24156037abefc4f7bab459d4f1ed488a
-  data.tar.gz: da487fbc4d174d079b550e7fd2539defb66a4a9981c3af2b8d518e84f97dcc0bfecf52e83e9271817e2fe149252ef735b23132b33aa95a587009343951ad9d26
+  metadata.gz: 5b4acddc1c8237754644b1e75b9b11d87364e0ef2d5fac59e9ce5685464dcab180817e130a0b244cf27ac3716d0c9e1e6f78192b031a229b42cc1157117aea70
+  data.tar.gz: cf0daf98117cf7408bb1b8f3e33006043a0cd3c7f17da6f0521d98b2ebf5788be88defc0e6909ed00101a1f3a9023dbfb3cc9879b86c79193fc6750d8f6022f9

data/LICENSE.txt

@@ -20,3 +20,27 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+The Fiddley module is:
+
+Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -49,10 +49,49 @@ GR.plot(x, y)
 
 ## Examples
 
-Have a look in the [`examples`](https://github.com/red-data-tools/GR.rb/tree/master/examples) directory. 
+Have a look in the [`examples`](https://github.com/red-data-tools/GR.rb/tree/master/examples) directory. Start with [`fast_plot`](https://github.com/red-data-tools/GR.rb/blob/master/examples/fast_plots.rb).
+
+## Features
+
+#### GR::Plot
+
+A simple, matlab-style API.
+
+```ruby
+require 'gr/plot'
+```
+
+`plot` `step` `scatter` `stem` `histogram` `contour` `contourf` `hexbin` `heatmap` `wireframe` `surface` `plot3` `scatter3` `imshow` `isosurface` `polar` `polarhist` `polarheatmap` `trisurf` `tricont` `shade` `volume`
+
+#### GR
+
+```ruby
+require 'gr'
+```
+
+#### GR3
+
+```ruby
+require 'gr3'
+```
+
+## Documentation
+
+- [GR Framework](https://gr-framework.org/)
+- [GR.rb API Documentation](https://rubydoc.info/gems/ruby-gr)
 
 ## GR Installation
 
+### Official binary release
+
+Download the [latest release](https://github.com/sciapp/gr/releases).
+
+Set environment variable GRDIR.
+
+```sh
+export GRDIR="your/path/to/gr"
+```
+
 ### Homebrew
 
 ```sh
@@ -65,16 +104,20 @@ Set environment variable GRDIR.
 export GRDIR=$(brew --prefix libgr)
 ```
 
-### Mac Linux Windows
+If you fail to build libgr using homebrew, Please feel free to [send us your feedback](https://github.com/red-data-tools/GR.rb/issues).
 
-Download the [latest release](https://github.com/sciapp/gr/releases).
+## Backend for Charty
 
-Set environment variable GRDIR.
-
-```sh
-export GRDIR="your/path/to/gr"
-```
+GR.rb is expected to be the backend for [Charty](https://github.com/red-data-tools/charty) in the future.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/red-data-tools/GR.rb.
+* Report bugs
+* Fix bugs and submit pull requests
+* Write, clarify, or fix documentation
+* Suggest or add new features
+
+## Acknowledgements
+
+We would like to thank Josef Heinen, the creator of [GR.jl](https://github.com/jheinen/GR.jl) and Florian Rhiem, the creator of  [python-gr](https://github.com/sciapp/python-gr).
+

data/lib/gr.rb

@@ -529,6 +529,13 @@ module GR
       super
     end
 
+    # Gets the current text color index.
+    # This function gets the color of text output primitives.
+    # @return [Integer] color The text color index (COLOR < 1256)
+    def inqtextcolorind
+      inquiry_int { |pt| super(pt) }
+    end
+
     # Set the current character height.
     # @param height [Numeric] Text height value
     # `setcharheight` defines the height of subsequent text output primitives. Text height
@@ -1399,12 +1406,14 @@ module GR
 
     # @return [Integer]
     def readimage(path)
+      # Feel free to make a pull request if you catch a mistake
+      # or you have an idea to improve it.
       data = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INTPTR_T)
       w, h = inquiry [:int, :int] do |width, height|
         # data is a pointer of a pointer
         super(path, width, height, data.ref)
       end
-      d = data.to_str(w * h * 4).unpack('L*') # UINT8
+      d = data.to_str(w * h * Fiddle::SIZEOF_INT).unpack('L*') # UInt32
       [w, h, d]
     end
 
@@ -1560,6 +1569,26 @@ module GR
       super
     end
 
+    def delaunay(x, y)
+      # Feel free to make a pull request if you catch a mistake
+      # or you have an idea to improve it.
+      npoints = equal_length(x, y)
+      triangles = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INTPTR_T)
+      dim = 3
+      n_tri = inquiry_int do |ntri|
+        super(npoints, x, y, ntri, triangles.ref)
+      end
+      if n_tri > 0
+        tri = triangles.to_str(3 * n_tri * Fiddle::SIZEOF_INT).unpack('l*') # Int32
+        # Ruby  : 0-based indexing
+        # Julia : 1-based indexing
+        tri = tri.each_slice(3).to_a
+        [n_tri, tri]
+      else
+        0
+      end
+    end
+
     # Reduces the number of points of the x and y array.
     def reducepoints(xd, yd, n)
       nd = equal_length(xd, yd)
@@ -1913,6 +1942,39 @@ module GR
         super(*pts)
       end
     end
+
+    # Set the scale factor for each axis. A one means no scale.
+    # All factor have to be != 0.
+    # @param x_axis_scale [Numeric] factor for scaling the x-axis
+    # @param y_axis_scale [Numeric] factor for scaling the y-axis
+    # @param z_axis_scale [Numeric] factor for scaling the z-axis
+    def setscalefactors3d(*)
+      super
+    end
+
+    # Returns the scale factors for each axis.
+    def inqscalefactors3d
+      inquiry %i[double double double] do |*opts|
+        super(*opts)
+      end
+    end
+
+    # This is an interface for REPL based languages to enable an easier way to
+    # rotate around an object.
+    # The center of the 3d window is used as the focus point and the camera is
+    # positioned relative to it, using spherical coordinates. This function can
+    # therefore also be used if the user prefers spherical coordinates to setting
+    # the direct camera position, but with reduced functionality in comparison
+    # to gr.settransformationparameters, gr.setperspectiveprojection and
+    # gr.setorthographicprojection.
+    # @param phi [Numeric] phi angle of the spherical coordinates
+    # @param theta [Numeric] theta angle of the spherical coordinates
+    # @param fov [Numeric] vertical field of view (0 or NaN for orthographic projection)
+    # @param radius [Numeric] distance between the camera and the focus point
+    #   (0 or NaN for the radius of the object's smallest bounding sphere)
+    def transformationinterfaceforrepl(*)
+      super
+    end
   end
 
   ASF_BUNDLED    = 0
@@ -2147,4 +2209,21 @@ module GR
   UPSAMPLE_HORIZONTAL_LANCZOS   = 0x00000300
   DOWNSAMPLE_VERTICAL_LANCZOS   = 0x00030000
   DOWNSAMPLE_HORIZONTAL_LANCZOS = 0x03000000
+
+  RESAMPLE_DEFAULT =
+    (UPSAMPLE_VERTICAL_DEFAULT | UPSAMPLE_HORIZONTAL_DEFAULT |
+     DOWNSAMPLE_VERTICAL_DEFAULT | DOWNSAMPLE_HORIZONTAL_DEFAULT)
+  RESAMPLE_NEAREST =
+    (UPSAMPLE_VERTICAL_NEAREST | UPSAMPLE_HORIZONTAL_NEAREST |
+     DOWNSAMPLE_VERTICAL_NEAREST | DOWNSAMPLE_HORIZONTAL_NEAREST)
+  RESAMPLE_LINEAR =
+    (UPSAMPLE_VERTICAL_LINEAR | UPSAMPLE_HORIZONTAL_LINEAR |
+     DOWNSAMPLE_VERTICAL_LINEAR | DOWNSAMPLE_HORIZONTAL_LINEAR)
+  RESAMPLE_LANCZOS =
+    (UPSAMPLE_VERTICAL_LANCZOS | UPSAMPLE_HORIZONTAL_LANCZOS |
+     DOWNSAMPLE_VERTICAL_LANCZOS | DOWNSAMPLE_HORIZONTAL_LANCZOS)
+
+  PROJECTION_DEFAULT = 0
+  PROJECTION_ORTHOGRAPHIC = 1
+  PROJECTION_PERSPECTIVE = 2
 end

data/lib/gr/ffi.rb

@@ -61,6 +61,7 @@ module GR
     try_extern 'void gr_setcharexpan(double)'
     try_extern 'void gr_setcharspace(double)'
     try_extern 'void gr_settextcolorind(int)'
+    try_extern 'void gr_inqtextcolorind(int *)'
     try_extern 'void gr_setcharheight(double)'
     try_extern 'void gr_setcharup(double, double)'
     try_extern 'void gr_settextpath(int)'
@@ -160,7 +161,7 @@ module GR
     try_extern 'void gr_selectcontext(int)'
     try_extern 'void gr_destroycontext(int)'
     try_extern 'int gr_uselinespec(char *)'
-    # try_extern 'void gr_delaunay(int, const double *, const double *, int *, int **)'
+    try_extern 'void gr_delaunay(int, const double *, const double *, int *, int **)'
     try_extern 'void gr_reducepoints(int, const double *, const double *, int, double *, double *)'
     try_extern 'void gr_trisurface(int, double *, double *, double *)'
     try_extern 'void gr_gradient(int, int, double *, double *, double *, double *, double *)'
@@ -193,5 +194,8 @@ module GR
     try_extern 'void gr_camerainteraction(double, double, double, double)'
     try_extern 'void gr_setwindow3d(double, double, double, double, double, double)'
     try_extern 'void gr_inqwindow3d(double *, double *, double *, double *, double *, double *)'
+    try_extern 'void gr_setscalefactors3d(double, double, double)'
+    try_extern 'void gr_inqscalefactors3d(double *, double *, double *)'
+    try_extern 'void gr_transformationinterfaceforrepl(double, double, double, double)'
   end
 end

data/lib/gr/plot.rb

@@ -172,6 +172,7 @@ module GR
         scale |= GR::OPTION_FLIP_Y if kvs[:yflip]
         scale |= GR::OPTION_FLIP_Z if kvs[:zflip]
       end
+      kvs[:scale] = scale
       if kvs.has_key?(:panzoom)
         xmin, xmax, ymin, ymax = GR.panzoom(*kvs[:panzoom])
         kvs[:xrange] = [xmin, xmax]
@@ -561,6 +562,8 @@ module GR
         # Not yet.
       end
 
+      GR.settextfontprec(232, 3)
+
       set_viewport(kind, kvs[:subplot])
       unless kvs[:ax]
         set_window(kind)
@@ -821,7 +824,7 @@ module GR
           plot_polar(x, y)
 
         when :trisurf
-          GR._trisurface_(x, y, z)
+          GR.trisurface(x, y, z)
           draw_axes(kind, 2)
           colorbar(0.05)
 
@@ -1035,9 +1038,12 @@ module GR
     def minmax
       xmin = ymin = zmin = cmin = Float::INFINITY
       xmax = ymax = zmax = cmax = -Float::INFINITY
-
+      scale = kvs[:scale]
       args.each do |x, y, z, c|
         if x
+          if scale & GR::OPTION_X_LOG != 0
+            x.map! { |v| v > 0 ? v : Float::NAN }
+          end
           x0, x1 = x.minmax
           xmin = [x0, xmin].min
           xmax = [x1, xmax].max
@@ -1046,6 +1052,9 @@ module GR
           xmax = 1
         end
         if y
+          if scale & GR::OPTION_Y_LOG != 0
+            y.map! { |v| v > 0 ? v : Float::NAN }
+          end
           y0, y1 = y.minmax
           ymin = [y0, ymin].min
           ymax = [y1, ymax].max
@@ -1054,6 +1063,9 @@ module GR
           ymax = 1
         end
         if z
+          if scale & GR::OPTION_Z_LOG != 0
+            z.map! { |v| v > 0 ? v : Float::NAN }
+          end
           z0, z1 = z.minmax
           zmin = [z0, zmin].min
           zmax = [z1, zmax].max
@@ -1114,7 +1126,7 @@ module GR
       kvs[:labels].each do |label|
         label = label.to_s
         tbx, tby = inqtext(0, 0, label)
-        w = [w, tbx[2]].max
+        w = [w, tbx[2] - tbx[0]].max
         h += [tby[2] - tby[0], 0.03].max
       end
       GR.setscale(scale)
@@ -1140,26 +1152,27 @@ module GR
   end
 
   class << self
-    # Draw one or more line plots.
+    # (Plot) Draw one or more line plots.
     def plot(*args)
       create_plot(:line, *args)
     end
 
-    # Draw one or more step or staircase plots.
+    # (Plot) Draw one or more step or staircase plots.
     def step(*args)
       create_plot(:step, *args)
     end
 
-    # Draw one or more scatter plots.
+    # (Plot) Draw one or more scatter plots.
     def scatter(*args)
       create_plot(:scatter, *args)
     end
 
-    # Draw a stem plot.
+    # (Plot) Draw a stem plot.
     def stem(*args)
       create_plot(:stem, *args)
     end
 
+    # (Plot)
     def polarhistogram(x, kv = {})
       plt = GR::Plot.new(x, kv)
       plt.kvs[:kind] = :polarhist
@@ -1169,7 +1182,7 @@ module GR
       plt.plot_data
     end
 
-    # Draw a heatmap.
+    # (Plot) Draw a heatmap.
     def heatmap(*args)
       # FIXME
       _x, _y, z, kv = parse_args(*args)
@@ -1182,6 +1195,7 @@ module GR
       end
     end
 
+    # (Plot) Draw a polarheatmap.
     def polarheatmap(*args)
       d = args.shift
       # FIXME
@@ -1197,77 +1211,79 @@ module GR
     end
 
     alias _contour_ contour
-    # Draw a contour plot.
+    # (Plot) Draw a contour plot.
     def contour(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:contour, x, y, z, kv)
     end
 
     alias _contourf_ contourf
-    # Draw a filled contour plot.
+    # (Plot) Draw a filled contour plot.
     def contourf(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:contourf, x, y, z, kv)
     end
 
     alias _hexbin_ hexbin
-    # Draw a hexagon binning plot.
+    # (Plot) Draw a hexagon binning plot.
     def hexbin(*args)
       create_plot(:hexbin, *args)
     end
 
-    # Draw a triangular contour plot.
+    # (Plot) Draw a triangular contour plot.
     def tricont(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:tricont, x, y, z, kv)
     end
 
-    # Draw a three-dimensional wireframe plot.
+    # (Plot) Draw a three-dimensional wireframe plot.
     def wireframe(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:wireframe, x, y, z, kv)
     end
 
-    # Draw a three-dimensional surface plot.
+    # (Plot) Draw a three-dimensional surface plot.
     alias _surface_ surface
     def surface(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:surface, x, y, z, kv)
     end
 
+    # (Plot)
     def polar(*args)
       create_plot(:polar, *args)
     end
 
-    alias _trisurface_ trisurface
-    # Draw a triangular surface plot.
-    def trisurface(*args)
+    # (Plot) Draw a triangular surface plot.
+    def trisurf(*args)
       x, y, z, kv = parse_args(*args)
       create_plot(:trisurf, x, y, z, kv)
     end
 
-    # Draw one or more three-dimensional line plots.
+    # (Plot) Draw one or more three-dimensional line plots.
     def plot3(*args)
       create_plot(:plot3, *args)
     end
 
-    # Draw one or more three-dimensional scatter plots.
+    # (Plot) Draw one or more three-dimensional scatter plots.
     def scatter3(*args)
       create_plot(:scatter3, *args)
     end
 
     alias _shade_ shade
+    # (Plot)
     def shade(*args)
       create_plot(:shade, *args)
     end
 
+    # (Plot)
     def volume(v, kv = {})
       create_plot(:volume, v, kv) do |plt|
         plt.args = [[nil, nil, v, nil, '']]
       end
     end
 
-    # Draw a bar plot.
+    # (Plot) Draw a bar plot.
     def barplot(labels, heights, kv = {})
       labels = labels.map(&:to_s)
       wc, hc = barcoordinates(heights)
@@ -1285,7 +1301,7 @@ module GR
       end
     end
 
-    # Draw a histogram.
+    # (Plot) Draw a histogram.
     def histogram(x, kv = {})
       create_plot(:hist, x, kv) do |plt|
         nbins = plt.kvs[:nbins] || 0
@@ -1294,7 +1310,7 @@ module GR
       end
     end
 
-    # Draw an image.
+    # (Plot) Draw an image.
     def imshow(img, kv = {})
       img = Numo::DFloat.cast(img) # Umm...
       create_plot(:imshow, img, kv) do |plt|
@@ -1302,7 +1318,7 @@ module GR
       end
     end
 
-    # Draw an isosurface.
+    # (Plot) Draw an isosurface.
     def isosurface(v, kv = {})
       v = Numo::DFloat.cast(v) # Umm...
       create_plot(:isosurface, v, kv) do |plt|
@@ -1310,6 +1326,7 @@ module GR
       end
     end
 
+    # (Plot) Save the current figure to a file.
     def savefig(filename, kv = {})
       GR.beginprint(filename)
       plt = GR::Plot.last_plot

data/lib/gr3/ffi.rb

@@ -73,8 +73,17 @@ module GR3
     try_extern 'void gr3_setviewmatrix(const float *m)'
     try_extern 'int gr3_getprojectiontype(void)'
     try_extern 'void gr3_setprojectiontype(int type)'
-    # try_extern 'unsigned int gr3_triangulate(const unsigned short *data, unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, gr3_triangle_t **triangles_p)'
-    # try_extern 'void gr3_triangulateindexed(const unsigned short *data, unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, unsigned int *num_vertices, gr3_coord_t **vertices, gr3_coord_t **normals, unsigned int *num_indices, unsigned int **indices)'
+    # try_extern 'unsigned int gr3_triangulate(const unsigned short *data, ' \
+    #      'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
+    #      'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \
+    #      'double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, ' \
+    #      'gr3_triangle_t **triangles_p)'
+    # try_extern 'void gr3_triangulateindexed(const unsigned short *data, ' \
+    #      'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
+    #      'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \
+    #      'double step_x, double step_y, double step_z, double offset_x, double offset_y, double offset_z, ' \
+    #      'unsigned int *num_vertices, gr3_coord_t **vertices, gr3_coord_t **normals, ' \
+    #      'unsigned int *num_indices, unsigned int **indices)'
     try_extern 'int gr3_createisosurfacemesh(int *mesh, unsigned short *data, ' \
            'unsigned short isolevel, unsigned int dim_x, unsigned int dim_y, unsigned int dim_z, ' \
            'unsigned int stride_x, unsigned int stride_y, unsigned int stride_z, ' \

data/lib/gr_commons/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GRCommons
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-gr
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler