ctioga2 0.7 → 0.8

data/lib/ctioga2/graphics/elements.rb

@@ -20,6 +20,7 @@ require 'ctioga2/graphics/elements/subplot'
 require 'ctioga2/graphics/elements/region'
 require 'ctioga2/graphics/elements/gradient-region'
 require 'ctioga2/graphics/elements/curve2d'
+require 'ctioga2/graphics/elements/histogram'
 require 'ctioga2/graphics/elements/parametric2d'
 require 'ctioga2/graphics/elements/xyz-map'
 require 'ctioga2/graphics/elements/xyz-contour'
@@ -30,8 +31,6 @@ require 'ctioga2/graphics/elements/contour'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 405 $', '$Date: 2013-08-22 16:25:13 +0200 (Thu, 22 Aug 2013) $')
-
   module Graphics
 
     # Now, various commands pertaining to various drawables

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

@@ -17,8 +17,6 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 529 $', '$Date: 2013-09-25 18:23:27 +0200 (Wed, 25 Sep 2013) $')
-
   module Graphics
 
     module Elements
@@ -51,6 +49,16 @@ module CTioga2
         # Defaults to the #legend_storage, but it can be changed
         attr_accessor :legend_item_target
 
+        # A general-purpose cache that objects may use.
+        #
+        # It is a hash, and its contents are reset at the beginning of
+        # each invocation of #do.
+        attr_accessor :gp_cache
+
+
+        # @todo Add an iterator over all leaf elements (including
+        # children or not ?)
+
         # Creates an empty new Container with the given _parent_.
         def initialize(parent = nil, root = nil)
           super()
@@ -72,6 +80,12 @@ module CTioga2
           @legend_area = nil
         end
 
+        def do(t)
+          # reset the cache
+          @gp_cache = {}
+          super
+        end
+
         # Returns the number of child elements
         def size
           return @elements.size
@@ -123,6 +137,22 @@ module CTioga2
           end
         end
 
+        def each_item(leaf_only = true, recursive = false, tl = true, &blk)
+          if (!recursive && !tl)
+            return              # We're at the bottom level
+          end
+          for el in @elements
+            if el.respond_to? :each_item
+              if ! leaf_only
+                blk.call(el)
+              end
+              el.each_item(leaf_only, recursive, false, &blk)
+            else
+              blk.call(el)
+            end
+          end
+        end
+
         # \todo provide coordinate conversion facilities...
 
         protected 

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

@@ -17,8 +17,6 @@ require 'ctioga2/graphics/elements/primitive'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 299 $', '$Date: 2011-03-15 11:22:20 +0100 (Tue, 15 Mar 2011) $')
-
   module Graphics
 
     module Elements

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

@@ -19,8 +19,6 @@ require 'Dobjects/Function'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 535 $', '$Date: 2013-10-02 20:31:21 +0200 (Wed, 02 Oct 2013) $')
-
   module Graphics
 
     module Elements

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

@@ -18,8 +18,6 @@ require 'ctioga2/log'
 # This module contains all the classes used by ctioga
 module CTioga2
 
-  Version::register_svn_info('$Revision: 535 $', '$Date: 2013-10-02 20:31:21 +0200 (Wed, 02 Oct 2013) $')
-
   # This module contains all graphical elements of CTioga2
   module Graphics
 
@@ -38,6 +36,7 @@ module CTioga2
         # LocationStyle object
         attr_writer :location
 
+        # Whether the object is clipped by default or not.
         attr_accessor :clipped
 
         
@@ -48,6 +47,8 @@ module CTioga2
           @clipped = true
 
           @depth = 50           # Hey, like xfig
+          
+          @gp_cache = {}
         end
 
         def depth
@@ -66,6 +67,7 @@ module CTioga2
         # redefine _do_ too if you need another debugging output.
         def do(f)
           debug { "plotting #{self.inspect}" }
+          @gp_cache = {}
           real_do(f)
         end
 

data/lib/ctioga2/graphics/elements/gradient-region.rb

@@ -17,8 +17,6 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 288 $', '$Date: 2011-02-22 21:12:58 +0100 (Tue, 22 Feb 2011) $')
-
   module Graphics
 
     module Elements

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

@@ -0,0 +1,298 @@
+# histogram.rb: a histogram
+# 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 'ctioga2/graphics/elements/curve2d'
+
+require 'set'
+
+require 'Dobjects/Function'
+
+
+module CTioga2
+
+  module Graphics
+
+    module Elements
+
+      # A histogram
+      class Histogram < Curve2D
+          
+
+        include Log
+        include Dobjects
+
+        # The histogram style at the moment of the creation of the
+        # object.
+        attr_accessor :histogram_style
+
+
+        def initialize(dataset, style, hstyle)
+          super(dataset, style)
+          @histogram_style = hstyle
+        end
+
+        def get_boundaries
+          ry = modified_yvalues
+          bnds =  Types::Boundaries.bounds(@function.x, ry)
+          if ! @within_gb
+            base = get_base
+
+            nb = bnds.dup
+            nb.bottom = base
+            nb.top = base
+
+            # include the width ?
+          
+
+            bnds.extend(nb)
+          end
+          return bnds
+        end
+
+
+        # First, a very naive way.
+
+        def make_path(t)
+          base = get_base
+
+          w, ho, yo = *get_properties(t)
+
+          org = get_cached_organization
+          h_o = org[:has_offsets][self]
+
+          for x,y in @function
+            xl = x + ho
+            xr = xl + w
+            b = yo[x]
+            t.move_to_point(xl, base+b)
+            t.append_point_to_path(xl, y+b)
+            t.append_point_to_path(xr, y+b)
+            t.append_point_to_path(xr, base+b)
+            if h_o               # close !
+              t.move_to_point(xl, base+b)
+            end
+          end
+        end
+
+        # The algorithms for closing the path just look ugly for
+        # histograms that are offset from something. The reasoning
+        # does not apply here.
+        def make_closed_path(t, close_type = nil)
+          org = get_cached_organization
+          if org[:has_offsets][self]
+            make_path(t)
+          else
+            super
+          end
+        end
+
+        protected
+
+        def modified_yvalues
+          org = get_cached_organization
+          if org[:has_offsets][self]
+            vo = org[:y_offsets][self]
+            vc = @function.y.dup
+            vc.size.times do |i|
+              vc[i] += vo[@function.x[i]]
+            end
+            return vc
+          else
+            return @function.y
+          end
+        end
+
+        # The cache is setup in two bits:
+        # * one fully metric-independent (i.e. that does not need the
+        #   FigureMaker object)
+        # * the metric cache, holding information about widths and the
+        #   likes, that builds upon the first
+
+
+        # This first cache is the organization of the whole
+        # histograms. It is independent of the metrics.
+        def get_cached_organization
+          if ! parent.gp_cache.key?(:histograms)
+            cache = {} 
+            parent.gp_cache[:histograms] = cache
+
+
+            hists = []
+
+            x_values = Set.new
+
+            parent.each_item do |el|
+              if el.is_a?(Histogram)
+                hists << el
+                x_values.merge(el.function.x.to_a)
+              end
+            end
+
+            cache[:list] = hists
+            cache[:xvalues] = x_values
+
+            # First, we must split the histograms in columns, based on
+            # the :cumulative attribute. If positive or null, then the
+            # index is that. If false, then, the next available index.
+            # if negative, then the next available index, unless it exists
+            # the index conversion here.
+            index_cnv = {}
+
+            columns = []
+            cache[:indices] = {}
+            for h in hists
+              cm = h.histogram_style.cumulative
+              if ! cm 
+                cm = columns.size
+              elsif cm < 0
+                if ! index_cnv.key?(cm)
+                  index_cnv[cm] = columns.size
+                end
+                cm = index_cnv[cm]
+              end
+              columns[cm] ||= []
+              columns[cm] << h
+              cache[:indices][h] = cm
+            end
+            cache[:columns] = columns
+
+            offsets = {}
+            isoff = {}
+            for ar in columns
+              base = {}
+              for x in x_values
+                base[x] = 0.0
+              end
+              next unless ar
+              index = 0
+              for h in ar
+                offsets[h] = base.dup
+                isoff[h] = (index > 0)
+                for x,y in h.function
+                  base[x] += y
+                end
+                index += 1
+              end
+            end
+            cache[:y_offsets] = offsets
+            cache[:has_offsets] = isoff
+
+          end
+          return parent.gp_cache[:histograms]
+        end
+
+        # Returns the cached metrics of all the histograms,
+        # recomputing it in the process.
+        def get_cached_metrics(t)
+          if ! parent.gp_cache.key?(:histogram_metrics)
+            cache = {} 
+            parent.gp_cache[:histogram_metrics] = cache
+
+            org = get_cached_organization
+            cols = org[:columns]
+            x_values = org[:xvalues]
+
+            # Overall size of intra seps, in figure coordinates. Only
+            # intra sep of the first element in a column counts !
+            intra_sep = 0
+            cols[0..-2].each do |col|
+              if col && col.first.histogram_style.intra_sep
+                intra_sep += col.first.histogram_style.intra_sep.to_figure(t, :x)
+              end
+            end
+
+            inter_sep = if @histogram_style.gap
+                          @histogram_style.gap.to_figure(t, :x)
+                        elsif @histogram_style.intra_sep
+                          @histogram_style.intra_sep.to_figure(t, :x)
+                        else
+                          0
+                        end
+
+            # OK, now we have all the values. For now, we assume more
+            # or less that they are evenly spaced.
+            #
+            # Later, we'll have to use a conversion function for X
+            # values (which means in particular that they won't be
+            # positioned at the exact X value, but that's already the
+            # case anyway).
+            width = (x_values.max - x_values.min)/(x_values.size - 1)
+
+            # Available width
+            aw = width - intra_sep - inter_sep
+            if aw < 0
+              error { "Too much padding around the histograms leading to negative size. Try using smaller intra-sep or inter-sep. Ignoring them for now" }  
+              aw = width
+            end
+
+            iw = aw/cols.size
+            offset = -0.5 * (width - inter_sep)
+
+            # @todo Add padding between the hists and around the
+            # groups of histograms.
+            
+            for col in cols
+              c = {}
+              c[:width] = iw
+              c[:x_offset] = offset
+              offset += iw
+              next unless col
+              if col.first.histogram_style.intra_sep
+                offset += h.histogram_style.intra_sep.to_figure(t, :x)
+              end
+              for h in col
+                cache[h] = c
+              end
+            end
+          end
+          return parent.gp_cache[:histogram_metrics]
+        end
+
+        # Computes the horizontal offset and the width of the
+        # histogram. Relies on a cache installed onto the parent.
+        def get_properties(t)
+          metrics = get_cached_metrics(t)
+          s = metrics[self]
+          org = get_cached_organization
+          return [s[:width], s[:x_offset], org[:y_offsets][self] ]
+        end
+
+        def get_base
+          ct = @curve_style.fill.close_type
+          if ct
+            if ! ct.horizontal?
+              warning { "Cannot use fill types other than horizontal for histograms: #{ct.type}. Using default value" }
+              return 0
+            end
+            
+            @within_gb = true
+            bnds = parent.get_el_boundaries(self)
+            @within_gb = false
+
+            begin 
+              return ct.effective_value(bnds)
+            rescue 
+              return @function.y.min          # default value. Make sense ?
+            end
+          end
+
+          # @todo Horizontal histograms ?? 
+          return 0
+        end
+
+      end
+    end
+  end
+end

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

@@ -19,8 +19,6 @@ require 'Dobjects/Function'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 535 $', '$Date: 2013-10-02 20:31:21 +0200 (Wed, 02 Oct 2013) $')
-
   module Graphics
 
     module Elements
@@ -122,7 +120,6 @@ module CTioga2
 
         # Draws the markers, if applicable.
         def draw_markers(t)
-          @parametric_style.prepare
           if @curve_style.has_marker?
             # We use a default color map for the markers
             @curve_style.marker_color_map ||= 
@@ -148,6 +145,13 @@ module CTioga2
 
             # draw_fill(t)
             # draw_errorbars(t)
+
+            @parametric_style.prepare
+            if @dataset.z_columns < @parametric_style.z_columns_needed
+              error { "Need #{@parametric_style.z_columns_needed} Z columns, but have only #{@dataset.z_columns} for dataset #{@dataset.name}" }
+              return
+            end
+              
             draw_path(t)
             draw_markers(t)