agwx_grids 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e7a63b606ce4a0f651f292a6ece2615f818b86a
+  data.tar.gz: e59ec22dc5d2a84139f60d9f0759ea0a7bc582cf
+SHA512:
+  metadata.gz: 1fa6e4b7ac7fde9dc827e0b405c3d430a10a5fe3e3e3b42e853d0a4db3ad99cfe7f642bed77777b91498049a51077b2e1f95bc02fe4c8ffe4aa9f7bf634ca419
+  data.tar.gz: b570b8d0e52a6572b0801e1a6d877dab9a6001460184ecc04f46a21e104de5cf3715f4f61e01f1d17b860ac54307e74ac1c7c6eda1af5f9515379589292f95a5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agwx_grids.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 RickWayne
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# AgwxGrids
+
+This gem implements the simple three-dimensional grid datatype beloved at Soil Science since the Larry Murdoch days of 1997.
+
+Example of a grid file (also on Andi). This one defines a 7 x 8 cell grid, currently containing 245 layers starting at 121 and ending at 365. Note that the Z layers are not necessarily contiguous; there can be layers missing from the file (e.g. if layer 125 were missing, the first few lines here would be the same except the number of layers would be 244 instead of 245). The file format is happy with that, and implementations should be too (that's why each layer of grid values has an index). The stuff in square brackets are illustrative, they would not appear in actual files (there's no provision for embedded comments).
+
+Also note that the rows of the raster are stored in reverse order from what you'd see on a map! So the row beginning "8 10 7..." below
+corresponds to the SMALLEST latitude (43.330002)!
+
+(From Larry's original dox) The following is a typical top part of a Grid file. Note the space at the start of each line. This allows you to examine the Z index list with something like: egrep '^ [0-9]+$' grid_file_name
+
+  7 8 245                   [XNo  YNo  ZNo]
+  -93.000000 -87.000000     [XStart  XEnd]
+  42.330002 47.000000       [YStart  YEnd]
+  121 365 1                 [ZStart  ZEnd  ZInc]
+  -99.000000 0              [BadVal  #Decimal_Places]
+  121                       [ZIndex]
+  8 10 7 4 4 4 4            [Grid Values]
+  7 6 6 4 5 4 4
+  6 8 8 4 4 4 3
+  7 8 9 6 4 3 3
+  8 8 8 6 4 3 2
+  8 8 6 4 4 2 1
+  6 6 4 2 2 2 2
+  4 4 2 2 0 2 2
+  122
+  19 21 18 14 14 14 13
+
+Not much to say outside of the rdoc for the API of the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'agwx_grids'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agwx_grids
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+end
+
+desc "Run tests"
+task default: :test

data/agwx_grids.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agwx_grids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agwx_grids"
+  spec.version       = AgwxGrids::VERSION
+  spec.authors       = ["RickWayne"]
+  spec.email         = ["fewayne@wisc.edu"]
+  spec.description   = %q{UW Soils Ag Weather grid data format (X by Y by DOY) }
+  spec.summary       = %q{UW Soils Ag Weather grid data format (X by Y by DOY) }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/agwx_grids/grid.rb

@@ -0,0 +1,231 @@
+  #    The Grid ADT maniputates a very simple ASCII format called a Grid File. Grid files
+  #    are designed for data which is easily maintained as a 3D matrix. The following is 
+  #    a typical top part of a Grid file:
+  #  
+  #  7 8 245			[XNo  YNo  ZNo]
+  #   -93.000000 -87.000000	[XStart  XEnd]
+  #   42.330002 47.000000	[YStart  YEnd]
+  #   121 365 1			[ZStart  ZEnd  ZInc]
+  #   -99.000000 0		[BadVal  #Decimal_Places]
+  #   121			[ZIndex]
+  #   8 10 7 4 4 4 4		[Grid Values]		
+  #   7 6 6 4 5 4 4
+  #   6 8 8 4 4 4 3
+  #   7 8 9 6 4 3 3
+  #   8 8 8 6 4 3 2
+  #   8 8 6 4 4 2 1
+  #   6 6 4 2 2 2 2
+  #   4 4 2 2 0 2 2
+  #   122
+  #   19 21 18 14 14 14 13
+module AgwxGrids
+  class GridMetaData
+    attr_writer :zDim
+    attr_reader :xDim, :yDim, :zDim
+    attr_reader :xStart, :xEnd, :xIncr
+    attr_reader :yStart, :yEnd, :yIncr
+    attr_writer :zStart, :zEnd, :zIncr
+    attr_reader :zStart, :zEnd, :zIncr
+    attr_writer :badVal
+    attr_reader :badVal
+
+    def xDim=(newXDim)
+      @xDim = newXDim
+      calcXIncr
+    end
+    def xStart=(newXStart)
+      @xStart = newXStart
+      calcXIncr
+    end
+    def xEnd=(newXEnd)
+      @xEnd = newXEnd
+      calcXIncr
+    end
+
+    def calcXIncr
+      if @xStart != nil && @xEnd != nil && @xDim != nil then
+        @xIncr = (@xEnd - @xStart) / (@xDim - 1)
+      end
+    end
+
+    def yDim=(newYDim)
+      @yDim = newYDim
+      calcYIncr
+    end
+
+    def yStart=(newYStart)
+      @yStart = newYStart
+      calcYIncr
+    end
+
+    def yEnd=(newYEnd)
+      @yEnd = newYEnd
+      calcYIncr
+    end
+
+    def calcYIncr
+      if @yStart != nil && @yEnd != nil && @yDim != nil then
+        @yIncr = (@yEnd - @yStart) / @yDim
+      end
+    end
+
+    def to_s
+      x = "xDim="+@xDim.to_s+",xStart="+@xStart.to_s+",xEnd="+@xEnd.to_s+",xIncr="+xIncr.to_s
+      y = "yDim="+@yDim.to_s+",yStart="+@yStart.to_s+",yEnd="+@yEnd.to_s+",yIncr="+yIncr.to_s
+      z = "zDim="+@zDim.to_s+",zStart="+@zStart.to_s+",zEnd="+@zEnd.to_s+",zIncr="+zIncr.to_s
+      badVal = "badVal="+@badVal.to_s
+      x+"\n"+y+"\n"+z+"\n"+badVal
+    end
+
+    def initialize(gridFile)
+      readMeta(gridFile)
+    end
+
+    def readMeta(gridFile)
+      @xDim,@yDim,@zDim = gridFile.gets.scan(/\d+/).collect { |s| s.to_f }
+      @xStart,@xEnd = gridFile.gets.scan(/-*\d+.\d+/).collect {|s| s.to_f }
+      calcXIncr
+      @yStart,@yEnd = gridFile.gets.scan(/-*\d+.\d+/).collect {|s| s.to_f }
+      calcYIncr
+      @zStart,@zEnd,@zIncr = gridFile.gets.scan(/\d+/).collect {|s| s.to_i }
+      @badVal = gridFile.gets.scan(/-*\d+.\d+/).collect {|s| s.to_f }
+    end
+  end
+
+  class GridLayer
+    attr_writer :zIndex
+    attr_reader :zIndex
+    attr_reader :rows
+    def initialize(gridFile,metaData)
+      @zIndex = gridFile.gets.scan(/\d+/)[0].to_i
+      @rows = Array.new
+      for row in 0...metaData.yDim
+        @rows[row] = gridFile.gets.scan(/-*\d+.\d+/).collect {|s| s.to_f }
+      end
+    end
+    def to_s
+      row0 = @rows[0]
+      row0Length = row0.length
+      "zIndex: #{@zIndex} num rows: #{@rows.length} num cols: #{row0Length}\n row 0: #{@rows[0]}"
+    end
+    # return value for x-y posn (x and y in tuple space, not "real" space)
+    def get(x,y)
+      row = @rows[y]
+      if row == nil
+          nil
+      else
+        # puts "GLayer.get got a row: #{row.inspect} and the value is #{row[x]}"
+        row[x]
+      end
+    end
+    # compare two layers (based on zIndex)
+    def <=>(aLayer)
+      if @zIndex < aLayer.zIndex then
+          return -1
+      elsif @zIndex == aLayer.zIndex then
+          return 0
+      else
+          return 1
+      end
+    end
+  
+    def row(y)
+      @rows[y]
+    end
+  
+  end
+
+
+  class Grid
+    include Enumerable
+    HOURLY=0
+    DAILY=1
+    attr_reader :period, :xDim, :yDim, :mD
+
+    def initialize(path,period)
+      @layers = {}
+      File.open(path) do |gridFile|
+        @mD = GridMetaData.new(gridFile)
+        if @mD == nil
+          raise "nil metadata"
+        end
+        @xDim = @mD.xDim
+        @yDim = @mD.yDim
+        @mD.zStart.step(@mD.zEnd,@mD.zIncr) do |layer_index|
+          if (!(gridFile.eof) && (layer = GridLayer.new(gridFile,@mD)))
+            @layers[layer.zIndex] = layer
+          end
+        end
+      end
+    end
+  
+    def realToIndex(x,y,z) 
+      @myX = ((x-@mD.xStart)/@mD.xIncr).to_i
+      @myY = ((y-@mD.yStart)/@mD.yIncr).to_i
+      @myZ = z # ((z-@mD.zStart)/@mD.zIncr).to_i
+      # puts "realToIndex: x #{x}, xStart #{@mD.xStart}, xIncr #{@mD.xIncr} myX #{@myX}; y #{y}, myY #{@myY} z #{z}, myZ #{@myZ}"
+      [@myX,@myY,@myZ]
+    end
+  
+    def get(x,y,z)
+      # puts "get #{x},#{y},#{z}"
+      # puts "xStart=#{@mD.xStart}, yStart=#{@mD.yStart}, zStart=#{@mD.zStart}"
+      # note that this just truncates; it should round to center of cell!
+      realToIndex(x,y,z)
+      # puts "@myX=#{@myX}, @myY=#{@myY}, @myZ=#{@myZ}"
+      # puts "#{@layers[@myZ]}"
+      if @layers[@myZ] == nil
+          nil
+      else
+          val = @layers[@myZ].get(@myX,@myY)
+          val == mD.badVal ? nil : val
+      end
+    end
+
+    # Grids are stored from low to high latitude, so as you look at the text file, it's mirrored vertically.
+    # The first line in a given grid layer is the LOWEST latitude, the last is the highest.
+    def get_by_index(longitude_index,latitude_index,doy)
+      if @layers[doy]
+        val = @layers[doy].get(longitude_index,latitude_index)
+        val == mD.badVal ? nil : val
+      else
+        nil
+      end
+    end
+
+    def each_value(lat,long)
+      # note switch here -- grids do longitude as X
+      realToIndex(long,lat,0)
+      @layers.keys.sort.each do |doy|
+        layer = @layers[doy]
+        if layer == nil
+            yield nil
+        else
+          val = layer.get(@myX,@myY)
+          val = nil if val == mD.badVal
+          yield val
+        end
+      end 
+    end
+  
+    def each
+      @layers.each { |layer| yield layer }
+    end
+  
+    def layer_list
+      @layers.keys
+    end
+  
+    def layer(doy)
+      @layers[doy]
+    end
+    
+    def latitude_for(index)
+      mD.yStart + (index * mD.yIncr)
+    end
+  
+    def longitude_for(index)
+      mD.xStart + (index * mD.xIncr)
+    end
+  end
+end

data/lib/agwx_grids/version.rb

@@ -0,0 +1,3 @@
+module AgwxGrids
+  VERSION = "0.0.1"
+end

data/lib/agwx_grids.rb

@@ -0,0 +1,6 @@
+require "agwx_grids/version"
+require 'agwx_grids/grid'
+
+module AgwxGrids
+  # Your code goes here...
+end

data/test/grid_test.rb

@@ -0,0 +1,60 @@
+require "test/unit"
+require "agwx_grids"
+
+include AgwxGrids
+
+DOY = 7
+ROW = 1
+COL = 5
+VAL = -14.35 # The value for get_by_index(col,row,doy)
+
+class TestAgwxGrid  < Test::Unit::TestCase
+  def setup
+    @test_data_path = File.join(File.dirname(__FILE__),'grids')
+    @grid = Grid.new(File.join(@test_data_path,"WIMNTMin2002"),Grid::DAILY)
+  end
+
+  def test_can_load
+    assert(@grid)
+  end
+  
+  def test_each_value
+    ii=0
+    @grid.each_value(44.0,-89.0) {|val| assert_equal(Float, val.class); ii+=1}
+    assert_equal(364, ii)
+  end
+  
+  def test_get_by_index
+    assert_equal(VAL, @grid.get_by_index(COL,ROW,DOY))
+  end
+  
+  def test_layer
+    assert_equal(GridLayer, @grid.layer(DOY).class)
+  end
+  
+  def test_row
+    assert_equal(Array, @grid.layer(DOY).row(1).class)
+    assert_equal(VAL, @grid.layer(DOY).row(1)[5])
+  end
+  
+  def test_y_latitude
+    lat_start = @grid.mD.yStart
+    lat_incr = @grid.mD.yIncr
+    assert_in_delta(lat_start + 3 * lat_incr, @grid.latitude_for(3), 2 ** -20)
+  end
+  
+  def test_x_longitude
+    long_start = @grid.mD.xStart
+    long_incr = @grid.mD.xIncr
+    assert_in_delta(long_start + 3 * long_incr, @grid.longitude_for(3), 2 ** -20)
+  end
+end
+# begin # test the Grid class
+#    puts "====== initializing a grid =========="
+#    grid = Grid.new("grids/WIMNTMin2002",Grid::DAILY)
+#    # puts "====== dumping each_value =========="
+#    # grid.each_value(44.0,-89.0)  {|vapr| puts vapr}
+#    for y_index in (0..grid.yDim)
+#      puts grid.get_by_index(0,y_index,22)
+#    end
+# end