gphys 1.1.1 → 1.2.2

data/lib/numru/gphys/interpolate.rb

@@ -1,5 +1,6 @@
 require "numru/gphys/gphys"
-require "numru/dcl"         # math1/gt2dlib is used for pure-2D interpolation
+require "numru/dcl"         # math1/gt2dlib is used for pure-2D interpolation.
+                            # Also for dcl_fig_cut
 require "numru/dcl_mouse"   # for mouse_cut, mouse_cut_repeat
 require "narray_miss"                      
 
@@ -13,9 +14,21 @@ module NumRu
 
     @@interpo_previous_cutter = nil
     @@interpo_previous_modifier = nil
-    @@interpo_missval = -1e30
+    @@interpo_missval = 9.9692099683868690e+36 # NC_FILL_DOUBLE/FLOAT ~15*2^119
+    @@interpo_extrapolation = false
 
-    # = Makes a subset interactively by specifying a (poly-)line on the DCL viewport
+    # Change the behavior of the interpolation methods to extrapolate 
+    # outside the grid coverage.
+    #
+    # ARGUMENTS
+    # * extrapo : true or false --- the default behaviour is false
+    #   (not to extrapolate), so use this method if you
+    #   want to set it to true.
+    def self.extrapolation=(extrapo)
+      @@interpo_extrapolation = extrapo
+    end
+
+    # Makes a subset interactively by specifying a (poly-)line on the DCL viewport
     # 
     # ARGUMENTS
     # * dimx {String] : name of number (0,1,..) of the dimension
@@ -28,7 +41,7 @@ module NumRu
     # 
     # RETURN VALUE
     # * a GPhys
-    def mouse_cut(dimx, dimy, num=2)
+    def mouse_cut(dimx, dimy, num=2, line_type=1, line_index=1)
 
       # < preparation >
 
@@ -46,12 +59,40 @@ module NumRu
           break
         end
       end
-      line.draw
+      line.draw(line_type, line_index)
       vx = line.vx
       vy = line.vy
       ux = line.ux
       uy = line.uy
+      gpnew = dcl_fig_cut(dimx,dimy,ux,uy)
+      [gpnew, line]
+    end
+
+    # Interpolation on the DCL window (automatic iso-interval interpolation
+    # along a poly line that can be drawn in the current viewport of the
+    # DCL window). Used in mouse_cut.
+    # 
+    # ARGUMENTS
+    # * dimx [Integer or String] : specifies the dimension corresponding 
+    #   to the UX coordinate.
+    #   (Here, the UX coordinate is the X coordinate of the DCL's USER
+    #   coordinate. For exapmle, longitude if map projection.)
+    # * dimy [Integer or String] : specifies the dimension corresponding 
+    #   to the UY coordinate.
+    #   (Here, the UY coordinate is the Y coordinate of the DCL's USER
+    #   coordinate. For exapmle, latitude if map projection.)
+    # * ux [Array] : x values in terms of the UX coordinate
+    # * uy [Array] : y values in terms of the UY coordinate
+    #   Lengths of ux and uy must be the same and greter or equal to 2.
+    # 
+    def dcl_fig_cut(dimx,dimy,ux,uy)
       len = ux.length
+      raise("ux and uy must be arrays with the (same) length >= 2") if len<=1
+      raise("ux's len (#{len}) != uy's len (#{uy.length})") if uy.length != len
+      vx=Array.new; vy=Array.new
+      for i in 0...len
+        vx[i],vy[i] = NumRu::DCL.stftrf(ux[i],uy[i]) 
+      end
       kx = Array.new
       ky = Array.new
       cut = [true]*rank
@@ -66,13 +107,18 @@ module NumRu
       ndsum = [0]
       for i in 0...len-1
         ndiv[i] = Math.sqrt( (kx[i+1]-kx[i])**2 + (ky[i+1]-ky[i])**2).to_i
+        ndiv[i] += 1 if i==len-2
         ndsum.push ndsum[-1] + ndiv[i]   # 0, ndiv[0], ndiv[0]+ndiv[1], ...
       end
       ndtot = ndsum[-1]
       vxdiv = NArray.float(ndtot)
       vydiv = NArray.float(ndtot)
       for i in 0...len-1
-        a = NArray.float(ndiv[i]).indgen / ndiv[i]
+        if i!=len-2
+          a = NArray.float(ndiv[i]).indgen / ndiv[i]
+        else
+          a = NArray.float(ndiv[i]).indgen / (ndiv[i]-1)
+        end
         vxdiv[ndsum[i]...ndsum[i+1]] = (1.0-a)*vx[i] + a*vx[i+1]
         vydiv[ndsum[i]...ndsum[i+1]] = (1.0-a)*vy[i] + a*vy[i+1]
       end
@@ -115,10 +161,10 @@ module NumRu
 
       gpnew = interpolate(cutter)
       gpnew = modifier[gpnew] if modifier
-      [gpnew, line]
+      gpnew
     end
 
-    # = Interpolation onto grid points specified by the previous call of GPhys#mouse_cut
+    # Interpolation onto grid points specified by the previous call of GPhys#mouse_cut
     def mouse_cut_repeat
       if @@interpo_previous_cutter.nil?
         raise("You must first use GPhys#mouse_cut. This method repeats it") 
@@ -150,7 +196,7 @@ module NumRu
     end
     private :__sp_dist
 
-    # = Interpolate to conform the grid to a target GPhys object
+    # Interpolate to conform the grid to a target GPhys object
     #
     # ARGUMENTS
     # * to [GPhys] : the target gphys
@@ -163,7 +209,36 @@ module NumRu
       interpolate(*coords)
     end
 
-    # = Wide-purpose multi-dimensional linear interpolation
+    # Reverse the main data (i.e., the dependent variable) and one of the
+    # coordinates (an independent variable) through interpolation.
+    # 
+    # Returns a GPhys in which the main data is the specfied coordinate
+    # (argument: axname) sampled at specified locations (argument: pos)
+    # in terms of the main data of self. The main data of self is expected
+    # to be quai-monotonic with respect to the specfied coordinate.
+    # 
+    # ARGUMENTS
+    # * axname [String] : one of the names of the axes (i.e. main 
+    #   coordinates. Auxiliary coordinates are not supported as the target.)
+    # * pos [NArray] : grid locations. For example, if the current data is
+    #   potential temperature theta, pos consists of the theta levels to
+    #   make sampling.
+    #
+    # RETURN VALUE
+    # * a GPhys
+    #   
+    def coord_data_reverse(axname,pos)
+      gp = self.axis(axname).to_gphys
+      gp = self.shape_coerce_full(gp)[0]   # conform the shape to that of self
+      gp = GPhys.new( gp.grid.copy, gp.data )  # copy grid to avoid side effect
+                                               # on the grid of self
+      gp.set_assoc_coords([self])
+      pos = NArray[*pos].to_type(NArray::FLOAT) if pos.is_a?(Array)
+      newcrd = VArray.new(pos,self.data,self.name)  # succeeds the attributes
+      gp.interpolate(axname=>newcrd)
+    end
+
+    # Wide-purpose multi-dimensional linear interpolation
     # 
     # This method supports interpolation regarding combinations of 
     # 1D and 2D coordinate variables. For instance, suppose self is
@@ -320,16 +395,25 @@ module NumRu
         missval = ( (a=get_att('_FillValue')) ? a[0] : nil ) || 
                   ( (a=get_att('missing_value')) ? a[0] : nil ) || 
                   @@interpo_missval
-        z = z.to_na(missval) 
+        z = z.to_na(missval)
+        input_nomiss = false
       else
-        missval = nil
+        input_nomiss = true
+        if @@interpo_extrapolation
+          missval = nil
+        else
+          missval = @@interpo_missval
+        end
       end
 
-      na = c_interpo_do(newgrid.shape, idxmap, z, missval)   # [C-extension]
+      na = c_interpo_do(newgrid.shape, idxmap, z, missval,
+                        @@interpo_extrapolation)   # [C-extension]
 
-      if missval
+      if !input_nomiss || !@@interpo_extrapolation
         mask = na.ne(missval)
-        na = NArrayMiss.to_nam_no_dup(na,mask)
+        if !input_nomiss || mask.min == 0
+          na = NArrayMiss.to_nam_no_dup(na,mask)
+        end
       end
 
       va = VArray.new(na, data, name)
@@ -353,7 +437,8 @@ module NumRu
           elsif cd.is_a?(Numeric) && mp[1].is_a?(NArray)
             xto = mp[1]     # 1-D new coordinate var
             xfrom = mp[2]   # 1-D original coordinate var
-            ids, f = c_interpo_find_loc_1D(xto,xfrom)   # [C-extension]
+            ids, f = c_interpo_find_loc_1D(xto,xfrom,@@interpo_missval,
+                                     @@interpo_extrapolation)   # [C-extension]
             idxmap.push( [ m[0], cd, nil, ids, f ] )  # mapping from 1D
           else
             # partially 2D case
@@ -367,7 +452,8 @@ module NumRu
                 break
               end
             end
-            ids, f = c_interpo_find_loc_1D_MD(xto,xfrom,dimc)   # [C-extension]
+            ids, f = c_interpo_find_loc_1D_MD(xto,xfrom,dimc,@@interpo_missval,
+                                     @@interpo_extrapolation)   # [C-extension]
 
             dims_covd = mp[1] #dimensions covered by the coordinate variable(orig)
             idxmap.push( [ od, cd, dims_covd, ids, f ] )  # mapping from 2D
@@ -462,10 +548,14 @@ module NumRu
           for j in 0...coords[ic].length
             xto = coords[ic][j].val
             xfrom = org_coords[ic][j].val
-            xto = xto.to_na if !xto.is_a?(NArray)
-                  # missing in the coordinate, if any, is ignored
-            xfrom = xfrom.to_na if !xfrom.is_a?(NArray)
+            xto = xto.to_na if !xto.is_a?(NArray)  
                   # missing in the coordinate, if any, is ignored
+            if xfrom.is_a?(NArrayMiss)
+              xfrom = xfrom.to_type(NArray::FLOAT).to_na(@@interpo_missval)
+              # if xfrom is NArrayMiss, this fixed missing value is set.
+              # The conversion into double is just in case (not needed for
+              # the default @@interpo_missval).
+            end
             if org_dims[ic][j].length == 1
               crdmap1D.push( [ org_dims[ic][j][0], ic, xto, 
                                xfrom] )
@@ -731,14 +821,15 @@ if $0 == __FILE__
 
   gd.set_assoc_coords([gp,gq,gr,ga])
 
-  print "GPhys with associated coordinates:\n"
-  p gd
+  #print "GPhys with associated coordinates:\n"
+  #p gd
 
 
   DCL.swpset('iwidth',700)
   DCL.swpset('iheight',700)
   #DCL.sgscmn(4)  # set colomap
   DCL.gropn(1)
+  DCL.sgpset('isub', 96)      # control character of subscription: '_' --> '`'
   DCL.glpset("lmiss",true)
   DCL.sldiv("y",2,2)
   GGraph::set_fig "viewport"=>[0.15,0.85,0.15,0.85]
@@ -746,12 +837,13 @@ if $0 == __FILE__
   GGraph::color_bar
   GGraph::tone gd[true,ny/2,true]
   GGraph::color_bar
+  gdd = gd.copy
 
   #< prepare coordinates to interpolate >
 
   xi = NArray[1.0, 2.0, 3.0, 4.0, 5.0]
 #  yi = NArray[1.0, 4.0, 5.0]
-  yi = NArray[-0.1, 2.5, 4.0, 5.5, 6.8]  # test of extrapolation
+  yi = NArray[-0.1,2.5, 4.0, 5.5, 6.8]  # test of extrapolation
   vxi = VArray.new( xi, {"units"=>"m"}, "x")  # "0.5m" to test unit conversion
   vyi = VArray.new( yi, {"units"=>"m"}, "y")  # "0.5m" to test unit conversion
 
@@ -764,7 +856,7 @@ if $0 == __FILE__
   vpi = VArray.new( pi, {"units"=>"mm"}, "p")
   vqi = VArray.new( qi, {"units"=>"mm"}, "q")
 
-  ai = NArray[2.0, 4.0]
+  ai = NArray[2.0, 2.5]
   vai = VArray.new( ai ).rename("a")
 
   #< test of interpolate >
@@ -774,6 +866,7 @@ if $0 == __FILE__
   gp = GPhys.new(xygrid,vp)
   gq = GPhys.new(xygrid,vq)
 
+  #GPhys::extrapolation = true
   gi = gd.interpolate(vxi,vyi,{"z"=>0.5})
   GGraph::tone gi,true,"color_bar"=>true
 
@@ -781,9 +874,9 @@ if $0 == __FILE__
 
   gi = gd.interpolate([vxi,vyi])
   #p gi.max, gi.min
-  GGraph::tone gd,true,"min"=>-1.2,"max"=>1.2,"int"=>0.1
+  GGraph::tone gd[false,0],true,"min"=>-1.2,"max"=>1.2,"int"=>0.1
   GGraph::scatter gxi, gyi, false,"type"=>4,"size"=>0.027,"index"=>3
-  GGraph::color_scatter gxi, gyi, gi, false,"min"=>-1.2,"max"=>1.2,"int"=>0.1,"type"=>10,"size"=>0.029
+  GGraph::color_scatter gxi, gyi, gi[true,0], false,"min"=>-1.2,"max"=>1.2,"int"=>0.1,"type"=>10,"size"=>0.029
   GGraph::color_bar
 
   gi = gd.interpolate(vyi,vxi)
@@ -833,21 +926,52 @@ if $0 == __FILE__
   GGraph::tone gi,true,"color_bar"=>true
 
   ###gd.interpolate(vpi)   # must fail by insufficient specification
-=begin
-=end
 
 
   mask=d.lt(0.7)
   missv = -999.0
   d[mask.not] = missv
-  p d[false,0]
+  #p d[false,0]
   dm = NArrayMiss.to_nam(d, mask )
   vdm = VArray.new( dm, {"missing_value"=>NArray[missv]}, "d")
   gdm = GPhys.new(xyzgrid, vdm)
   gi = gdm.interpolate(vpi,vqi)
 #  gi = gdm.interpolate(vxi,vyi)
   GGraph::tone gi,true,"color_bar"=>true
+  
+  print "start the test of coord_data_reverse\n"
+  GGraph::tone gp
+  GGraph::color_bar
+  xp = gp.coord_data_reverse("x",NArray.sfloat(30).indgen! )
+  GGraph::tone xp,true,"title"=>"#{xp.name} <-coord_data_reverse"
+  GGraph::color_bar
+
+  #< test of mouse_cut / dcl_fig_cut >
+  gdc = gdd[1..-1,1..-1,true]
+
+=begin
+  GGraph.set_fig "itr"=>4
+  GGraph.tone gdc,true,"int"=>0.15,"min"=>-1.05,"max"=>1.05
+  gpcut, line = gdc.mouse_cut(0,1,3)
+  x = gpcut.coord("x")
+  y = gpcut.coord("y")
+  DCL.sgpmzu(x.val,y.val,2,1,0.015)
+  GGraph.set_fig "itr"=>1
+  GGraph.tone gpcut,true,"int"=>0.15,"min"=>-1.05,"max"=>1.05
+  GGraph.color_bar
+=end
 
+  GGraph.set_fig "itr"=>4
+  GGraph.tone gdc,true,"int"=>0.15,"min"=>-1.05,"max"=>1.05
+  gpcut = gdc.dcl_fig_cut(0,1,[1.0,3.0,6.0],[1.1,2.2,5.5])
+  x = gpcut.coord("x")
+  y = gpcut.coord("y")
+  DCL.sgplu(x.val,y.val)
+  DCL.sgpmzu(x.val,y.val,2,1,0.015)
+  GGraph.set_fig "itr"=>1
+  GGraph.tone gpcut,true,"int"=>0.15,"min"=>-1.05,"max"=>1.05
+  GGraph.color_bar
+  
 
   #< finish >
   DCL.grcls

data/lib/numru/gphys/unumeric.rb

@@ -187,8 +187,8 @@ module NumRu
       new(val, uni)
     end
 
-    @@supported_calendars = [nil,"gregorian", "standard","noleap","365_day",
-                            "360_day"]
+    @@supported_calendars = [nil,"gregorian", "standard", "proleptic_gregorian", 
+                            "noleap", "365_day", "360_day"]
 
     def self::supported_calendar?(cal)
       @@supported_calendars.include?(cal)
@@ -216,6 +216,9 @@ module NumRu
         case calendar
         when nil, "gregorian", "standard"
           time = Units['days'].convert( date-since, tun )
+        when "proleptic_gregorian"
+          since = DateTime.parse(UNumeric::before_date_parse($2),false,Date::GREGORIAN)
+          time = Units['days'].convert( date-since, tun )
         when "noleap", "365_day"
           since_yday = since - DateTime.new(since.year,1,1) # day number of year (0..364)
           since_yday = since_yday - 1 if( since.leap? && since.mon > 2 )
@@ -224,14 +227,24 @@ module NumRu
             if date_yday >= 60.0 # after Mar1
               date_yday = date_yday - 1
             elsif date_yday >= 59.0 # Feb29
-              raise "Feb.29 is specified, but calendar is #{calendar}."
+              raise("Feb.29 is specified, but calendar is #{calendar}.")
             end
           end
           days = (date.year - since.year)*365 + (date_yday - since_yday)
           time = Units['days'].convert( days, tun )
         when "360_day" # does not work perfectly
-          days = (date.year - since.year)*360 + (date.mon - since.mon)*30 + (date.day - since.day)
-          time = Units['days'].convert( days, tun )
+          if date.day == 31
+            raise("day=31 is specified, but calendar is #{calendar}.")
+          end
+          if date.is_a?(DateTime)
+            date_hour,date_min,date_sec = date.hour,date.min,date.sec
+          else
+            date_hour,date_min,date_sec = 0,0,0
+          end
+          days = (date.year-since.year)*360 + (date.mon-since.mon)*30 + 
+                 (date.day-since.day) + Rational(date_hour-since.hour,24) + 
+                 Rational(date_min-since.min,1440) + Rational(date_sec-since.sec,86400)
+          time = Units['days'].convert( days.to_f, tun )
         else
           #raise("Unrecognized calendar: #{calendar}")
           return nil
@@ -313,6 +326,11 @@ module NumRu
       elsif( tun =~ Units['days since 0001-01-01'] )
         case calendar
         when nil, "gregorian", "standard"
+          # default: Julian calendar before 1582-10-15, Gregorian calendar afterward
+          datetime = since + tun.convert( time, Units['days'] )
+        when "proleptic_gregorian"
+          # Gregorian calendar extended to the past
+          since = DateTime.parse(UNumeric::before_date_parse(sincestr),false,Date::GREGORIAN)
           datetime = since + tun.convert( time, Units['days'] )
         when "noleap", "365_day"
           since_yday = since - DateTime.new(since.year,1,1) # day number of year (0..364)
@@ -327,7 +345,12 @@ module NumRu
           days = (since.mon-1)*30 + since_day + tun.convert( time, Units['days'] )
           year = since.year + (days/360).to_i
           mon = ((days%360)/30).to_i + 1
-          datetime = DateTime.new(year,mon,1) + days%30
+          datetime = DateTime.new(year,mon,1) + days%30 # Feb29->Mar1,Feb30->Mar2
+          #datetime = DateTime.new(year,mon,days%30 + 1) # stops if Feb29,Feb30
+          if datetime.mon != mon # Feb29,Feb30
+            $stderr.print("cannot convert #{year}-#{mon}-#{(days%30+1).to_i} to DateTime instance\n")
+            return nil
+          end
         else
           #raise("Unrecognized calendar: #{calendar}")
           return nil

data/lib/numru/gphys/varray.rb

@@ -987,6 +987,15 @@ These methods returns a NArray (not a VArray).
 
       alias shape_current shape
 
+      ## < marshal dump/load >
+      def marshal_dump
+        [@name, @mapping, @varray, @ary, @attr]
+      end
+       
+      def marshal_load(ary)
+        @name, @mapping, @varray, @ary, @attr = *ary
+      end
+
       ## < private methods >
       private
       def __rubber_expansion( args )

data/lib/numru/gphys/varraygrib.rb

@@ -4,6 +4,14 @@
 =end
 
 require "numru/gphys/grib"
+
+### to be made below in the definition of VArrayGrib in order to record
+### whetehr its successfull or not
+#begin
+#  require "numru/grib"
+#rescue LoadError
+#end
+
 require "numru/gphys/varray"
 
 module NumRu
@@ -16,8 +24,50 @@ module NumRu
 =end
   class VArrayGrib < VArray
 
+    begin
+      require "numru/grib"
+      @@rbgribloaded = true
+    rescue LoadError
+      @@rbgribloaded = false
+    end
+
+    @@GribLib = :gphys_grib
+
+    class << self
+      def use_gphys_grib
+        @@GribLib = :gphys_grib
+        set_grib_lib
+      end
+      def use_rb_grib
+        if !@@rbgribloaded
+          raise LoadError, "Loading rb-GRIB has been failed. You probably need to install it."
+        end
+        @@GribLib = :rb_grib
+        set_grib_lib
+      end
+      def grib_lib
+        @@GribLib.dup
+      end
+      def grib
+        @@Grib
+      end
+      def set_grib_lib
+        case @@GribLib
+        when :gphys_grib
+          @@GribDim = GPhys::GribDim
+          @@GribVar = GPhys::GribVar
+          @@Grib = GPhys::Grib
+        when :rb_grib
+          @@GribDim = GribDim
+          @@GribVar = GribVar
+          @@Grib = Grib
+        end
+      end
+    end
+    set_grib_lib
+
     def initialize(aGribVar)
-      if !GribVar===aGribVar && !GribDim===aGribVar
+      if !@@GribVar===aGribVar && !@@GribDim===aGribVar
         raise ArgumentError,"Not a GribVar or GribDim"
       end
       @name = aGribVar.name
@@ -26,9 +76,11 @@ module NumRu
       @ary = aGribVar
       @attr = Attribute.new
       aGribVar.att_names.each{|name|
-        @attr[name] = aGribVar.att(name)
+        val = aGribVar.att(name)
+        val = [val] if val.is_a?(Numeric)
+        @attr[name] = val
       }
-      if GribDim===@ary
+      if @@GribDim===@ary
         class << @ary
           def rank
             return 1
@@ -41,9 +93,9 @@ module NumRu
     end
 
     def inspect
-      if GribVar===@ary
+      if @@GribVar===@ary
         "<'#{@name}' in '#{@ary.file.path}'  [#{@ary.shape.join(", ")}]>"
-      elsif GribDim===@ary
+      elsif @@GribDim===@ary
         "<'#{@name}' in '#{@ary.var.name}'  #{@ary.length}>"
       end
     end
@@ -55,7 +107,7 @@ module NumRu
         v = file.def_var(name)
         dims.length.times{|n|
           d = dims[n]
-          if GribDim===d
+          if @@GribDim===d
             gd = v.def_dim(d.name,n)
             gd.put(d.get)
             d.att_names.each{|name| gd.put_att(name,d.att(name)) }
@@ -80,7 +132,7 @@ module NumRu
       ## < additional class methods > ##
 
       def write(file,vary,dims=nil)
-        Grib===file || raise(ArgumentError,"1st arg: not a Grib")
+        @@Grib===file || raise(ArgumentError,"1st arg: not a Grib")
         VArray===vary || raise(ArgumentError,"2st arg: not a VArray")
         rank = vary.rank
         if !dims
@@ -157,7 +209,7 @@ if $0 == __FILE__
 
   include NumRu
 
-  grib = Grib.open("../../../testdata/T.jan.grib")
+  grib = VArrayGrib.grib.open("../../../testdata/T.jan.grib")
   gv = grib.var("TMP")
 
   va = VArrayGrib.new(gv)
@@ -174,4 +226,14 @@ if $0 == __FILE__
   p va2.shape
   p va2.val
 
+  begin
+    VArrayGrib.use_rb_grib
+    grib = VArrayGrib.grib.open("../../../testdata/T.jan.grib")
+    p grib.var_names
+    gv = grib.var("t")
+    p gv.val
+  rescue LoadError
+    print "...error rescued & test skipped\n\n"
+  end
+
 end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class GPhys
+  VERSION = "1.2.2"
+end