ctioga2 0.0 → 0.1

data/lib/ctioga2/plotmaker.rb

@@ -1,5 +1,5 @@
 # plotmaker.rb: the main class for ctioga
-# copyright (c) 2006, 2007, 2008, 2009 by Vincent Fourmond
+# copyright (c) 2006, 2007, 2008, 2009, 2010 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
@@ -91,9 +91,12 @@
 #     toplevel (sub)plot positions are absolute ?)
 #     
 #   This scheme would allow for a relatively painless way to draw graphs...
+#
+# * Possibly wite 
+
 
 
-# TODO: make --xrange automatically select the range for the --math
+# \todo make --xrange automatically select the range for the --math
 # backend unless another range was explicitly specified.
 
 require 'ctioga2/utils'
@@ -130,15 +133,36 @@ require 'ctioga2/graphics/generator'
 require 'ctioga2/postprocess'
 
 
-
+## \mainpage CTioga2's code documentation.
 # This module contains all the classes used by ctioga
+#
+#
+# This holds the main page for CTioga2 code documentation. Most
+# interesting classes/namespaces are:
+# 
+# * CTioga2::PlotMaker
+# * CTioga2::Graphics
+# * CTioga2::Commands
+# * CTioga2::Data
+#
+# Have fun hacking...
 module CTioga2
 
-  Version::register_svn_info('$Revision: 98 $', '$Date: 2009-06-27 21:43:31 +0200 (Sat, 27 Jun 2009) $')
+  Version::register_svn_info('$Revision: 244 $', '$Date: 2011-01-23 23:36:02 +0100 (Sun, 23 Jan 2011) $')
 
   # This class is the core of ctioga. It parses the command-line arguments,
   # reads all necessary files and plots graphs. Most of its functionality
   # is delegated into classes.
+  #
+  # \todo An important point would be to provide a facility that holds
+  # all the default values. To each would be assigned a given name,
+  # and programs would only use something like
+  # \code
+  # value = Default::value('stuff')
+  # \endcode
+  # 
+  # Setting up defaults would only be a question of using one single
+  # command (with admittedly many optional arguments)
   class PlotMaker
 
     # Include logging facilities for ctioga2
@@ -180,6 +204,9 @@ module CTioga2
     # Whether intermediate files are cleaned up automatically
     # afterwards or not...
     attr_accessor :cleanup
+
+    # The stack of CurveStyle objects that were used so far.
+    attr_accessor :curve_style_stack
     
 
     # The first instance of PlotMaker created
@@ -217,6 +244,9 @@ module CTioga2
 
       # Remove intermediate files by default.
       @cleanup = true
+
+      # Make curve style stack empty
+      @curve_style_stack = []
     end
 
     # ctioga's entry point.
@@ -236,18 +266,18 @@ module CTioga2
         @interpreter.run_command_line(command_line)
         
         # Now, draw the main figure
-        file = draw_figure(@figure_name || "Plot", true)
+        file = draw_figure(@figure_name || "Plot-%03d", true)
       rescue SystemExit => e
         # We special-case the exit exception ;-)...
       rescue Exception => e
-        debug format_exception(e)
-        fatal "#{e.message}"
+        debug { format_exception(e) }
+        fatal { "#{e.message}" }
       end
     end
 
     # Flushes the current root object and starts a new one:
     def reset_graphics
-      draw_figure(@figure_name || "Plot", true)
+      draw_figure(@figure_name || "Plot-%03d", true)
 
       @root_object = Graphics::RootObject.new
       @curve_generator = Graphics::CurveGenerator.new
@@ -263,14 +293,38 @@ module CTioga2
       return "#{File.basename($0)} #{quoted_args}"
     end
 
-    # Draws the figure currently accumulated in the #root_object.
-    # It returns the path of the PDF file produced.
+    # Draws the figure currently accumulated in the #root_object.  It
+    # returns the path of the PDF file produced.
+    #
+    # If _figname_ contains a % sign, it will be interpreted as a
+    # format, and ctioga will attempt to find the first numbered file
+    # that does not exists.
     #
-    # TODO:
+    # \todo
     # * cleanup or not ?
-    def draw_figure(figname = "Plot", last = false)
+    def draw_figure(figname = "Plot-%03d", last = false)
       return if @root_object.empty?
-      info "Producing figure '#{figname}'"
+      
+      if figname =~ /%/
+        i = 0
+        prev = figname.dup
+        while true
+          f = figname % i
+          if f == prev
+            figname = f
+            break
+          end
+          if File::exist?("#{f}.pdf")
+            i += 1
+          else
+            figname = f
+            break
+          end
+          prev = f
+        end
+      end
+      
+      info { "Producing figure '#{figname}'" }
 
       t = create_figure_maker
       # If figname is clearly a path, we split it into directory/name
@@ -304,20 +358,21 @@ module CTioga2
     # Add *one* Data::Dataset object using the current style (that can
     # be overridden by stuff given as options) to the #root_object.
     #
-    # TODO: here, keep a state of the current styles:
+    # \todo here, keep a state of the current styles:
     # * which is the color/marker/filling and so on of the curve ?
     # * are we drawing plain 2D curve, a histogram or something
     #   even more fancy ?
     # * this should be a separated class.
     #
-    # TODO: all curve objects should only take a Data::Dataset and a
+    # \todo all curve objects should only take a Data::Dataset and a
     # style as arguments to new.
     def add_curve(dataset, options = {})
       plot = @root_object.current_plot
       curve = @curve_generator.
         curve_from_dataset(plot, dataset, options)
       plot.add_element(curve)
-      info "Adding curve '#{dataset.name}' to the current plot"
+      @curve_style_stack << curve.curve_style
+      info { "Adding curve '#{dataset.name}' to the current plot" }
     end
 
     # Transforms a _dataset_spec_ into one or several Data::Dataset
@@ -328,8 +383,8 @@ module CTioga2
       begin
         sets = @data_stack.get_datasets(dataset_spec, options)
       rescue Exception => exception
-        error "A problem occurred while processing dataset '#{dataset_spec}' using backend #{@data_stack.backend_factory.current.description.name}. Ignoring it."
-        debug format_exception(exception)
+        error { "A problem occurred while processing dataset '#{dataset_spec}' using backend #{@data_stack.backend_factory.current.description.name}. Ignoring it." }
+        debug { format_exception(exception) }
         return
       end
       for set in sets
@@ -358,6 +413,15 @@ module CTioga2
       else
         title = ""
       end
+
+      # We use Vincent's algorithm for major ticks when available ;-)...
+      begin
+        t.vincent_or_bill = true
+        info { "Using Vincent's algorithm for major ticks" }
+      rescue
+        info { "Using Bill's algorithm for major ticks" }
+      end
+
       
       # We now use \pdfinfo to provide information about the version
       # of ctioga2 used to produce the PDF, and the command-line if
@@ -409,7 +473,7 @@ EOH
     PlotLastCommand.describe("Plots the last dataset pushed onto the stack",
                              <<EOH, PlotGroup)
 Plots the last dataset pushed onto the data stack (or the one
-specified with the 'which' option), with the current style. All
+specified with the @which@ option), with the current style. All
 aspects of the curve style (colors, markers, line styles...) can be
 overridden through the use of options.
 EOH
@@ -478,7 +542,7 @@ EOD
 
     PageSizeCommand = 
       Cmd.new("page-size",'-r',"--page-size", 
-              [ CmdArg.new('text') ], # TODO: change that !
+              [ CmdArg.new('text') ], # \todo change that !
               { 'count-legend' => CmdArg.new('boolean')}
               ) do |plotmaker, size, options|
       plotmaker.root_object.set_page_size(size)
@@ -522,6 +586,13 @@ EOH
 Sets the name of the figure, which is also the base name for the output file.
 This has nothing to do with the title of the plot, which can be set using
 the command {command: title}.
+
+If the name contains a %, it is interpreted by ctioga2 as a
+printf-like format. It will attempt to find the first file that does
+not exist, feeding it with increasing numbers.
+
+The default value is now Plot-%03d, which means you'll get increasing numbers
+automatically.
 EOH
 
     OutputNowCommand = 

data/lib/ctioga2/postprocess.rb

@@ -17,11 +17,11 @@ require 'ctioga2/log'
 
 module CTioga2
 
-  Version::register_svn_info('$Revision: 79 $', '$Date: 2009-06-08 18:50:47 +0200 (Mon, 08 Jun 2009) $')
+  Version::register_svn_info('$Revision: 155 $', '$Date: 2010-06-21 21:41:32 +0200 (Mon, 21 Jun 2010) $')
 
   # What happens to generated PDF files ?
   #
-  # TODO:
+  # \todo
   # * handle movie generation ? That would be fun !
   class PostProcess
 
@@ -76,21 +76,21 @@ module CTioga2
       # Converts to SVG if applicable
       if @svg
         target = file.sub(/(\.pdf)?$/,'.svg')
-        info "Converting #{file} to SVG"
+        info { "Converting #{file} to SVG" }
         spawn("pdf2svg #{file} #{target}")
       end
 
       if @eps
         target = file.sub(/(\.pdf)?$/,'.eps')
-        info "Converting #{file} to EPS"
-        spawn("pdftops -eps -paper match #{file} #{target}")
+        info { "Converting #{file} to EPS" }
+        ## \todo provide some facility to pass options to pdftops ?
+        spawn("pdftops -eps -level2 -paper match #{file} #{target}")
       end
 
       # Converts to PNG if applicable
       if @png_res
         target = file.sub(/(\.pdf)?$/,'.png')
-        info "Converting #{file} to PNG"
-        
+        info { "Converting #{file} to PNG" }
         spawn "convert -density #{(@png_oversampling * @png_scale * 72).to_i} #{file} -resize #{@png_res.join('x')} #{target}"
       end
 
@@ -103,7 +103,7 @@ module CTioga2
         else
           cmd = "#{@viewer} #{file}"
         end
-        info "Spawning the viewer as requested for #{file}"
+        info { "Spawning the viewer as requested for #{file}" }
         spawn(cmd)
       end
     end

data/lib/ctioga2/utils.rb

@@ -34,7 +34,7 @@ module CTioga2
     # arguments and have the Date and Revision svn:keyword:. Use this
     # way:
     #
-    #  Version::register_svn_info('$Revision: 63 $', '$Date: 2009-05-30 15:32:12 +0200 (Sat, 30 May 2009) $')
+    #  Version::register_svn_info('$Revision: 194 $', '$Date: 2010-11-22 10:26:54 +0100 (Mon, 22 Nov 2010) $')
     #
     # To set the correct properties, the following command-line can be
     # used:
@@ -69,16 +69,16 @@ module CTioga2
     }
 
     # The position of the URL, used for getting the version
-    SVN_URL = '$HeadURL: svn+ssh://rubyforge.org/var/svn/ctioga2/releases/ctioga2-0.0/lib/ctioga2/utils.rb $'
+    SVN_URL = '$HeadURL: svn+ssh://rubyforge.org/var/svn/ctioga2/releases/ctioga2-0.1/lib/ctioga2/utils.rb $'
     
-    # The version of ctigoa2
+    # The version of ctioga2
     CTIOGA_VERSION = if SVN_URL =~ /releases\/ctioga2-([^\/]+)/
                        $1
                      else
                        "SVN version"
                      end
 
-    register_svn_info('$Revision: 63 $', '$Date: 2009-05-30 15:32:12 +0200 (Sat, 30 May 2009) $')
+    register_svn_info('$Revision: 194 $', '$Date: 2010-11-22 10:26:54 +0100 (Mon, 22 Nov 2010) $')
 
   end
 
@@ -99,6 +99,16 @@ module CTioga2
       end
     end
 
+    # Takes two arrays of the same size (vectors) and mix them
+    # a * r + b * (1 - r)
+    def self.mix_objects(a,b,r)
+      ret = a.dup
+      a.each_index do |i|
+        ret[i] = a[i] * r + b[i] * (1 - r)
+      end
+      return ret
+    end
+
     # Quotes a string so it can be included directly within a
     # \pdfinfo statement (for instance).
     def self.pdftex_quote_string(str)
@@ -115,6 +125,15 @@ module CTioga2
       end
     end
 
+    # Binomial coefficients (for the smooth filter)
+    def self.cnk(n,k)
+      res = 1.0
+      n.downto(n - k) { |i| res *= i}
+      k.downto(1) {|i| res = res/i }
+      return res
+    end
+    
+
   end
 
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ctioga2
 version: !ruby/object:Gem::Version 
-  version: "0.0"
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
 platform: ruby
 authors: 
 - Vincent Fourmond <vincent.fourmond@9online.fr>
@@ -9,19 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-22 00:00:00 +02:00
+date: 2011-01-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tioga
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.11"
-    version: 
+        hash: 21
+        segments: 
+        - 1
+        - 13
+        version: "1.13"
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: vincent.fourmond@9online.fr
 executables: 
@@ -31,83 +41,99 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/ctioga2/graphics/legends/items.rb
-- lib/ctioga2/graphics/legends/storage.rb
-- lib/ctioga2/graphics/legends/area.rb
-- lib/ctioga2/graphics/legends/provider.rb
-- lib/ctioga2/graphics/styles/legend.rb
-- lib/ctioga2/graphics/styles/plot.rb
-- lib/ctioga2/graphics/styles/sets.rb
-- lib/ctioga2/graphics/styles/background.rb
-- lib/ctioga2/graphics/styles/axes.rb
-- lib/ctioga2/graphics/styles/drawable.rb
-- lib/ctioga2/graphics/styles/carrays.rb
+- lib/ctioga2/data/indexed-dtable.rb
+- lib/ctioga2/data/datacolumn.rb
+- lib/ctioga2/data/point.rb
+- lib/ctioga2/data/stack.rb
+- lib/ctioga2/data/filters.rb
+- lib/ctioga2/data/dataset.rb
+- lib/ctioga2/data/backends/factory.rb
+- lib/ctioga2/data/backends/parameter.rb
+- lib/ctioga2/data/backends/description.rb
+- lib/ctioga2/data/backends/backends.rb
+- lib/ctioga2/data/backends/backend.rb
+- lib/ctioga2/data/backends/backends/math.rb
+- lib/ctioga2/data/backends/backends/text.rb
+- lib/ctioga2/data/backends/backends/gnuplot.rb
+- lib/ctioga2/log.rb
+- lib/ctioga2/plotmaker.rb
+- lib/ctioga2/commands/type.rb
+- lib/ctioga2/commands/general-commands.rb
+- lib/ctioga2/commands/commands.rb
+- lib/ctioga2/commands/doc/introspection.rb
+- lib/ctioga2/commands/doc/documentation-commands.rb
+- lib/ctioga2/commands/doc/help.rb
+- lib/ctioga2/commands/doc/markup.rb
+- lib/ctioga2/commands/doc/doc.rb
+- lib/ctioga2/commands/doc/wordwrap.rb
+- lib/ctioga2/commands/doc/man.rb
+- lib/ctioga2/commands/doc/html.rb
+- lib/ctioga2/commands/strings.rb
+- lib/ctioga2/commands/variables.rb
+- lib/ctioga2/commands/parsers/file.rb
+- lib/ctioga2/commands/parsers/command-line.rb
+- lib/ctioga2/commands/groups.rb
+- lib/ctioga2/commands/interpreter.rb
+- lib/ctioga2/commands/arguments.rb
+- lib/ctioga2/commands/general-types.rb
+- lib/ctioga2/graphics/legends.rb
 - lib/ctioga2/graphics/styles/curve.rb
+- lib/ctioga2/graphics/styles/errorbar.rb
+- lib/ctioga2/graphics/styles/gradients.rb
 - lib/ctioga2/graphics/styles/factory.rb
-- lib/ctioga2/graphics/styles/texts.rb
+- lib/ctioga2/graphics/styles/carrays.rb
+- lib/ctioga2/graphics/styles/location.rb
+- lib/ctioga2/graphics/styles/map-axes.rb
+- lib/ctioga2/graphics/styles/drawable.rb
+- lib/ctioga2/graphics/styles/axes.rb
+- lib/ctioga2/graphics/styles/background.rb
 - lib/ctioga2/graphics/styles/base.rb
-- lib/ctioga2/graphics/types/boxes.rb
+- lib/ctioga2/graphics/styles/sets.rb
+- lib/ctioga2/graphics/styles/plot.rb
+- lib/ctioga2/graphics/styles/colormap.rb
+- lib/ctioga2/graphics/styles/texts.rb
+- lib/ctioga2/graphics/styles/legend.rb
+- lib/ctioga2/graphics/styles.rb
+- lib/ctioga2/graphics/coordinates.rb
+- lib/ctioga2/graphics/legends/area.rb
+- lib/ctioga2/graphics/legends/items.rb
+- lib/ctioga2/graphics/legends/storage.rb
+- lib/ctioga2/graphics/legends/provider.rb
+- lib/ctioga2/graphics/types.rb
+- lib/ctioga2/graphics/elements/subplot.rb
+- lib/ctioga2/graphics/elements/parametric2d.rb
+- lib/ctioga2/graphics/elements/primitive.rb
+- lib/ctioga2/graphics/elements/region.rb
+- lib/ctioga2/graphics/elements/curve2d.rb
+- lib/ctioga2/graphics/elements/containers.rb
+- lib/ctioga2/graphics/elements/tangent.rb
+- lib/ctioga2/graphics/elements/xyz-map.rb
+- lib/ctioga2/graphics/elements/contour.rb
+- lib/ctioga2/graphics/elements/gradient-region.rb
+- lib/ctioga2/graphics/elements/element.rb
+- lib/ctioga2/graphics/subplot-commands.rb
+- lib/ctioga2/graphics/generator.rb
+- lib/ctioga2/graphics/elements.rb
 - lib/ctioga2/graphics/types/bijection.rb
+- lib/ctioga2/graphics/types/location.rb
 - lib/ctioga2/graphics/types/dimensions.rb
 - lib/ctioga2/graphics/types/point.rb
 - lib/ctioga2/graphics/types/boundaries.rb
-- lib/ctioga2/graphics/legends.rb
-- lib/ctioga2/graphics/elements/containers.rb
-- lib/ctioga2/graphics/elements/primitive.rb
-- lib/ctioga2/graphics/elements/subplot.rb
-- lib/ctioga2/graphics/elements/element.rb
-- lib/ctioga2/graphics/elements/curve2d.rb
+- lib/ctioga2/graphics/types/boxes.rb
+- lib/ctioga2/graphics/types/grid.rb
 - lib/ctioga2/graphics/root.rb
-- lib/ctioga2/graphics/styles.rb
-- lib/ctioga2/graphics/types.rb
-- lib/ctioga2/graphics/generator.rb
-- lib/ctioga2/graphics/subplot-commands.rb
-- lib/ctioga2/graphics/coordinates.rb
-- lib/ctioga2/graphics/elements.rb
-- lib/ctioga2/commands/parsers/file.rb
-- lib/ctioga2/commands/parsers/command-line.rb
-- lib/ctioga2/commands/doc/markup.rb
-- lib/ctioga2/commands/doc/introspection.rb
-- lib/ctioga2/commands/doc/html.rb
-- lib/ctioga2/commands/doc/doc.rb
-- lib/ctioga2/commands/doc/documentation-commands.rb
-- lib/ctioga2/commands/doc/help.rb
-- lib/ctioga2/commands/doc/man.rb
-- lib/ctioga2/commands/general-types.rb
-- lib/ctioga2/commands/groups.rb
-- lib/ctioga2/commands/commands.rb
-- lib/ctioga2/commands/type.rb
-- lib/ctioga2/commands/interpreter.rb
-- lib/ctioga2/commands/arguments.rb
-- lib/ctioga2/commands/variables.rb
-- lib/ctioga2/commands/strings.rb
-- lib/ctioga2/commands/general-commands.rb
-- lib/ctioga2/data/backends/backends/text.rb
-- lib/ctioga2/data/backends/backends/gnuplot.rb
-- lib/ctioga2/data/backends/backends/math.rb
-- lib/ctioga2/data/backends/parameter.rb
-- lib/ctioga2/data/backends/description.rb
-- lib/ctioga2/data/backends/backend.rb
-- lib/ctioga2/data/backends/factory.rb
-- lib/ctioga2/data/backends/backends.rb
-- lib/ctioga2/data/merge.rb
-- lib/ctioga2/data/dataset.rb
-- lib/ctioga2/data/stack.rb
-- lib/ctioga2/data/datacolumn.rb
-- lib/ctioga2/data/filters.rb
-- lib/ctioga2/data/point.rb
-- lib/ctioga2/plotmaker.rb
+- lib/ctioga2/utils.rb
+- lib/ctioga2/postprocess.rb
+- lib/ctioga2/metabuilder/type.rb
+- lib/ctioga2/metabuilder/types.rb
 - lib/ctioga2/metabuilder/types/lists.rb
 - lib/ctioga2/metabuilder/types/dates.rb
+- lib/ctioga2/metabuilder/types/numbers.rb
 - lib/ctioga2/metabuilder/types/styles.rb
 - lib/ctioga2/metabuilder/types/strings.rb
 - lib/ctioga2/metabuilder/types/coordinates.rb
-- lib/ctioga2/metabuilder/types/numbers.rb
-- lib/ctioga2/metabuilder/type.rb
-- lib/ctioga2/metabuilder/types.rb
-- lib/ctioga2/utils.rb
-- lib/ctioga2/log.rb
-- lib/ctioga2/postprocess.rb
+- lib/ctioga2/metabuilder/types/data.rb
+- lib/ctioga2/metabuilder/types/generic.rb
 - COPYING
 - Changelog
 - setup.rb
@@ -122,23 +148,29 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ctioga2
-rubygems_version: 1.3.4
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: CTioga2 - command-line interface for the Tioga plotting library
+summary: ctioga2 - the polymorphic plotting program
 test_files: []