ctioga2 0.4 → 0.5

data/lib/ctioga2/graphics/elements.rb

@@ -22,6 +22,7 @@ require 'ctioga2/graphics/elements/gradient-region'
 require 'ctioga2/graphics/elements/curve2d'
 require 'ctioga2/graphics/elements/parametric2d'
 require 'ctioga2/graphics/elements/xyz-map'
+require 'ctioga2/graphics/elements/xyz-contour'
 require 'ctioga2/graphics/elements/primitive'
 
 require 'ctioga2/graphics/elements/tangent'
@@ -29,7 +30,7 @@ require 'ctioga2/graphics/elements/contour'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 288 $', '$Date: 2011-02-22 21:12:58 +0100 (Tue, 22 Feb 2011) $')
+  Version::register_svn_info('$Revision: 405 $', '$Date: 2013-08-22 16:25:13 +0200 (Thu, 22 Aug 2013) $')
 
   module Graphics
 

data/lib/ctioga2/graphics/elements/containers.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
+  Version::register_svn_info('$Revision: 378 $', '$Date: 2013-03-04 22:42:54 +0100 (Mon, 04 Mar 2013) $')
 
   module Graphics
 
@@ -47,6 +47,10 @@ module CTioga2
         # object
         attr_accessor :legend_storage
 
+        # The current legend container to which legend items are added.
+        # Defaults to the #legend_storage, but it can be changed
+        attr_accessor :legend_item_target
+
         # Creates an empty new Container with the given _parent_.
         def initialize(parent = nil, root = nil)
           @parent = parent
@@ -60,6 +64,8 @@ module CTioga2
           @root_object = root
 
           @legend_storage = Legends::LegendStorage.new
+          
+          @legend_item_target = @legend_storage
 
           # By default, don't display legends.
           @legend_area = nil
@@ -98,9 +104,22 @@ module CTioga2
         end
 
 
-        # Adds a legend item to the #associated_legend_storage
+        # Adds a legend item to the current storage
         def add_legend_item(item)
-          @legend_storage.add_item(item)
+          @legend_item_target.add_item(item)
+        end
+
+        # Adds a legend item to the current storage and make that item
+        # the next target for legend items.
+        #
+        # If @a sub is nil, then switch back to the top
+        def enter_legend_subcontainer(sub)
+          if sub
+            add_legend_item(sub)
+            @legend_item_target = sub
+          else
+            @legend_item_target = @legend_storage
+          end
         end
 
         # \todo provide coordinate conversion facilities...

data/lib/ctioga2/graphics/elements/primitive.rb

@@ -22,7 +22,7 @@ require 'shellwords'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 370 $', '$Date: 2012-12-28 17:40:18 +0100 (Fri, 28 Dec 2012) $')
+  Version::register_svn_info('$Revision: 391 $', '$Date: 2013-03-14 11:04:36 +0100 (Thu, 14 Mar 2013) $')
 
   module Graphics
 
@@ -231,8 +231,8 @@ EOD
                          [ 'point', 'point' ], 
                          Styles::ArrowStyle,
                          'arrow') do |t, tail, head, style, options|
-          style.draw_arrow(t, *tail.to_figure_xy(t),
-                           *head.to_figure_xy(t))
+          style.draw_arrow(t, *( tail.to_figure_xy(t) + 
+                           head.to_figure_xy(t) ))
         end
 
         styled_primitive("line", "line", 
@@ -240,8 +240,8 @@ EOD
                          Styles::StrokeStyle,
                          'line'
                   ) do |t, tail, head, style, options|
-          style.draw_line(t, *(tail.to_figure_xy(t)),
-                          *(head.to_figure_xy(t)))
+          style.draw_line(t, *( tail.to_figure_xy(t) + 
+                          head.to_figure_xy(t) ))
         end
 
         # Here, we need to add deprecated options for backward

data/lib/ctioga2/graphics/elements/xyz-contour.rb

@@ -0,0 +1,123 @@
+# xyz-contour.rb: contour plot of a xyz set of data
+# copyright (c) 2013 by Vincent Fourmond
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details (in the COPYING file).
+
+require 'ctioga2/utils'
+require 'ctioga2/log'
+
+require 'Dobjects/Function'
+
+
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Graphics
+
+    module Elements
+
+      # This class displays a XYZ element using contour lines.
+      class XYZContour  < TiogaElement
+
+        include Log
+        include Dobjects
+
+        # The Data::Dataset object that should get plotted.
+        attr_accessor :dataset
+
+        # A Styles::CurveStyle object saying how the curve should be
+        # drawn.
+        #
+        # Some of the elements will be overridden.
+        attr_accessor :curve_style
+
+        # The IndexedTable object representing the underlying data
+        attr_accessor :table
+
+
+        undef :location=, :location
+        
+        # Creates a new XYZContour object with the given _dataset_ and
+        # _style_.
+        #
+        # Lots of code in common with XYZMap
+        def initialize(dataset, style = nil)
+          @dataset = dataset
+          @curve_style = style
+          prepare_data
+        end
+
+        # Prepares the internal storage of the data, from the @dataset
+        def prepare_data
+          @table = @dataset.indexed_table
+        end
+        
+        protected :prepare_data
+
+        # Returns the LocationStyle object of the curve. Returns the
+        # one from #curve_style.
+        def location
+          return @curve_style.location
+        end
+
+        # Returns the Types::Boundaries of this curve.
+        def get_boundaries
+          return @table.xy_boundaries
+        end
+        
+
+        ## Actually draws the curve
+        def real_do(t)
+          debug { "Plotting curve #{inspect}" }
+          t.context do
+            # Of course, there are still quite a few things to do
+            # ;-)...
+
+            # Ideas: for leaving things out, I may have to use min_gt
+            # along with masking.
+
+            ## @todo handle non-homogeneous XY maps.
+            
+            @curve_style.color_map ||= 
+              Styles::ColorMap.from_text("Red--Green")
+            
+            if @curve_style.zaxis
+              begin
+                @parent.style.get_axis_style(@curve_style.zaxis).
+                  set_color_map(@curve_style.color_map, 
+                                @table.table.min,
+                                @table.table.max)
+              rescue
+                error { "Could not set Z info to non-existent axis #{@curve_style.zaxis}" }
+              end
+            end
+
+            # Computation of equally spaced level lines
+            nb = 20
+
+            zmin = @table.table.min
+            zmax = @table.table.max
+
+            t.context do
+              @curve_style.line.set_stroke_style(t)
+              @curve_style.contour.plot_contours(t, table,
+                                                 zmin, zmax,
+                                                 @curve_style.color_map)
+            end
+
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/ctioga2/graphics/generator.rb

@@ -18,7 +18,7 @@ require 'ctioga2/graphics/coordinates'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 311 $', '$Date: 2012-04-16 22:51:59 +0200 (Mon, 16 Apr 2012) $')
+  Version::register_svn_info('$Revision: 412 $', '$Date: 2013-08-22 23:04:59 +0200 (Thu, 22 Aug 2013) $')
 
   module Graphics
 
@@ -73,13 +73,17 @@ module CTioga2
           CurveStyleFactory::PlotCommandOptions.key?(k)
         }
 
-
-        return send(@current_curves, plot, dataset, options)
+        curve = send(@current_curves, plot, dataset, options)
+        curve.curve_style.target = curve
+        return curve
       end
 
       private
       
       ## \name Available kinds of curves
+      ##
+      ## @todo All these are completely identical, there probably
+      ## isn't need for separate code ?
       # 
       # @{
       # 
@@ -98,11 +102,11 @@ module CTioga2
       def xy_parametric(plot, dataset, options = {})
         legend = @legend_provider.dataset_legend(dataset)
         style = @style_factory.next(options)
-        style.legend = false
         style.legend ||= legend # The legend specified as option to
                                 # the --plot command has precedence
                                 # over the one specified by --legend.
         curve = Graphics::Elements::Parametric2D.new(dataset, style)
+        style
         return curve
       end
 
@@ -110,14 +114,26 @@ module CTioga2
       def xyz_map(plot, dataset, options = {})
         legend = @legend_provider.dataset_legend(dataset)
         style = @style_factory.next(options)
-        style.legend = false
         style.legend ||= legend # The legend specified as option to
                                 # the --plot command has precedence
                                 # over the one specified by --legend.
+        style.legend = false    # No legend for XYZ maps
         curve = Graphics::Elements::XYZMap.new(dataset, style)
         return curve
       end
 
+      # XYZ maps
+      def xyz_contour(plot, dataset, options = {})
+        legend = @legend_provider.dataset_legend(dataset)
+        style = @style_factory.next(options)
+        style.legend ||= legend # The legend specified as option to
+                                # the --plot command has precedence
+                                # over the one specified by --legend.
+        style.legend = false    # No legend for XYZ maps
+        curve = Graphics::Elements::XYZContour.new(dataset, style)
+        return curve
+      end
+
 
       ## @}
       
@@ -141,6 +157,16 @@ module CTioga2
 Switch to XY parametric plots, that is standard XY plots whose appearance
 (such as color, marker color, and, potentially, marker kinds and more)
 are governed by one (or more ?) Z values.
+EOH
+
+    ContourPlotCommand = 
+      Cmd.new("contour",nil,"--contour") do |plotmaker|
+      plotmaker.curve_generator.current_curves = :xyz_contour
+    end
+    
+    ContourPlotCommand.describe('select contour plots', 
+                                     <<EOH, PlotTypesGroup)
+...
 EOH
 
     XYPlotCommand = 

data/lib/ctioga2/graphics/legends.rb

@@ -16,10 +16,11 @@ require 'ctioga2/graphics/legends/items'
 require 'ctioga2/graphics/legends/area'
 require 'ctioga2/graphics/legends/storage'
 require 'ctioga2/graphics/legends/provider'
+require 'ctioga2/graphics/legends/multicols'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 357 $', '$Date: 2012-12-26 00:49:11 +0100 (Wed, 26 Dec 2012) $')
+  Version::register_svn_info('$Revision: 432 $', '$Date: 2013-08-23 19:06:36 +0200 (Fri, 23 Aug 2013) $')
 
   module Graphics
 
@@ -52,6 +53,9 @@ EOH
     LegendLineCommand.describe("Adds a pure text line to the legend",
                                <<EOH, LegendGroup)
 Adds a line of text unrelated to any curve to the legend.
+
+The options controlling the aspect of the legend are documented in the 
+{command: define-text-style} command.
 EOH
 
     
@@ -82,9 +86,16 @@ EOH
                                 <<EOH, LegendGroup)
 Sets the various aspects of the style of the legends throught 
 its options:
- * @dy@: the spacing between consecutive lines
+ * @dy@: the spacing between the baseline of consecutive lines;
+   it is deprecated now in favor of @vpadding@;
+ * @vpadding@: the space left between the bottom of a line and the top of
+   the next one;
  * @scale@: the overall scale of the legends
- * @text_scale@: the scale of the text (and the markers) inside the legends
+ * @text-scale@: the scale of the text (and the markers) inside the legends
+
+The @frame-@ options control the drawing of a frame around the legend;
+they have the same meaning as corresponding ones of 
+{command: define-box-style} with the @frame-@ bit dropped.
 EOH
 
     LegendInsideCommand = 
@@ -107,5 +118,35 @@ As a shortcut, {command: legend-inside} also takes all the options that
 EOH
 
 
+    LegendMulticolOptions = Styles::MultiColumnLegendStyle.options_hash()
+
+    LegendMultiColCommand = 
+      Cmd.new("legend-multicol", nil, "--legend-multicol",
+              [], LegendMulticolOptions) do |plotmaker, options|
+      multicol = Legends::MultiColumnLegend.new
+      multicol.style.set_from_hash(options)
+      plotmaker.root_object.current_plot.
+        enter_legend_subcontainer(multicol)
+    end
+
+    LegendMultiColCommand.describe("Lay out legends in several columns",
+                                   <<EOH, LegendGroup)
+Following legends will be layed out in multiple columns, until a call
+to {command: legend-multicol-end}.
+EOH
+
+    LegendMultiColEndCommand = 
+      Cmd.new("legend-multicol-end", nil, "--legend-multicol-end",
+              [], {}) do |plotmaker, options|
+      plotmaker.root_object.current_plot.
+        enter_legend_subcontainer(nil)
+    end
+
+    LegendMultiColEndCommand.describe("End of multicolumn legends",
+                                   <<EOH, LegendGroup)
+Stop layout out legends in several columns
+EOH
+
+
   end
 end

data/lib/ctioga2/graphics/legends/area.rb

@@ -16,7 +16,7 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 359 $', '$Date: 2012-12-26 10:45:35 +0100 (Wed, 26 Dec 2012) $')
+  Version::register_svn_info('$Revision: 386 $', '$Date: 2013-03-11 22:57:16 +0100 (Mon, 11 Mar 2013) $')
 
   module Graphics
 
@@ -74,6 +74,8 @@ module CTioga2
         def display_legend(t, container)
           items = container.legend_storage.harvest_contents
           t.context do 
+
+            ## @todo These two commands should join LegendStyle
             t.rescale(@legend_style.scale)
             t.rescale_text(@legend_style.text_scale)
 
@@ -82,8 +84,9 @@ module CTioga2
             ## \todo customize this !
             x, y = initial_xy(t, container)
 
-            w,h = *size(t, container)
-            h /= @legend_style.scale * @legend_style.text_scale
+            w,h = *size(t, container, false)
+
+
             @legend_style.frame.
               draw_box_around(t, x, y,
                               x + w, y - h, @legend_style.frame_padding)
@@ -91,8 +94,9 @@ module CTioga2
             for item in items
               ## \todo transform the 0.0 for x into a negative
               # user-specifiable stuff.
+              iw, ih = *item.size(t, @legend_style)
               item.draw(t, @legend_style, x , y)
-              y -= @legend_style.dy.to_figure(t,:y)
+              y -= ih
             end
           end
         end
@@ -100,19 +104,34 @@ module CTioga2
         # Returns the total size of the legend as a
         #  [ width, height ]
         # array in figure coordinates.
-        def size(t, container)
+        #
+        # It assumes that the scales are not setup yet, unless
+        # _resize_ is set to false.
+        def size(t, container, resize = true)
           items = container.legend_storage.harvest_contents
           width, height = 0,0
+
+          # We apparently can't use context here, for a reason that fails me...
+          if resize
+            t.rescale(@legend_style.scale)
+            t.rescale_text(@legend_style.text_scale)
+          end
+          
           for item in items
             w,h = item.size(t, @legend_style)
+            
             if w > width
               width = w
             end
-            # Hmmm... this is plain wrong... 
-            # height += h
-            height += @legend_style.dy.to_figure(t,:y) * 
-              @legend_style.scale * @legend_style.text_scale
+            
+            height += h
           end
+          
+          if resize
+            t.rescale(1/@legend_style.scale)
+            t.rescale_text(1/@legend_style.text_scale)
+          end
+
           return [ width, height ]
         end