ctioga2 0.4 → 0.5

data/lib/ctioga2/graphics/styles/contour.rb

@@ -0,0 +1,141 @@
+# contour.rb: the style of a contour plot
+# copyright (c) 2009 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'
+
+
+# This module contains all the classes used by ctioga
+module CTioga2
+
+  Version::register_svn_info('$Revision$', '$Date$')
+
+  module Graphics
+
+    module Styles
+
+
+      # The base for a contour plot
+      class BaseContourStyle < BasicStyle
+        
+        # Whether or not to use conrec for the contour computation
+        typed_attribute :conrec, 'boolean'
+
+        def make_contour(table, level, opts = {})
+          if @conrec && (! opts.key? 'method')
+            opts['method'] = 'conrec'
+          end
+          return table.make_contour(level, opts)
+        end
+        
+      end
+
+
+      # This class expands on the previous one to provide for
+      # mechanisms to draw many related contour plots.
+      class ContoursStyle < BaseContourStyle
+
+        # The overall number of ticks (including minor ticks when
+        # there is). May be approximative
+        typed_attribute :number, 'integer'
+
+        # Whether or not to "stick" to natural numbers for the 
+        typed_attribute :use_naturals, 'boolean'
+
+        # Number of subticks
+        typed_attribute :minor_number, 'integer'
+
+        # Relative scale of the minor ticks. Used if the absolute
+        # width is not specified.
+        typed_attribute :minor_scale, 'float'
+
+        # Line style of minor ticks.
+        sub_style :minor, LineStyle
+
+        def initialize()
+          @number = 20
+          @use_naturals = true
+          @minor_number = 4
+          @minor_scale = 0.6
+        end
+
+        # Computes and plots the contours according to the style,
+        # using the given color map.
+        def plot_contours(t, table, zmin, zmax, color_map)
+
+          ticks = []
+          minor_ticks = []
+
+          if @use_naturals
+            bdz = (zmax - zmin)*@minor_number/@number
+            bdz = Utils.closest_subdivision(bdz)
+
+            zb = ((zmin/bdz).ceil) * bdz
+            z = zb
+            i = 0
+            while z < zmax
+              ticks << z
+              z = zb + i*bdz
+              i += 1
+            end
+
+            sbdz = bdz/@minor_number
+            sbdz = Utils.closest_subdivision(sbdz, false)
+
+            zb = ((zmin/sbdz).ceil) * sbdz
+            z = zb
+            i = 0
+            idx = 0
+            while z < zmax
+              if ticks[idx] == z
+                idx += 1
+              else
+                minor_ticks << z
+              end
+              i += 1
+              z = zb + i*sbdz
+            end
+          else
+            dz = (zmax - zmin)/@number
+            @number.times do |i|
+              ticks << zmin + (i + 0.5) * dz
+            end
+          end
+
+          for lvl in ticks
+            t.context do
+              t.stroke_color = color_map.z_color(lvl, zmin, zmax)
+              contour = make_contour(table, lvl)
+              t.append_points_with_gaps_to_path(*contour)
+              t.stroke
+            end
+          end
+
+          # Minor ticks, when applicable !
+          t.context do 
+            t.line_width = t.line_width * @minor_scale
+            @minor.set_stroke_style(t) if @minor
+            for lvl in minor_ticks
+              t.stroke_color = color_map.z_color(lvl, zmin, zmax)
+              contour = make_contour(table, lvl)
+              t.append_points_with_gaps_to_path(*contour)
+              t.stroke
+            end
+          end
+
+        end
+      end
+    end
+  end
+end
+

data/lib/ctioga2/graphics/styles/curve.rb

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 349 $', '$Date: 2012-12-25 22:23:27 +0100 (Tue, 25 Dec 2012) $')
+  Version::register_svn_info('$Revision: 416 $', '$Date: 2013-08-23 00:35:49 +0200 (Fri, 23 Aug 2013) $')
 
   module Graphics
 
@@ -28,61 +28,69 @@ module CTioga2
       # \todo maybe for objects different than Curve2D, a subclass of
       # CurveStyle could be used ? This way, we could have clearly
       # separated legends and the like ?
-      #
-      # @todo This should probably be a subclass of basicStyle, to
-      # handle style sheets.
-      class CurveStyle
+      class CurveStyle < BasicStyle
 
         # The style of the line that is drawn, as a StrokeStyle. 
-        attr_accessor :line
+        sub_style :line, StrokeStyle
 
         # The style of markers that should be drawn, as a MarkerStyle.
-        attr_accessor :marker
+        sub_style :marker, MarkerStyle
 
         # The text of the legend, if there is one.
-        attr_accessor :legend
+        typed_attribute :legend, 'text'
 
         # The style of the error bars when needed, as a ErrorBarStyle.
-        attr_accessor :error_bar
+        sub_style :error_bar, ErrorBarStyle
 
         # Filling of the curve, if applicable
-        attr_accessor :fill
+        sub_style :fill, CurveFillStyle
 
         # Details of the location of the curve, a LocationStyle object.
-        attr_accessor :location
+        sub_style :location, LocationStyle, nil, true
 
         # Whether in a region plot, the curve should be above or below
         # the filled region.
-        attr_accessor :region_position
+        typed_attribute :region_position, "region-side"
 
         # A path style.
         #
-        # @todo Ideas for a path tyle include
+        # @todo Ideas for a path style include
         # - plain lines
         # - impulses ?
         # - splines
         # See gnuplot help for "plot with" for inspiration.
-        attr_accessor :path_style
+        #
+        # For now completely useless !
+        typed_attribute :path_style, 'text'
 
         # A colormap for strokes (only for XYZ data)
         #
         # @todo There should be a very clear way to mark curve style
         # elements which are specific to certain kinds of plots (and
         # warn the user about misuses ?)
-        attr_accessor :color_map
+        typed_attribute :color_map, 'colormap'
 
         # The name of an axis to create to use for the display of the
         # Z scale.
         #
         # @todo specify the behaviour when the axis exists.
-        attr_accessor :zaxis
+        typed_attribute :zaxis, 'text'
 
         # A colormap for markers (only for XYZ data) 
-        attr_accessor :marker_color_map
+        typed_attribute :marker_color_map, 'colormap'
 
         # Whether the XY display should split on NaN values (wherever)
-        attr_accessor :split_on_nan
+        typed_attribute :split_on_nan, 'boolean'
+
 
+        # Style of contour plots
+        sub_style :contour, ContoursStyle, nil, true
+
+        # The following attributes are not styles but here to help
+
+        # The object attached to this style. It is set by
+        # Generator#curve_from_dataset
+        attr_accessor :target
 
         # True if a line should be drawn.
         def has_line?
@@ -99,62 +107,36 @@ module CTioga2
           return @legend
         end
 
-        # Sets the values of the different sub-objects from a 'flat'
-        # _hash_. Keys have the following meaning:
-        # * 'line_...': a StrokeStyle for the drawing the line
-        # * 'marker_...': a MarkerStyle for the drawing of markers
-        # * 'legend': the legend of the curve
-        # * '[xy]axis': the name of the axis the curve should be
-        #    plotted onto
-        #
-        # \todo make #legend another object derived from BasicStyle ?
-        #
-        # @todo This function should essentially disappear if we make
-        # this derive from BasicStyle.
-        def set_from_hash(hash)
-          @line = StrokeStyle.from_hash(hash, 'line_%s')
-          @marker = MarkerStyle.from_hash(hash, 'marker_%s')
-          @error_bar = ErrorBarStyle.from_hash(hash, 'error_bar_%s')
-          @location = LocationStyle.from_hash(hash, 'location_%s')
-          @fill = CurveFillStyle.from_hash(hash, 'fill_%s')
-
-          @region_position = hash['region_position']
-
-          @legend = hash['legend']
-
-          @path_style = hash['style']
-
-          @color_map = hash['color_map']
-
-          @marker_color_map = hash['marker_color_map']
-
-          @split_on_nan = hash['split_on_nan']
-
-          @zaxis = hash['zaxis']
-        end
-
-        # Creates a CurveStyle object straight from a hash
-        # description. See #set_from_hash for more information.
-        def self.from_hash(hash)
-          a = CurveStyle.new
-          a.set_from_hash(hash)
-          return a
-        end
-
-
         # Draws a legend pictogram that fills up the whole current
         # frame.
         #
         # \todo add more elements to the pictogram in case of more
         # complex things.
+        #
+        # @todo Most probably the legend pictogram should be done by
+        # the curve directly rather than by the style.
         def draw_legend_pictogram(t)
           t.context do
-            if has_line?
-              @line.set_stroke_style(t)
-              t.stroke_line(0.0, 0.5, 1.0, 0.5)
-            end
-            if has_marker?
-              @marker.draw_markers_at(t, [0.5], [0.5])
+            case @target
+            when Elements::Curve2D
+              if has_line?
+                @line.set_stroke_style(t)
+                t.stroke_line(0.0, 0.5, 1.0, 0.5)
+              end
+              if has_marker?
+                @marker.draw_markers_at(t, [0.5], [0.5])
+              end
+            when Elements::Parametric2D
+              if has_marker? && @marker_color_map
+                colors = @marker_color_map.colors.uniq
+                i = 1
+                total = colors.size + 1.0
+                for c in colors
+                  @marker.draw_markers_at(t, [i/total], [0.5], 
+                                          {'color' => c} )
+                  i += 1
+                end
+              end
             end
           end
         end

data/lib/ctioga2/graphics/styles/drawable.rb

@@ -17,19 +17,15 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 350 $', '$Date: 2012-12-25 22:23:35 +0100 (Tue, 25 Dec 2012) $')
+  Version::register_svn_info('$Revision: 419 $', '$Date: 2013-08-23 01:05:42 +0200 (Fri, 23 Aug 2013) $')
 
   module Graphics
 
     # All the styles
     module Styles
 
-      # This class represents all the stylistic information to stroke
-      # a Tioga path.
-      class StrokeStyle < BasicStyle
-        # The color
-        typed_attribute :color, 'color-or-false'
-        
+      # This class represents a plain line style.
+      class LineStyle < BasicStyle
         # The line style
         typed_attribute :style, 'line-style'
 
@@ -38,7 +34,6 @@ module CTioga2
 
         # Sets the stroke style to a FigureMaker object, _t_.
         def set_stroke_style(t)
-          t.stroke_color = @color if @color
           t.line_type = @style if @style
           t.line_width = @width if @width
         end
@@ -52,6 +47,20 @@ module CTioga2
         end
       end
 
+      # This class represents all the stylistic information to stroke
+      # a Tioga path.
+      class StrokeStyle < LineStyle
+        # The color
+        typed_attribute :color, 'color-or-false'
+        
+        # Sets the stroke style to a FigureMaker object, _t_.
+        def set_stroke_style(t)
+          t.stroke_color = @color if @color
+          super
+        end
+
+      end
+
       # This class represents all the stylistic information to draw a
       # Marker.
       #

data/lib/ctioga2/graphics/styles/factory.rb

@@ -1,5 +1,5 @@
 # factory.rb: an object in charge of generating the style for Curves
-# copyright (c) 2009 by Vincent Fourmond
+# copyright (c) 2009, 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
@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 217 $', '$Date: 2010-12-31 16:18:20 +0100 (Fri, 31 Dec 2010) $')
+  Version::register_svn_info('$Revision: 432 $', '$Date: 2013-08-23 19:06:36 +0200 (Fri, 23 Aug 2013) $')
 
   module Graphics
 
@@ -62,7 +62,7 @@ module CTioga2
           def initialize(name, type, sets, description, 
                          short_option = nil, disable_cmds = false)
             @name = name
-            @type = Commands::CommandType.get_type(type)
+            @type = type 
             @sets = sets
             @description = description
             @short_option = short_option
@@ -108,11 +108,14 @@ module CTioga2
         #
         # \todo add a way to add some more text to the description;
         # possibly a self.describe_parameter function ?
-        def self.define_parameter(target, name, type, sets, description, 
+        #
+        # @todo Remove completely the 'type' argument
+        def self.define_parameter(target, name, sets, description, 
                                   short_option = nil, disable_cmds = false)
           # We define two new types:
           # - first, the color-or-auto type:
-          base_type = Commands::CommandType.get_type(type)
+          # base_type = Commands::CommandType.get_type(type)
+          base_type = CurveStyle.attribute_type(target)
 
           if ! Commands::Interpreter.type("#{base_type.name}-or-auto")
             mb_type = base_type.type.dup
@@ -141,7 +144,7 @@ module CTioga2
                         "Sets of {type: #{base_type.name}}")
           end
           param = 
-            CurveStyleFactoryParameter.new(name, type, sets, 
+            CurveStyleFactoryParameter.new(name, base_type, sets, 
                                            description, short_option, 
                                            disable_cmds)
           @parameters ||= {}
@@ -151,6 +154,13 @@ module CTioga2
           @name_to_target[name] = target
         end
 
+        # A simple parameter is something whose target defines all, ie
+        # only the name and a documentation text is necessary.
+        def self.simple_parameter(target, text, sets = nil)
+          name = target.gsub(/_/, '-')
+          define_parameter(target, name, sets, text, nil)
+        end
+
         # Returns the Hash containing the class parameters.
         def self.parameters
           return @parameters || {}
@@ -316,71 +326,67 @@ module CTioga2
         # Now, the parameters:
 
         # Lines:
-        define_parameter 'line_color', 'color', 'color',
-        Sets::ColorSets, "color", "-c"
+        define_parameter 'line_color', 'color', 
+        Sets::ColorSets, "line color", "-c"
 
-        define_parameter 'line_width', 'line-width', 'float',
-        Sets::LineWidthSets, "line width", nil
+        simple_parameter 'line_width', 'line width', Sets::LineWidthSets
 
-        define_parameter 'line_style', 'line-style', 'line-style',
-        Sets::LineStyleSets, "line style", nil
+        simple_parameter 'line_style', 'line style', Sets::LineStyleSets
 
         # Markers
-        define_parameter 'marker_marker', 'marker', 'marker',
+        define_parameter 'marker_marker', 'marker', 
         Sets::MarkerSets, "marker", '-m'
 
-        define_parameter 'marker_color', 'marker-color', 'color',
-        Sets::ColorSets, "marker color", nil
+        simple_parameter 'marker_color', "marker color", Sets::ColorSets
 
-        define_parameter 'marker_scale', 'marker-scale', 'float',
-        Sets::LineWidthSets, "marker scale", nil
+        simple_parameter 'marker_scale', "marker scale", Sets::LineWidthSets
 
         # Error bars:
-        define_parameter 'error_bar_color', 'error-bar-color', 'color',
-        Sets::ColorSets, "error bar color", nil
+        simple_parameter 'error_bar_color', "error bar color", 
+        Sets::ColorSets
 
         # Location:
-        define_parameter 'location_xaxis', 'xaxis', 'axis',
+        define_parameter 'location_xaxis', 'xaxis', 
         nil, "X axis", nil, true
 
-        define_parameter 'location_yaxis', 'yaxis', 'axis',
+        define_parameter 'location_yaxis', 'yaxis', 
         nil, "Y axis", nil, true
 
         # Now, fill style
-        define_parameter 'fill_y0', 'fill', 'fill-until',
+        define_parameter 'fill_y0', 'fill', 
         {}, "Fill until", nil
 
-        define_parameter 'fill_color', 'fill-color', 'color',
-        Sets::ColorSets, "fill color", nil
+        simple_parameter 'fill_color', "fill color", Sets::ColorSets
 
-        define_parameter 'fill_transparency', 'fill-transparency', 'float',
-        {}, "Fill transparency", nil
+        simple_parameter 'fill_transparency', 'fill transparency', {}
 
         # Region handling
-        define_parameter 'region_position', 'region-side', 'region-side',
+        define_parameter 'region_position', 'region-side', 
         {"default" => [:above, :below]}, "region side", nil
 
 
-        define_parameter 'style', 'style', 'text',
-        {}, "Path style", nil
+        simple_parameter 'path_style', 'path style', {}
 
         # Only for xyz-maps or xy-parametric
-        define_parameter 'color_map', 'color-map', 'colormap',
-        nil, "Color map", nil
-
+        simple_parameter 'color_map', 'color map'
 
-        define_parameter 'zaxis', 'zaxis', 'text',
-        nil, "Name for the Z axis", nil
+        simple_parameter 'zaxis', "name for the Z axis"
 
         ## @todo For xy-parametric, there should be a way to specify
         ## to which z value the maps apply (ie lines = y2, marker =
         ## y3...). Although for readability, it is probably better
         ## to avoid that...
-        define_parameter 'marker_color_map', 'marker-color-map', 'colormap',
-        nil, "Marker color map", nil
+        simple_parameter 'marker_color_map', 'color map for markers'
 
-        define_parameter 'split_on_nan', 'split-on-nan', 'boolean',
-        nil, "Split on NaN", nil
+        simple_parameter 'split_on_nan', 'split on NaN'
+
+
+        # Contour plot styles
+        simple_parameter 'contour_conrec', "use CONREC for contouring"
+        simple_parameter 'contour_number', "overall number of level lines"
+        simple_parameter 'contour_minor_number', "number of minor level lines between major ones (approx)"
+        simple_parameter 'contour_minor_scale', "relative scale of minor level lines"
+        simple_parameter 'contour_minor_style', "minor ticks line style"
 
 
         # And finally, we register all necessary commands...
@@ -462,6 +468,41 @@ module CTioga2
         end
       end
     end
+
+    # Now, we document some aspects of the above created commands
+    c = Commands::Command
+
+    c.document_command("color-map", <<EOD)
+Sets the color map for the subsequent curves, until cancelled by an
+@auto@ argument.
+
+Color maps are used for 3D plots, ie under the effet of 
+{command: contour}, {command: xyz-map} and {command: xy-parametric}. 
+EOD
+
+    c.document_command("contour-conrec", <<EOD)
+If on, the subsequent curves will use the CONREC algorithm for
+contouring. In the opposite case, the contouring algorithm of Gri is
+used.
+
+Only useful when {command: contour} is in effect.
+EOD
+
+    c.document_command("split-on-nan", <<EOD)
+In general, the NaN (not a number, ie invalid data points in the
+dataset) in a dataset are silently ignored. When this option is on,
+the lines of {command: xy-plot}-style plots are split upon
+encountering a NaN.
+EOD
+
+    c.document_command("zaxis", <<EOD)
+Sets the name of the zaxis for the subsequent curves. This must be an
+axis that has been previously created using {command: new-zaxis}. 
+
+This axis will be used to display the colormaps of the following
+curve. 
+EOD
+
   end
 end