ctioga2 0.13.1 → 0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a07d4a54cc29cbb71a8bc00666a543ac18e517a7
-  data.tar.gz: d63a48a1b341054366ca8ac3b3a5340f245a5fb7
+  metadata.gz: 6bef5792441b163c872287441af1c3875eb51ae2
+  data.tar.gz: dc7ffd6240a7309e651aba7bb7f45cf4e8f204f4
 SHA512:
-  metadata.gz: 89f0a3753f9571ac00d67debd05fe2c6cacb2aad6b56f3b16e5ada80027546dee08ac9fd4d7f66a327690f15b2b8fd1a88d5777faa5adde79557399c88d50028
-  data.tar.gz: b78c99f8c03e09524c002e3d4512958e711eef9443dd0d978db5fc410b1fc53f047a093c8df4530ca1554f1448f3b74175253e01e7735926c9f85cd87c1a3f9d
+  metadata.gz: 87f0530a92f0cd9f5328d1d399325b35108bfafce596e12315181d430307eedcb36771e21fb6f68445c2ba6e5aa233d5faaafdba6aeabac7388a6662908e33e5
+  data.tar.gz: a521da3bd85d7a7c71e3e982f2d524501cd31c4ceee773f8256c2a3620619e923a632e399a84134b851d01a44044c30334a7fdaf1e6de1046f8471f1d1103b87

data/Changelog

@@ -1,3 +1,29 @@
+ctioga2 (0.14)
+
+  * A --bin command to bin data columns
+  * A --hide command
+  * A --append command to load a dataset and append it to the previous one
+  * a --draw-legend-pictogram to draw the legend pictogram of a curve
+  * Selection of plot elements by class for commands that take several
+    elements (such as --hide)
+  * A series of command-file functions like $(xmax), $(yrange) and so on
+    to gather informations about datasets on the stack
+  * Can now select the line cap using the /line-cap option (or the 
+    --line-cap command), especially useful for /path-style=impulses
+  * Can now select a dataset using its plot #id
+  * A grid:next specification to automatically switch to the next grid 
+    element
+  * More informative error messages when encountering weird data such as
+    infinite numbers, see http://sourceforge.net/p/ctioga2/tickets/2/
+  * Automatic styles for even/odd rows/columns of grids
+  * Switch to YAML for debug output, greatly speeds up writing out debug 
+    information
+  * Now, color mixing between sets occur with !! and not ! as before, not to
+    confuse with plain color mixing
+  * Quite a few minor improvements/bug fixes
+
+ -- Vincent Fourmond <vincent.fourmond@9online.fr>  Thu 18 Feb 20:48:58 CET 2016
+
 ctioga2 (0.13.1)
 
   * Fix installation problems with recent ruby versions

data/bin/ct2-make-movie

@@ -281,7 +281,10 @@ for f in args
                  "--set", "index", "#{index}", 
                 "-f", file, "--name", name, "-r", ct2_page_size]
   puts "Running: #{ct2_cmdline.join(" ")}"
-  system(*ct2_cmdline)
+  if ! system(*ct2_cmdline)
+    puts " -> failed with error code #$?, aborting"
+    exit 1
+  end
 
   b = nil
 

data/bin/ctioga2

@@ -50,5 +50,5 @@ require 'ctioga2/plotmaker'
 
 plot_maker = CTioga2::PlotMaker.new
 
-plot_maker.run(ARGV)
+exit(plot_maker.run(ARGV))
 

data/lib/ctioga2/commands/commands.rb

@@ -293,6 +293,8 @@ module CTioga2
         if compulsory_args.size != @arguments.size
           raise ArgumentNumberMismatch, "Command #{@name} was called with #{args.size} arguments, but it takes #{@arguments.size}"
         end
+        plotmaker_target.interpreter.
+          add_instruction(Instruction.new(self, compulsory_args, optional_args))
         args += compulsory_args
         if has_options?
           if optional_args

data/lib/ctioga2/commands/doc/doc.rb

@@ -113,7 +113,7 @@ module CTioga2
 
           os = ""
           for k,v in cmd.optional_arguments
-            os << " /#{k}=#{v.type.name}"
+            os << " /#{k.gsub(/_/,'-')}=#{v.type.name}"
           end
           s2 = WordWrapper.wrap(os, size-4) # 4 for the spaces
           str << "\nOptions: #{s2.join("\n    ")}"

data/lib/ctioga2/commands/doc/documentation-commands.rb

@@ -102,6 +102,44 @@ EOH
 Prints the HTML documentation for all styles.
 EOH
 
+      HTMLColorsOptions = {
+        'columns' => CmdArg.new('integer'),
+        'class' => CmdArg.new('text'),
+        'div-class' => CmdArg.new('text'),
+        'rect-width' => CmdArg.new('integer'),
+        'rect-height' => CmdArg.new('integer')
+      }
+
+      
+      WriteHTMLColors = 
+        Cmd.new("write-html-colors", nil, "--write-html-colors", 
+                [], HTMLColorsOptions) do |plotmaker, opts|
+        html = HTML.new(plotmaker.interpreter.doc)
+        html.write_colors(opts)
+      end
+      
+      WriteHTMLColors.describe("HTML documentation for colors",
+                               <<EOH, DocumentationGenerationGroup)
+Prints the HTML documentation for the colors, i.e. a color list.
+EOH
+
+      WriteHTMLColorSets = 
+        Cmd.new("write-html-color-sets", nil, "--write-html-color-sets", 
+                [], HTMLColorsOptions.
+                    merge({
+                            'include' => CmdArg.new('regexp'),
+                            'exclude' => CmdArg.new('regexp')
+                          })) do |plotmaker, opts|
+        html = HTML.new(plotmaker.interpreter.doc)
+        html.write_color_sets(opts)
+      end
+      
+      WriteHTMLColorSets.describe("HTML documentation for color sets",
+                              <<EOH, DocumentationGenerationGroup)
+Prints the HTML documentation for the color sets, i.e. the list of
+all the sets together with the corresponding colors
+EOH
+
 
       WriteHTMLBackends = 
         Cmd.new("write-html-backends", nil, "--write-html-backends", 

data/lib/ctioga2/commands/doc/html.rb

@@ -279,7 +279,91 @@ module CTioga2
               end
             end
           end
+        end
+
+        def write_color_list(colors, opts, out = STDOUT, color_names = nil)
+          columns = opts["columns"] || 5
+          cls = opts["class"] || "color-list"
+          div_cls = opts["div-class"] 
+          rw = opts["rect-width"] || 80
+          rh = opts["rect-height"] || 40
+
+          div_common = (div_cls ? "class='#{div_cls}' style='" :
+                          "style='width:#{rw};height:#{rh};")
+
+                    out.puts "<table class='#{cls}'>"
+
+          idx = 0
+          for color in colors
+            if idx % columns == 0
+              if idx > 0
+                out.puts "</tr>"
+              end
+              out.puts "<tr>"
+            end
+            if color
+              
+              cls = "##{Utils::color_to_html(color)}"
 
+              if color_names
+                c = color_names[idx]
+              else
+                c = Utils::color_name_by_value(color)
+              end
+              cb = if c
+                     "#{c}<br/>"
+                   else
+                     ""
+                   end
+              
+              out.puts "<td><div #{div_common}background-color: #{cls};color: #{cls};'>#{cb}</div>#{cb}#{cls}</td>"
+            else
+              out.puts "<td>no color</td>"
+            end
+            idx += 1
+          end
+          
+          out.puts "</tr></table>"
+          
+        end
+
+        # Writes out a list
+        #
+        #@todo Split that to just write an ordered list of colors (get
+        #their names ?)
+        def write_colors(opts, out = STDOUT)
+          clrs = Tioga::ColorConstants::constants.sort
+          colors = clrs.map do |c|
+            Tioga::ColorConstants::const_get(c)
+          end
+          color_names = clrs.map do |c|
+            c.to_s
+          end
+          
+          write_color_list(colors, opts, out, color_names)
+        end
+
+        def write_color_sets(opts, out = STDOUT)
+          sets = Graphics::Styles::CurveStyleFactory::parameters['color'].sets
+          set_names = sets.keys.sort
+
+          if opts['include']
+            set_names = set_names.select do |x|
+              x =~ opts['include']
+            end
+          elsif opts['exclude']
+            set_names = set_names.select do |x|
+              x !~ opts['exclude']
+            end
+          end
+
+          set_names = sets.keys.sort
+
+          for s in set_names
+            out.puts "<h5>Color set: <code>#{s}</code></h5>"
+            colors = sets[s]
+            write_color_list(colors, opts, out)
+          end
         end
         
 

data/lib/ctioga2/commands/general-commands.rb

@@ -169,9 +169,13 @@ EOH
 With this on, ctioga2 writes a whole lot of debugging information. You
 probably will not need that unless you intend to file a bug report or
 to tackle a problem yourself.
+
+Be warned that it *will* slow down very significantly the processing
+of ctioga2 (up to hundreds of times slower), especially if you are not
+redirecting the output to a file.
 EOH
 
-    # Includes a file
+    # Prints the command-line used
     EchoCmd = 
       Cmd.new("echo", nil,  "--echo", [ ]) do |plotmaker|
       STDERR.puts "Command-line used: "
@@ -183,7 +187,22 @@ EOH
 Writes the whole command-line used to standard error, quoted in such a
 way that it should be usable directly for copy/paste.
 EOH
+
+    # Writes down the list of instruction run so far
+    PrintInstructionsCmd = 
+      Cmd.new("print-instructions", nil,  "--print-instructions", [ ]) do |plotmaker|
+      for ins in plotmaker.interpreter.instructions
+        puts ins.to_s
+      end
+    end
     
+    PrintInstructionsCmd.describe("Prints the list of all the instructions run so far", 
+                     <<EOH, GeneralGroup)
+Writes the list of all the instructions run so far.
+
+This is not very helpful for now, possibly.
+EOH
+
     
   end
 end

data/lib/ctioga2/commands/general-functions.rb

@@ -53,6 +53,8 @@ Running this will give the following syntax error:
 Doing it right would require the use of a decent amount of quotes.
 EOD
 
+    # dataset functions
+
     FuncPoint = Function.new("point", "Get dataset point information") do |pm, what, spec, *rest|
       dataset = if rest.first
                   pm.data_stack.stored_dataset(rest.first)
@@ -106,6 +108,30 @@ optional third. It is parsed as {type: stored-dataset}
 
 EOD
 
+    Stats = []
+    [:x, :y, :z].each do |col|
+      [:min, :max, :range, :avg].each do |what|
+        name = "#{col}#{what}"
+        Stats << Function.new(name, "Gets the #{what} of the #{col} column") do |pm, ds, *rest|
+          dataset = pm.data_stack.stored_dataset(ds)
+          cln = dataset.send(col)
+          clv = cln.values
+          case what
+          when :range
+            "#{clv.min}:#{clv.max}"
+          when :avg
+            return clv.sum/clv.size
+          else
+            clv.send(what)
+          end
+        end
+        Stats.last.describe <<EOD
+This is replaced by the the value of '#{what}' from the column '#{col}',
+applied to the dataset given.
+EOD
+      end
+    end
+        
 
     
   end

data/lib/ctioga2/commands/general-types.rb

@@ -159,6 +159,7 @@ A dataset that has already been loaded. It is either:
    dataset), 1 the second, -1 the last one, -2 the one before the last
    and so on. (it works just like Ruby's arrays).
  * The name of a named dataset.
+ * @#@ followed by the id of a plot element
 EOD
 
     # Something meant to be fed to PlotStyle#get_axis_style

data/lib/ctioga2/commands/instruction.rb

@@ -0,0 +1,61 @@
+# instruction.rb: an instruction
+# copyright (c) 2015 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/commands/arguments'
+require 'ctioga2/commands/groups'
+
+module CTioga2
+
+  module Commands
+
+
+    # This class represents an instruction, i.e. the execution of one
+    # Command. It is different in Command in that, for most of them,
+    # there will be arguments
+    class Instruction
+
+      # The Command
+      attr_accessor :command
+
+      # The list of its arguments, already in the correct type.
+      attr_accessor :arguments
+
+      # The options, already in the correct type
+      attr_accessor :options
+
+      def initialize(cmd, args, opts)
+        if not cmd.respond_to?(:run_command)
+          c = Interpreter.command(cmd)
+          if ! c
+            raise "Invalid command #{cmd}"
+          end
+          cmd = c
+        end
+        @command = cmd
+        @arguments = args
+        @options = opts
+      end
+
+      # Runs this instruction again
+      def run(plotmaker_target)
+        @command.run_command(plotmaker_target, @arguments, @options)
+      end
+
+      def to_s
+        "#{@command.name} #{@arguments.inspect} #{@options.inspect}"
+      end
+    end
+  end
+end
+

data/lib/ctioga2/commands/interpreter.rb

@@ -13,6 +13,7 @@
 
 require 'ctioga2/utils'
 require 'ctioga2/commands/commands'
+require 'ctioga2/commands/instruction'
 require 'ctioga2/commands/context'
 require 'ctioga2/commands/variables'
 require 'ctioga2/commands/strings'
@@ -65,8 +66,6 @@ module CTioga2
       # All types defined so fat
       @@types = {}
 
-
-
       # Registers a given command. This is called automatically from
       # Command.new, so you should not have to do it yourself.
       def self.register_command(command)
@@ -166,6 +165,9 @@ module CTioga2
       # The current context
       attr_accessor :context
 
+      # The list of Instruction that were run so far
+      attr_accessor :instructions
+
       # Creates an Interpreter with _target_ as the PlotMaker target
       # object.
       #
@@ -192,7 +194,15 @@ module CTioga2
 
         @file_parser = Parsers::FileParser.new
         @context = ParsingContext.new
+        @instructions = []
+      end
+
+      # Adds the given instruction to the list of Instruction that
+      # were run so far.
+      def add_instruction(instruction)
+        @instructions << instruction
       end
+                        
 
       # Calls the given function and returns the result
       def call_function(name, args)

data/lib/ctioga2/data/datacolumn.rb

@@ -291,6 +291,44 @@ module CTioga2
         end
       end
 
+      # Bins the values of the columns into nb bins between min and
+      # max. Values outside that range are not taken into account. If
+      # @a normalize is true, then each value is normalized by the
+      # total number of samples.
+      #
+      # It returns [xv, yv], where xv are the centers of the bins, and
+      # yv the counts
+      #
+      # Does not take into account the error columns.
+      def bin(min, max, nb, normalize = false)
+        total = @values.size*1.0
+        xv = Dobjects::Dvector.new(nb)
+        yv = Dobjects::Dvector.new(nb)
+
+        0.upto(nb-1) do |i|
+          xv[i] = min + (max-min)*(i+0.5)/nb
+          yv[i] = 0
+        end
+        
+        for v in @values
+          idx = (v-min)/(max-min)
+          if idx > 1.0 or idx < 0
+            next
+          end
+          idx = (idx*nb).to_i
+          if idx == nb
+            idx = nb-1          # case v = max
+          end
+          yv[idx] += 1
+        end
+
+        if normalize
+          yv *= (1.0/total)
+        end
+
+        return [xv, yv]
+      end
+
       # Averages over the given indices, and puts the result at the
       # target index.
       #