Class: CurveFit

Inherits:
Object
  • Object
show all
Defined in:
lib/curve_fit.rb

Overview

A wrapper around cfityk (fityk.nieto.pl/) to handle fitting a curve to X+Y data, creating confidence intervals, and projecting up to a ceiling.

Also supports basic manipulation of X+Y data files.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(debug = false) ⇒ CurveFit

Returns a new instance of CurveFit.



25
26
27
 
# File 'lib/curve_fit.rb', line 25

def initialize(debug=false)
  @debug = debug
end

Instance Attribute Details

#debug ⇒ Object

Returns the value of attribute debug.



23
24
25
 
# File 'lib/curve_fit.rb', line 23

def debug
  @debug
end

Instance Method Details

#append_xy_file(filename, x, y) ⇒ True

Adds an entry to an x+y style data file.

Parameters:

  • filename (String) —

    The filename to append to

  • x (String) —

    The X value

  • y (String) —

    The Y value

Returns:

  • (True) 


73
74
75
76
77
78
 
# File 'lib/curve_fit.rb', line 73

def append_xy_file(filename, x, y)
  File.open(filename, 'a') do |xy_file|
    xy_file.puts "#{x} #{y}" 
  end
  true
end

#fit(data, ceiling = nil, guess_list = ["Linear", "Quadratic"], &x_transform) ⇒ Hash

Given an aray of X,Y data points, guesses the most correct curve (as measured by R-Squared) and generates a trend line, top and bottom confidence intervals, and optionally projects the trend to an artifical ceiling.

Parameters:

  • data (Array) —

    An array of arrays [[X, Y]..] representing the data set you want to curve fit.

  • ceiling (Number, nil) (defaults to: nil) —

    The integer/float Y value to project the curve up to, the ‘ceiling’. Nil means no projection past last X value. Default is nil.

  • guess_list (Array) (defaults to: ["Linear", "Quadratic"]) —

    A list of acceptable guesses to use in cfityk. As many of the following as desired: Linear, Quadratic. Default is all of the above.

  • x_transform (Block) —

    A block that will be passed a value for X from the original data set as an integer (1,2,3, etc), and should return a value to replace it with that matches the original data set.

Returns:

  • (Hash) —

    A hash with the data, trend, top_confidence, and bottom_confidence as arrays of [X, Y], r_square and the guessed curve.

    :data => [ [ X, Y ], [ X, Y ] ... ],
:trend => [ [ X, Y ], [ X, Y ] ... ],
:top_confidence => [ [ X, Y ],  [X, Y] ...],
:bottom_confidence => [ [ X, Y ], [X, Y] ...],
:ceiling => [ [ X, Y ], [ X, Y ] ],
:r_squared => 99.9764,
:guess => "Quadratic"




140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/curve_fit.rb', line 140

def fit(data, ceiling=nil, guess_list=["Linear", "Quadratic"], &x_transform)
  data_file = Tempfile.new("curvefit") 
  x_pos = 0
  data.each do |point|
    data_file.puts("#{x_pos} #{point[1]}")
    x_pos += 1
  end
  data_file.close

  guess_data = Hash.new
 
  guess_list.each do |shape|
    guess_data[shape] = Hash.new
    puts "Guessing #{shape} fit..." if @debug
    IO.popen("cfityk -I -q -c '@0 < '#{data_file.path}'; guess #{shape}; fit; info+ formula in @0; info fit in @0; info errors in @0;'") do |fityk_output|
      fityk_output.each_line do |line|
        puts "#{shape}: #{line}" if @debug
        case line
        when /R-squared = (.+)/
          guess_data[shape][:r_squared] = $1.to_f
        when /(.+) \+ (.+) \* \(x\)/ # 692.1 + 30.633 * (x), linear fit formula
          first = $1.to_f
          second = $2.to_f
          guess_data[shape][:curve_formula] = lambda { |x| first + second * x.to_f }
        when /(.+) \+ (.+)\*\(x\) \+ (.+)\*\(x\)\^2/ # 1019.43 + 9.543*(x) + 0.202086*(x)^2, quadratic/polynomial fit formula
          first = $1.to_f
          second = $2.to_f
          third = $3.to_f
          guess_data[shape][:curve_forumla_args] = {
            1 => first,
            2 => second,
            3 => third
          }
          guess_data[shape][:curve_formula] = lambda { |x| first + second * x.to_f + third * x.to_f**2 }
        when /\$_(\d) = (\d+\.\d+) \+\- (\d+\.\d+)/ # $_1 = 692.1 +- 32.0558
          guess_data[shape][:curve_error_args] ||= Hash.new 
          guess_data[shape][:curve_error_args][$1.to_i] = [ $2.to_f, $3.to_f ]
        end
      end
    end

    if $?.exitstatus != 0
      raise "cfityk returned status #{$?.exitstatus} when guessing #{shape}, bailing"
    end
   
    if guess_data[shape][:r_squared] == 1
      guess_data[shape][:top_confidence_formula] = guess_data[shape][:curve_formula] 
      guess_data[shape][:bottom_confidence_formula] = guess_data[shape][:curve_formula]
    else
      case shape
      when "Quadratic"
        curve_error_args = guess_data[shape][:curve_error_args]
        guess_data[shape][:top_confidence_formula] = lambda { |x| (curve_error_args[1][0] + curve_error_args[1][1]) + (curve_error_args[2][0] + curve_error_args[2][1]) * x.to_f + (curve_error_args[3][0] + + curve_error_args[3][1]) * x.to_f**2 }
        guess_data[shape][:bottom_confidence_formula] = lambda { |x| (curve_error_args[1][0] - curve_error_args[1][1]) + (curve_error_args[2][0] - curve_error_args[2][1]) * x.to_f + (curve_error_args[3][0] + - curve_error_args[3][1]) * x.to_f**2 }
      when "Linear"
        curve_error_args = guess_data[shape][:curve_error_args]
        guess_data[shape][:top_confidence_formula] = lambda { |x| (curve_error_args[1][0] + curve_error_args[1][1]) + (curve_error_args[2][0] + curve_error_args[2][1]) * x.to_f } 
        guess_data[shape][:bottom_confidence_formula] = lambda { |x| (curve_error_args[1][0] - curve_error_args[1][1]) + (curve_error_args[2][0] - curve_error_args[2][1]) * x.to_f }
      end
    end
  end

  best_fit_name = nil
  best_fit = nil
  guess_data.each do |shape, shape_guess|
    best_fit_name ||= shape
    best_fit ||= shape_guess
    if shape_guess[:r_squared] > best_fit[:r_squared]
      best_fit = shape_guess 
      best_fit_name = shape
    end
  end

  trend_line = []
  top_confidence_line = []
  bottom_confidence_line = []
  ceiling_line = []

  x = 0 
  y = 0

  no_ceiling = ceiling.nil?

  while(no_ceiling ? x < data.length : ceiling >= y) 
    y = best_fit[:curve_formula].call(x)
    y_top_confidence = best_fit[:top_confidence_formula].call(x)
    y_bottom_confidence = best_fit[:bottom_confidence_formula].call(x)

    if x_transform
      trend_line << [ x_transform.call(x), y ]
      top_confidence_line << [ x_transform.call(x), y_top_confidence ]
      bottom_confidence_line << [ x_transform.call(x), y_bottom_confidence ]
      ceiling_line << [ x_transform.call(x), ceiling ] unless no_ceiling
    else
      trend_line << [ x, y ]
      top_confidence_line << [ x, y_top_confidence ]
      bottom_confidence_line << [ x, y_bottom_confidence ]
      ceiling_line << [ x, ceiling ] unless no_ceiling
    end

    x += 1
  end

  {
    :data => data,
    :trend => trend_line,
    :top_confidence => top_confidence_line,
    :bottom_confidence => bottom_confidence_line,
    :ceiling => ceiling_line,
    :r_squared => best_fit[:r_squared],
    :guess => best_fit_name 
  }
end

#load_xy_file(filename) ⇒ Array

Loads an x+y style data file as an array of arrays, suitable for passing to the fit method.

Parameters:

  • filename (String) —

    The filename to load.

Returns:

  • (Array) —

    data An X+Y array: 

    [ [ X, Y ], [ X, Y ] ]



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/curve_fit.rb', line 36

def load_xy_file(filename)
  xy_data = Array.new
  File.open(filename, "r") do |xy_file|
    xy_file.each_line do |line|
      x, y = line.split(' ')
      xy_data << [ string_to_number(x), string_to_number(y) ] 
    end
  end
  xy_data
end

#string_to_number(string) ⇒ Integer, ...

Takes a string of digits and converts it to an integer or a float, depending on whether it rocks the dot. Returns the raw string if nothing matches.

Parameters:

  • string (String)

Returns:

  • (Integer, Float, String) —

    transformed_string



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/curve_fit.rb', line 53

def string_to_number(string)
  case string
  when /^\d+$/
    string.to_i
  when /^\d+.\d$/
    string.to_f
  else 
    string
  end
end

#write_xy_file(filename = nil, data) ⇒ IO

Writes a data set out to an X+Y file

Parameters:

  • filename (String) (defaults to: nil) —

    If given, the filename to write. Otherwise, creates a tempfile.

  • data (Array) —

    An X+Y array: 

    [ [ X, Y ], [ X, Y ] ]

Returns:

  • (IO) —

    data_file Returns the closed file IO object.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/curve_fit.rb', line 88

def write_xy_file(filename=nil, data)
  data_file = nil
  if filename
    data_file = File.open(filename, "w")
  else
    data_file = Tempfile.new("curvefit") 
    filename = data_file.path
  end

  x_pos = 0
  data.each do |point|
    data_file.puts("#{x_pos} #{point[1]}")
    x_pos += 1
  end

  data_file.close
  
  data_file
end