ctioga2 0.0 → 0.1

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

@@ -0,0 +1,73 @@
+# drawable.rb: style objects pertaining to drawable objects.
+# 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: 123 $', '$Date: 2010-01-10 02:45:47 +0100 (Sun, 10 Jan 2010) $')
+
+  module Graphics
+
+    # All the styles
+    module Styles
+
+      # This class represents the stylistic information necessary to
+      # draw an error bar. It derives from StrokeStyle, as it is
+      # essentially a stroke.
+      class ErrorBarStyle < StrokeStyle
+
+        # The error bar style. For now, not much here.
+        attr_accessor :style
+
+        # Shows an error bar with the appropriate stylistic
+        # information. _x_ and _y_ are the coordinates of the data
+        # point. The corresponding _min_ and _max_ are the minimum and
+        # maximum values for the error bars. If either is _nil_, no
+        # error bar on that direction is drawn.
+        #
+        # \todo maybe make provisions (one day) for complex error bars
+        # showing min/max and stddev as well ?
+        def show_error_bar(t, x, xmin, xmax, y, ymin, ymax)
+          d = { 'x' => x,
+            'y' => y,
+            'color' => @color || Tioga::ColorConstants::Black,
+            'line_width' => @width || 1.0,
+          }
+          has = false
+          if (xmin && xmax && (xmax - xmin != 0))
+            d['dx_plus'] = xmax - x
+            d['dx_minus'] = x - xmin
+            has = true
+          end
+
+          if (ymin && ymax && (ymax - ymin != 0))
+            d['dy_plus'] = ymax - y
+            d['dy_minus'] = y - ymin
+            has = true
+          end
+          # We won't draw something when there isn't anything to draw
+          # !
+          if(has)
+            t.show_error_bars(d)
+          end
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -17,7 +17,7 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 59 $', '$Date: 2009-05-28 23:15:50 +0200 (Thu, 28 May 2009) $')
+  Version::register_svn_info('$Revision: 217 $', '$Date: 2010-12-31 16:18:20 +0100 (Fri, 31 Dec 2010) $')
 
   module Graphics
 
@@ -52,18 +52,23 @@ module CTioga2
           # The MetaBuilder::Type object that can convert a String to
           # an Array suitable for use with CircularArray.
           attr_accessor :sets_type
+
+          # If this attribute is on, then CurveStyleFactory will not
+          # generate commands for this parameter, only the option.
+          attr_accessor :disable_commands
           
 
           # Creates a new CurveStyleFactoryParameter object.
           def initialize(name, type, sets, description, 
-                         short_option = nil)
+                         short_option = nil, disable_cmds = false)
             @name = name
             @type = Commands::CommandType.get_type(type)
             @sets = sets
             @description = description
             @short_option = short_option
-
-            # TODO: it is not very satisfying to mix CommandTypes and
+            @disable_commands = disable_cmds
+            
+            ## \todo it is not very satisfying to mix CommandTypes and
             # MetaBuilder::Type on the same level.
             if @sets
               @sets_type = 
@@ -95,11 +100,16 @@ module CTioga2
         # Sets some parameter to _false_.
         DisableRE = /no(ne)?|off/i
 
+        # If that matches, we use the value as a link to other values.
+        LinkRE = /(?:=|->)(\S+)/
 
 
         # Creates a new parameter for the style factory.
+        #
+        # \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, 
-                                  short_option = nil)
+                                  short_option = nil, disable_cmds = false)
           # We define two new types:
           # - first, the color-or-auto type:
           base_type = Commands::CommandType.get_type(type)
@@ -112,9 +122,12 @@ module CTioga2
             mb_type.re_shortcuts[AutoRE] = 'auto'
             mb_type.re_shortcuts[DisableRE] = false
 
+            # Add passthrough for expressions such as =color...
+            mb_type.passthrough = LinkRE
+
             # Now, register a type for the type or automatic.
             CmdType.new("#{base_type.name}-or-auto", mb_type,
-                        "Same thing as type #{base_type.name}, or 'auto'")
+                        "Same thing as {type:#{base_type.name}}, or @auto@ to let the style factory handle automatically.")
 
           end
 
@@ -125,11 +138,12 @@ module CTioga2
                           :subtype => base_type.type,
                           :shortcuts => sets
                         } ,
-                        "Sets of #{base_type.name}")
+                        "Sets of {type: #{base_type.name}}")
           end
           param = 
             CurveStyleFactoryParameter.new(name, type, sets, 
-                                           description, short_option)
+                                           description, short_option, 
+                                           disable_cmds)
           @parameters ||= {}
           @parameters[target] = param
 
@@ -151,8 +165,8 @@ module CTioga2
         # The CmdGroup for stylistic information about
         # curves.
         CurveStyleGroup = 
-          CmdGroup.new('curve-style', "Curve styles", 
-                       "Set stylistic details about curves", 1)
+          CmdGroup.new('curve-style', "Curves styles", 
+                       "Set stylistic details of curves or other object drawn from data", 1)
 
 
         # Creates two commands for each parameter of the object:
@@ -160,6 +174,7 @@ module CTioga2
         # * a command to choose the sets.
         def self.create_commands
           parameters.each do |target, param|
+            next if param.disable_commands
             override_cmd = 
               Cmd.new("#{param.name}",
                       param.short_option,
@@ -168,12 +183,13 @@ module CTioga2
                        CmdArg.new("#{param.type.name}-or-auto") 
                       ], {},
                       "Sets the #{param.description} for subsequent curves",
-                      "Sets the #{param.description} for subsequent curves, until cancelled with 'auto' as argument.", CurveStyleGroup) do |plotmaker, value|
+                      "Sets the #{param.description} for subsequent curves, until cancelled with @auto@ as argument.", CurveStyleGroup) do |plotmaker, value|
               plotmaker.curve_generator.style_factory.
                 set_parameter_override(target, value)
             end
 
             if param.sets
+              next if param.disable_commands
               set_cmd = 
                 Cmd.new("#{param.name}-set",
                         nil,
@@ -182,10 +198,12 @@ module CTioga2
                          CmdArg.new("#{param.type.name}-set")
                         ], {},
                         "Chooses a set for the #{param.description} of subsequent curves",
-                        "Chooses a set for the #{param.description} of subsequent curves", 
+                        "Chooses a set for the #{param.description} of subsequent curves. Also sets {command: #{param.name}} to @auto@, so that the set takes effect immediately", 
                         CurveStyleGroup) do |plotmaker, value|
                 plotmaker.curve_generator.style_factory.
                   set_parameter_set(target, value)
+                plotmaker.curve_generator.style_factory.
+                  set_parameter_override(target, 'auto')
               end
             end
           end
@@ -244,8 +262,7 @@ module CTioga2
           end
           base.merge!(@override_parameters)
           base.merge!(hash_name_to_target(one_time))
-          # TODO: here, resolve 'links', such as :->color ?
-          return CurveStyle.from_hash(base)
+          return CurveStyle.from_hash(resolve_links(base))
         end
 
 
@@ -265,8 +282,18 @@ module CTioga2
             if value =~ AutoRE
               @override_parameters.delete(target)
               return
-            end
-            if value =~ DisableRE
+            elsif value =~ LinkRE
+              t = $1
+              convert = self.class.name_to_target
+              if convert.key?(t)
+                value = "=#{convert[t]}".to_sym
+              else
+                warn { "No known key: #{t}, treating as auto" }
+                @override_parameters.delete(target)
+                return
+              end
+
+            elsif value =~ DisableRE
               value = false
             else
               value = param.type.string_to_type(value)
@@ -287,6 +314,8 @@ module CTioga2
         end
 
         # Now, the parameters:
+
+        # Lines:
         define_parameter 'line_color', 'color', 'color',
         Sets::ColorSets, "color", "-c"
 
@@ -296,6 +325,7 @@ module CTioga2
         define_parameter 'line_style', 'line-style', 'line-style',
         Sets::LineStyleSets, "line style", nil
 
+        # Markers
         define_parameter 'marker_marker', 'marker', 'marker',
         Sets::MarkerSets, "marker", '-m'
 
@@ -305,6 +335,53 @@ module CTioga2
         define_parameter 'marker_scale', 'marker-scale', 'float',
         Sets::LineWidthSets, "marker scale", nil
 
+        # Error bars:
+        define_parameter 'error_bar_color', 'error-bar-color', 'color',
+        Sets::ColorSets, "error bar color", nil
+
+        # Location:
+        define_parameter 'location_xaxis', 'xaxis', 'axis',
+        nil, "X axis", nil, true
+
+        define_parameter 'location_yaxis', 'yaxis', 'axis',
+        nil, "Y axis", nil, true
+
+        # Now, fill style
+        define_parameter 'fill_y0', 'fill', 'fill-until',
+        {}, "Fill until", nil
+
+        define_parameter 'fill_color', 'fill-color', 'color',
+        Sets::ColorSets, "fill color", nil
+
+        define_parameter 'fill_transparency', 'fill-transparency', 'float',
+        {}, "Fill transparency", nil
+
+        # Region handling
+        define_parameter 'region_position', 'region-side', 'region-side',
+        {"default" => [:above, :below]}, "region side", nil
+
+
+        define_parameter 'style', 'style', 'text',
+        {}, "Path style", nil
+
+        # Only for xyz-maps or xy-parametric
+        define_parameter 'color_map', 'color-map', 'colormap',
+        nil, "Color map", nil
+
+
+        define_parameter 'zaxis', 'zaxis', 'text',
+        nil, "Name for the Z axis", nil
+
+        ## @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
+
+        define_parameter 'split_on_nan', 'split-on-nan', 'boolean',
+        nil, "Split on NaN", nil
+
 
         # And finally, we register all necessary commands...
         create_commands
@@ -339,11 +416,50 @@ module CTioga2
             if convert.key? k 
               retval[convert[k]] = v
             else
-              warn "Unkown key for hash_name_to_target: #{k}"
+              warn { "Unkown key for hash_name_to_target: #{k}" }
             end
           end
           return retval
         end
+
+        # Resolve potential links in the form of :=stuff within the
+        # given hash, and returns a new version of the hash.
+        #
+        # \warning the _h_ parameter is completely destroyed in the
+        # process
+        def resolve_links(h)
+          tv = {}
+
+          # First, copy plain values
+          for k,v in h
+            if v.is_a?(Symbol) && v.to_s =~ /^(=|->)/
+              # We keep for later
+            else
+              tv[k] = v
+              h.delete(k)
+            end
+          end
+          
+          # Now, we will iterate over the remaining things; we will
+          # stop with an error if the number of remaining keys does
+          # not decrease after one step
+          while h.size > 0
+            pre_size = h.size
+            for k,v in h
+              v.to_s =~ /^(?:=|->)(\S+)/
+              target = $1
+              if tv.key? target
+                tv[k] = tv[target]
+                h.delete(k)
+              end
+            end
+            if h.size >= pre_size
+              raise "Error: infinite recursion loop while gathering styles"
+            end
+          end
+          
+          return tv
+        end
       end
     end
   end

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

@@ -0,0 +1,60 @@
+# gradients.rb: objects dealing with (color) gradients
+# 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'
+
+require 'ctioga2/graphics/coordinates'
+
+# This module contains all the classes used by ctioga
+module CTioga2
+
+  Version::register_svn_info('$Revision: 168 $', '$Date: 2010-10-22 13:03:33 +0200 (Fri, 22 Oct 2010) $')
+
+  module Graphics
+
+    module Styles
+
+      
+      # A color gradient with two points
+      #
+      # \todo There could be many more
+      #
+      # @todo This will have to be replaced by a real color map based
+      # on what
+      class TwoPointGradient < BasicStyle
+
+        include Log
+        
+        # The starting color (for x = 0)
+        attr_accessor :start
+
+        # The ending color (for x = 1)
+        attr_accessor :end
+
+        def initialize(s,e)
+          warn { "This class shouldn't be used anymore at #{caller.inspect}" }
+          @start = s
+          @end = e
+        end
+
+        # Returns the color for the given value of _x_ (between 0 and 1)
+        def color(x)
+          return Utils::mix_objects(@end,@start, x)
+        end
+        
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# drawable.rb: style objects pertaining to drawable objects.
+# 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: 133 $', '$Date: 2010-01-18 21:37:36 +0100 (Mon, 18 Jan 2010) $')
+
+  module Graphics
+
+    # All the styles
+    module Styles
+
+      # This class represents various aspects of the location of a
+      # object within a plot, such as:
+      # 
+      # * X and Y axes
+      # * foreground/normal/background position
+      # * whether it should be clipped or not.
+      #
+      # \todo currently only X and Y axes are implemented.
+      class LocationStyle < BasicStyle
+        
+        # The name of the X axis, something to be fed to
+        # PlotStyle#get_axis_key
+        attr_accessor :xaxis
+
+        # The name of the Y axis
+        attr_accessor :yaxis
+
+        # Given a PlotStyle object, returns the axes keys as would
+        # PlotStyle#get_axis_key
+        def get_axis_keys(plot_style)
+          return [
+                  plot_style.get_axis_key(@xaxis || 'x'),
+                  plot_style.get_axis_key(@yaxis || 'y')
+                 ]
+        end
+
+        # Finalizes the location of the object, that is (for now)
+        # resolves references to default axes.
+        def finalize!(plot_style)
+          @xaxis, @yaxis = *get_axis_keys(plot_style)
+        end
+        
+      end
+
+    end
+  end
+end
+