ctioga2 0.0 → 0.1

data/lib/ctioga2/graphics/styles/map-axes.rb

@@ -0,0 +1,164 @@
+# axes.rb: the style of one axis or edge 
+# 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
+
+
+      # This class handles the display of a Z axis color map, in the
+      # form of a colored bar with ticks and a label.
+      class MapAxisStyle < AxisStyle
+
+        # The actual color map
+        attr_accessor :color_map
+        
+        # Zmin and Zmax boundaries
+        attr_accessor :bounds
+
+        # Size of the bar (not counting the label)
+        attr_accessor :bar_size
+
+        # Space to be left between the graph and the beginning of the
+        # graph
+        attr_accessor :bar_shift
+
+        # Space to be left on the side
+        attr_accessor :padding
+
+        # Creates a new MapAxisStyle object at the given location with
+        # the given style.
+        def initialize()
+          super()
+
+          @bar_size = Types::Dimension.new(:dy, 2, :x)
+
+          # Shifting away from the location.
+          @bar_shift = Types::Dimension.new(:dy, 0.3, :x)
+
+          ## @todo maybe use different padding for left and right ?
+          @padding = Types::Dimension.new(:dy, 0.5, :x)
+
+          @decoration = AXIS_WITH_TICKS_AND_NUMERIC_LABELS
+
+          # To be implemented one day...
+          @other_side_decoration = nil
+        end
+
+        def set_color_map(color_map, zmin, zmax)
+          @bounds = [zmin, zmax]
+          @color_map = color_map
+
+        end
+
+        def draw_axis(t)
+          # Not beautiful at all
+          size = Types::Dimension.new(:dy, extension(t), 
+                                      @location.orientation)
+          label_size = 
+            Types::Dimension.new(:dy, labels_only_extension(t, style = nil),
+                                 @location.orientation)
+
+          @location.do_sub_frame(t, size) do
+            # This is a necessary workaround for a small bug
+            t.set_subframe([0,0,0,0])
+            # Here, do the correct setup, using a MarginsBox:
+            # * correctly setup the axes/edges
+            # * handle the sides correctly.
+            # * position the subplot within accordingly
+            # * use draw_axis for the axis ?
+
+            plot_box = Types::MarginsBox.
+              new(*@location.reorient_margins(@bar_shift, label_size, 
+                                              @padding, @padding))
+
+            # We wrap the call within a subplot
+            t.subplot(plot_box.to_frame_margins(t)) do
+              bounds = if @location.vertical?
+                         [0, 1, @bounds.last, @bounds.first]
+                       else
+                         [@bounds.first, @bounds.last, 0, 1]
+                       end
+              t.set_bounds(bounds)
+              t.context do 
+                t.clip_to_frame
+                cmap, zmin, zmax = *@color_map.to_colormap(t, @bounds.first,
+                                                          @bounds.last)
+
+                sp = [0.5, zmin]
+                ep = [0.5, zmax]
+                if ! @location.vertical?
+                  sp.reverse!
+                  ep.reverse!
+                end
+                t.axial_shading(
+                                'start_point' => sp,
+                                'end_point' => ep,
+                                'colormap' => cmap
+                                )
+              end
+              ## @todo handle axis color ?
+              t.stroke_frame
+              ## @todo potentially handle decorations for the other
+              ## side too.
+
+              ## @todo This is a ugly hack, but Ruby doesn't allow a
+              ## clean one. Though
+              ## http://stackoverflow.com/questions/1251178/calling-another-method-in-super-class-in-ruby
+              ## seems like the way to go ! To be implemented one day.
+              self.class.superclass.instance_method(:draw_axis).
+                bind(self).call(t)
+              
+            end
+
+          end
+        end
+
+        def set_bounds_for_axis(t, range = nil)
+          # Useless here
+        end
+
+        # Draw the axis background lines:
+        def draw_background_lines(t)
+          # Nothing to do
+        end
+
+        def extension(t, style = nil)
+          base = super(t, style)
+
+          base += @bar_size.to_text_height(t, @location.orientation)
+          base += @bar_shift.to_text_height(t, @location.orientation)
+          return base
+        end
+
+        # Whether the axis is vertical or not
+        def vertical?
+          return @location.vertical?
+        end
+
+      end
+
+      ZAxisStyle = FullAxisStyle.dup
+      ZAxisStyle['bar_size'] = CmdArg.new('dimension')
+      ZAxisStyle['bar_shift'] = CmdArg.new('dimension')
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ require 'ctioga2/graphics/coordinates'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 94 $', '$Date: 2009-06-25 23:37:13 +0200 (Thu, 25 Jun 2009) $')
+  Version::register_svn_info('$Revision: 202 $', '$Date: 2010-11-30 22:21:17 +0100 (Tue, 30 Nov 2010) $')
 
   module Graphics
 
@@ -27,7 +27,7 @@ module CTioga2
 
       # The style of a Elements::Subplot object.
       #
-      # TODO: it should hold
+      # \todo it should hold
       # * labels
       # * axes and edges (in a *clean* way !)
       # * ticks
@@ -37,6 +37,8 @@ module CTioga2
 
         include Tioga::FigureConstants
 
+        include Log
+
         # The various sides of the plot. A hash location -> AxisStyle.
         attr_accessor :axes
 
@@ -87,7 +89,7 @@ module CTioga2
           @yaxis_location = :left
 
           @title = TextLabel.new
-          @title.loc = :top
+          @title.loc = Types::PlotLocation.new(:top)
 
           @plot_margin = nil
 
@@ -103,6 +105,9 @@ module CTioga2
         #
         # Now the question is: how should that affect user-defined
         # axes ? It should not.
+        #
+        # \todo This really should move to Axis when transformations
+        # are handled correctly.
         def set_log_scale(which, val)
           case which
           when :x
@@ -118,26 +123,55 @@ module CTioga2
           end
         end
 
+        # Sets the axis which should be used for subsequent objects
+        # (for which no axis is specified) for the given plot
+        def set_default_axis(which, name)
+          axis = get_axis_key(name)
+          self.send("#{which}axis_location=", axis)
+        end
+
+
         # Returns the AxisStyle corresponding to the named
         # axis. _name_ can be:
-        # * one of the named elements of axes (ie, by default: top,
-        #   left, right, bottom). All names are stripped from spaces
-        #   around, and downcased (see #clean_axis_name).
+        # 
+        # * one of the named axes (ie, by default: top, left, right,
+        #   bottom). All names are stripped from spaces around, and
+        #   downcased (see #clean_axis_name). Can be also user-defined
+        #   axes.
+        #   
         # * x(axis)?/y(axis)?, which returns the default object for the
         #   given location
+        #
+        # \todo Maybe x2 and y2 could be provided to signify "the side
+        # which isn't the default" ?
         def get_axis_style(name)
+          style = @axes[get_axis_key(name)]
+          if ! style
+            ## @todo Type-safe exception here
+            raise "Unkown named axis: '#{name}'"
+          else
+            return style
+          end
+        end
+
+        # Returns the key corresponding to the named axis. See
+        # #get_axis_style for more information; though ultimately the
+        # latter is using this function.
+        def get_axis_key(name)
           if name =~ /^\s*([xy])(?:axis)?\s*$/i
-            return @axes[self.send("#{$1.downcase}axis_location")]
+            return self.send("#{$1.downcase}axis_location")
           else
-            style = @axes[clean_axis_name(name)]
-            if ! style
-              raise "Unkown named axis: '#{name}'"
-            else
-              return style
-            end
-          end 
+            return clean_axis_name(name)
+          end
+        end
+
+        def set_axis_style(name, style)
+          key = get_axis_key(name)
+          @axes[key] = style
         end
 
+
+
         # Returns a BaseTextStyle or similar for the given
         # location. The location is of the form:
         #   axis_name(_(ticks?|label))
@@ -166,16 +200,27 @@ module CTioga2
           style = get_label_style(which)
           hash = hash.merge({'text' => text}) unless text.nil?
           if hash.key?('text') and ! style.is_a?(TextLabel)
-            CTioga2::Log::warn("Text property of label #{which} was set, but this has no meaning: tick labels can't be set this way. Did you mean to use \"#{which}_label\"" + " instead ?")
+            CTioga2::Log::warn {"Text property of label #{which} was set, but this has no meaning: tick labels can't be set this way. Did you mean to use \"#{which}_label\"" + " instead ?" }
           end
           style.set_from_hash(hash)
         end
 
 
-        # Draws all axes for the plot.
-        def draw_all_axes(t)
+        # Draws all axes for the plot. The _bounds_ argument is that
+        # computed by Subplot#compute_boundaries; it is there to
+        # ensure that the axes know whether they have their own
+        # coordinate system or if they just follow what's around.
+        def draw_all_axes(t, bounds)
           for which, axis in @axes
-            axis.draw_axis(t)
+            t.context do
+              begin
+                axis.set_bounds_for_axis(t, bounds[which])
+                axis.draw_axis(t)
+              rescue Exception => e
+                error { "Impossible to draw axis #{which}: #{e.message}" }
+                debug { "Full message: #{e.inspect}" }
+              end
+            end
           end
           # We draw the title last
           title.draw(t, 'title')
@@ -218,18 +263,16 @@ module CTioga2
         # Returns a Types::MarginsBox
         def estimate_margins(t)
           margins = [:left, :right, :top, :bottom].map do |side|
-            ext = @axes[side].extension(t,self)
-            if side == @title.loc
-              ext2 = @title.label_extension(t, 'title', side) * 
+            exts = axes_for_side(side).map do |ax|
+              ax.extension(t,self)
+            end
+            if @title.loc.is_side?(side)
+              exts << @title.label_extension(t, 'title', @title.loc) * 
                 (@text_scale || 1)
-              if ext < ext2
-                ext = ext2
-              end
             end
-            Types::Dimension.new(:dy, ext)
+            Types::Dimension.new(:dy, exts.max)
           end
 
-          # TODO: add the plot title !
           box = Types::MarginsBox.new(*margins)
           if @padding
             for dim in box.margins
@@ -251,6 +294,16 @@ module CTioga2
           return $1.downcase.to_sym
         end
 
+        # Returns the list of AxisStyle corresponding to the given
+        # side (:top, :eft, etc...)
+        def axes_for_side(side)
+          ret = []
+          for k,v in @axes
+            ret << v if v.location.is_side?(side)
+          end
+          return ret
+        end
+
       end
 
       AxisGroup = CmdGroup.new('axes-labels',
@@ -293,7 +346,7 @@ given axis, through its various options:
  * decoration
 EOH
 
-      BackgroundLinesCommands = 
+      BackgroundLinesCommand = 
         Cmd.new('background-lines', nil, '--background-lines',
                 [
                  CmdArg.new('axis'), 
@@ -316,72 +369,122 @@ EOH
         end
       end
       
-      BackgroundLinesCommands.
+      BackgroundLinesCommand.
         describe("Sets the color of the background lines", 
                  <<"EOH", AxisGroup)
 Sets the color of the background lines for the given axis.
 EOH
 
 
-      XAxisLabelCommand = 
-        Cmd.new('xlabel', '-x', '--xlabel', [ CmdArg.new('text') ],
+      %w{x y}.each do |axis|
+        labelcmd = Cmd.new("#{axis}label", "-#{axis}", 
+                            "--#{axis}label", [ CmdArg.new('text') ],
+                            FullTextStyleOptions) do |plotmaker, label, options|
+          PlotStyle.current_plot_style(plotmaker).
+            set_label_style("#{axis}_label", options, label)
+        end
+        labelcmd.describe("Sets the #{axis.upcase} label of the plot", 
+                          <<"EOH", AxisGroup)
+Sets the #{axis.upcase} label of the current plot.
+EOH
+        
+        nolabelcmd = Cmd.new("no-#{axis}label", nil, 
+                             "--no-#{axis}label", []) do |plotmaker|
+          PlotStyle.current_plot_style(plotmaker).
+            set_label_style("#{axis}_label", {}, false)
+        end
+        nolabelcmd.describe("Disables #{axis.upcase} label for the plot", 
+                            <<"EOH", AxisGroup)
+Removes the #{axis.upcase} label for the current plot.
+EOH
+
+        daxiscmd = Cmd.new("#{axis}axis", nil,
+                           "--#{axis}axis", [ CmdArg.new('axis') ],
+                           {}) do |plotmaker, ax|
+          PlotStyle.current_plot_style(plotmaker).
+            set_default_axis(axis, ax)
+        end
+        daxiscmd.describe("Sets default #{axis.upcase} axis for the plot",
+                          <<"EOD", AxisGroup)
+Sets the default axis for the #{axis.upcase} axis for all subsequent
+commands take rely on default axes (such as {command: plot}, 
+{command: xrange}, {command: yrange}...).
+EOD
+                                 
+        
+      end
+
+      TitleLabelCommand = 
+        Cmd.new('title', '-t', '--title', [ CmdArg.new('text') ],
                 FullTextStyleOptions) do |plotmaker, label, options|
         PlotStyle.current_plot_style(plotmaker).
-          set_label_style('x_label', options, label)
+          set_label_style('title', options, label)
       end
 
-      XAxisLabelCommand.describe("Sets the X label of the plot", 
+      TitleLabelCommand.describe("Sets the title of the plot", 
                                  <<"EOH", AxisGroup)
-Sets the X label of the current plot.
+Sets the title of the current plot.
 EOH
 
-      NoXAxisLabelCommand = 
-        Cmd.new('no-xlabel', nil, '--no-xlabel', []) do |plotmaker|
+      NoTitleLabelCommand = 
+        Cmd.new('no-title', nil, '--no-title', []) do |plotmaker|
         PlotStyle.current_plot_style(plotmaker).
-          set_label_style('x_label', {}, false)
+          set_label_style('title', {}, false)
       end
 
-      NoXAxisLabelCommand.describe("Disables X label for the plot", 
+      NoTitleLabelCommand.describe("Disables title for the plot", 
                                    <<"EOH", AxisGroup)
-Disables the X label for the current plot.
+Removes the title of the current plot.
 EOH
 
-
-      YAxisLabelCommand = 
-        Cmd.new('ylabel', '-y', '--ylabel', [ CmdArg.new('text') ],
-                FullTextStyleOptions) do |plotmaker, label, options|
-        PlotStyle.current_plot_style(plotmaker).
-          set_label_style('y_label', options, label)
+      X2Command = 
+        Cmd.new('x2', nil, '--x2', []) do |plotmaker|
+        plotmaker.interpreter.
+          run_commands("xaxis(top)\naxis-style(top,decoration=full)")
       end
 
-      YAxisLabelCommand.describe("Sets the Y label of the plot", 
-                                 <<"EOH", AxisGroup)
-Sets the Y label of the current plot.
+      X2Command.describe("Switches to top axis for subsequent curves", 
+                                   <<"EOH", AxisGroup)
+Switches to using the top axis for X axis for the subsequent curves,
+and turns on full decoration for the right axis. Shortcut for:
+
+# xaxis(top)
+# axis-style(top,decoration=full)
 EOH
 
-      NoYAxisLabelCommand = 
-        Cmd.new('no-ylabel', nil, '--no-ylabel', []) do |plotmaker|
-        PlotStyle.current_plot_style(plotmaker).
-          set_label_style('y_label', {}, false)
+      Y2Command = 
+        Cmd.new('y2', nil, '--y2', []) do |plotmaker|
+        plotmaker.interpreter.
+          run_commands("yaxis(right)\naxis-style(right,decoration=full)")
       end
 
-      NoYAxisLabelCommand.describe("Disables Y label for the plot", 
+      Y2Command.describe("Switches to right axis for subsequent curves", 
                                    <<"EOH", AxisGroup)
-Disables the Y label for the current plot.
+Switches to using the right axis for Y axis for the subsequent curves,
+and turns on full decoration for the right axis. Shortcut for:
+
+# yaxis(right)
+# axis-style(right,decoration=full)
 EOH
 
-      TitleLabelCommand = 
-        Cmd.new('title', '-t', '--title', [ CmdArg.new('text') ],
-                FullTextStyleOptions) do |plotmaker, label, options|
+      NewZAxisCommand = 
+        Cmd.new('new-zaxis', nil, '--new-zaxis',
+                [
+                 CmdArg.new('text')
+                ],ZAxisStyle) do |plotmaker, name, options|
+        axis = Styles::MapAxisStyle.new
         PlotStyle.current_plot_style(plotmaker).
-          set_label_style('title', options, label)
+          set_axis_style(name, axis)
+        axis.set_from_hash(options)
       end
-
-      TitleLabelCommand.describe("Sets the title of the plot", 
-                                 <<"EOH", AxisGroup)
-Sets the title of the current plot.
+      
+      NewZAxisCommand.
+        describe("Creates a Z axis", 
+                 <<"EOH", AxisGroup)
+Creates a named Z axis that can display information from Z color maps 
 EOH
 
+
       LabelStyleCommand = 
         Cmd.new('label-style', nil, '--label-style',
                 [ CmdArg.new('label') ], # Here: change the label too... 
@@ -396,7 +499,7 @@ Sets the style of the given label (see the type {type: label} for more
 information).
 
 The option text permits to also set the text of the label (does not
-work for ticks). 
+work for ticks).
 
 For tick labels, setting the color option also sets the color for the
 lines of the corresponding axis. If you don't want that, you can