gentooboontoo-gphys 0.6.1.3

data/lib/numru/ggraph_on_merdional_section.rb

@@ -0,0 +1,178 @@
+require 'numru/ggraph'
+require 'numru/gphys/ep_flux'
+
+############################################################
+
+=begin
+=module NumRu::GGraph in vector_on_merdional_section.rb
+
+This file defines additional method of NumRu::GGraph. This method is for 
+drawing vector on merdional sections.
+
+==Index
+* ((<module NumRu::GGraph>))
+  * ((<vector_on_merdional_section>))
+    Draw vector by selecting the first 2 dimensions 
+    (with GPhys#first2D) if (({gphys})) is more than 3D.
+
+==Module Functions
+
+---vector_on_merdional_section(fx, fy, newframe=true, options=nil)
+    Draw vector by selecting the first 2 dimensions 
+    (with GPhys#first2D) if (({gphys})) is more than 3D.
+
+    ARGUMENTS
+    * fx (GPhys) : a GPhys whose data is plotted x-componet.
+    * fy (GPhys) : a GPhys whose data is plotted y-componet.
+    * newframe (true/false) : if true, calls ((<fig>)), ((<axes>)),
+      ((<title>)), and ((<annotate>)) internally; if false, only
+      the poly-line is drawn (overlaid to the exiting figure).
+    * options (Hash) : options to change the default behavior if specified.
+      It is a Hash with option names (String) as keys and their values.
+      Options are interpreted by a NumRu::Misc::KeywordOptAutoHelp,
+      so you can shorten the keys (by omitting tails) as long as it is 
+      unambiguous.
+       option name     default value # description:
+       "title"         nil           # Title of the figure(if nil, internally 
+                                     # determined)
+       "annotate"      true          # if false, do not put texts on the right
+                                     # margin even when newframe==true
+       "transpose"     false         # if true, exchange x and y axes
+       "flow_vect"     true          # If true, use DCLExt::flow_vect to draw
+                                     # vectors; otherwise, DCL::ugvect is used
+       "xintv"         1             # (Effective only if flow_vect) interval
+                                     # sampling in x of data 
+       "yintv"         1             # (Effective only if flow_vect) interval
+                                     # of data sampling in y 
+       "factor"        1.0           # (Effective only if flow_vect) scaling 
+                                     # factor to strech/reduce the arrow 
+                                     # lengths.
+       "use_before_scale"            #
+                       false         #(Effective only unless flow_vect) If true, 
+                                     # use scale factor before vector.
+       "unit_vect"     false         # Show the unit vector
+       "max_unit_vect" false         # (Effective only if flow_vect && 
+                                     # unit_vect) If true, use the maximum 
+                                     # arrows to scale the unit vector; 
+                                     # otherwise, normalize in V coordinate.
+
+    RETURN VALUE
+    * nil
+
+=end
+
+############################################################
+
+module NumRu
+
+  module GGraph
+
+    module_function
+
+    def vector_on_merdional_section(fx, fy, newframe=true, options=nil)  
+      if ! defined?(@@vector_on_merdional_section_options)
+        @@vector_on_merdional_section_options = Misc::KeywordOptAutoHelp.new(
+          ['newfig', true, 'if false, do not cleared before figure setting.'],
+          ['title', nil, 'Title of the figure(if nil, internally determined)'],
+          ['annotate', true, 'if false, do not put texts on the right margin even when newframe==true'],
+          ['transpose', false, 'if true, exchange x and y axes'],
+          ['flow_vect', true, 'If true, use DCLExt::flow_vect to draw vectors; otherwise, DCL::ugvect is used.'],
+          ['xintv', 1, '(Effective only if flow_vect) interval of data sampling in x'],
+          ['yintv', 1, '(Effective only if flow_vect) interval of data sampling in y'],
+          ['factor', 1.0, '(Effective only if flow_vect) scaling factor to strech/reduce the arrow lengths'],
+          ['unit_vect', false, 'Show the unit vector'],
+          ['use_before_scale', false, '(Effective only unless flow_vect) If true, use scale factor before vector.'],
+          ['max_unit_vect', false, '(Effective only if flow_vect && unit_vect) 
+            If true, use the maximum arrows to scale the unit vector; otherwise, normalize in V coordinate.']
+        )
+      end
+      opts = @@vector_on_merdional_section_options.interpret(options)
+      fx = fx.first2D.copy
+      fy = fy.first2D.copy
+      sh = fx.shape
+      if sh != fy.shape
+        raise ArgumentError, "shapes of fx and fy do not agree with each other"
+      end
+      fx = fx.transpose(1,0) if opts['transpose']
+      fy = fy.transpose(1,0) if opts['transpose']
+      if ((xi=opts['xintv']) >= 2)
+        idx = NArray.int(sh[0]/xi).indgen!*xi     # [0,xi,2*xi,..]
+        fx = fx[idx, true]
+        fy = fy[idx, true]
+      end
+      if ((yi=opts['xintv']) >= 2)
+        idx = NArray.int(sh[1]/yi).indgen!*yi     # [0,yi,2*yi,..]
+        fx = fx[true, idx]
+        fy = fy[true, idx]
+      end
+      xax = fx.coord(0)
+      yax = fy.coord(1)
+      aphi_ax, z_ax, was_proportional_to_p = \
+            GPhys::EP_Flux::preparate_for_vector_on_merdional_section(xax, yax)
+      if was_proportional_to_p
+	itr = 2 
+      else
+	itr = 1
+      end
+      if newframe
+	nextfig = @@next_fig.dup  if ( @@next_fig != nil ) # backup next_fig
+        fig(xax, yax, {'itr'=>itr}) 
+        axes(xax, yax)
+        if opts['title']
+          ttl = opts['title']
+        else
+          fxnm = fx.data.get_att('long_name') || fx.name
+          fynm = fy.data.get_att('long_name') || fy.name
+          ttl =   '('+fxnm+','+fynm+')'
+        end
+        title( ttl )
+        annotate(fx.lost_axes) if opts['annotate']
+	@@next_fig = nextfig      if ( @@next_fig != nil )
+      end
+      fig(aphi_ax, z_ax, {'new_frame'=>false, 'itr'=>1, 'yreverse'=>false}) \
+                                                          if (opts['newfig'])
+      DCL.uwsgxa(aphi_ax.val) 
+      DCL.uwsgya(z_ax.val)
+      if opts['flow_vect']
+	if opts['use_before_scale']
+	  vxfxratio = @@uninfo[0]; vxfyratio = @@uninfo[1]
+	  before=DCLExt.ug_set_params( {'LNRMAL'=>false, 'LMSG'=>false,
+					 'XFACT1'=>1.0, 'YFACT1'=>1.0} )
+	  DCL.ugvect(vxfxratio*fx.val, vxfyratio*fy.val)
+	  DCLExt.ug_set_params(before) 
+	  if opts['unit_vect']
+	    if opts['max_unit_vect']
+	      DCLExt.unit_vect(*@@uninfo)
+	    else
+	      DCLExt.unit_vect(*@@uninfo[0..1])
+	    end
+	  end
+	else
+	  @@uninfo = DCLExt.flow_vect(fx.val, fy.val, opts['factor'] )
+	  if opts['unit_vect']
+	    if opts['max_unit_vect']
+	      DCLExt.unit_vect(*@@uninfo)
+	    else
+	      DCLExt.unit_vect(*@@uninfo[0..1])
+	    end
+	  end
+	end
+      else
+	if opts['use_before_scale']
+	  vxfxratio = @@uninfo[0]; vxfyratio = @@uninfo[1]
+	  before1=DCLExt.ug_set_params({'lunit'=>true}) if opts['unit_vect']
+	  before2=DCLExt.ug_set_params( {'LNRMAL'=>false, 'LMSG'=>false,
+					 'XFACT1'=>1.0, 'YFACT1'=>1.0} )
+	  DCL.ugvect(vxfxratio*fx.val, vxfyratio*fy.val)
+	  DCLExt.ug_set_params(before1) if opts['unit_vect']
+	  DCLExt.ug_set_params(before2) 
+	else
+	  before=DCLExt.ug_set_params({'lunit'=>true}) if opts['unit_vect']
+	  DCL.ugvect(fx.val, fy.val)
+	  DCLExt.ug_set_params(before) if opts['unit_vect']
+	end
+	nil
+      end
+    end
+  end
+end

data/lib/numru/gphys/attribute.rb

@@ -0,0 +1,130 @@
+require "narray"
+
+module NumRu
+=begin
+=class Attribute < Hash
+A Hash class compatible with NetCDF attributes.
+* Values are restricted to NetCDFAttr values
+* Keys must be String or Symbol (Symbol is converted into String such that
+  they are used interchangeably. E.g., attr[:units] == attr["units"] )
+=end
+   class Attribute < Hash 
+      # privatalize all so that public methods must be set explicitly
+      private( *(Hash.instance_methods(false) - Object.new.methods).
+	           collect{|i| i.intern} )
+      protected :[], :[]=   # to be aliased
+      public :each, :each_key, :length, :keys, :delete, :delete_if
+      public :has_key?, :include?, :key?
+
+      def initialize
+	 super
+      end
+
+      class << self
+	 ## < class methods > ##
+	 alias _set_ []
+
+	 def [](*keyval)
+	    attr = new
+	    0.step(keyval.length-1,2){ |i|
+	       key,val = keyval[i],keyval[i+1]
+	       if key.is_a?(Symbol)
+		  key=key.to_s
+	       elsif ! key.is_a?(String)
+		  raise ArgumentError,"Attribute key must be String or Symbol: #{key} -- #{key.class}."
+	       end
+	       attr[key]=val
+	    }
+	    attr
+	 end
+      end
+
+      ## < methods > ##
+
+      def copy(to=nil)
+	 # deep copy (clone), or addition to "to" if given.
+	 if to == nil
+	    to = NumRu::Attribute.new
+	 end
+	 self.each{|key, val|
+	    if(val)
+	       to[key] = val.clone
+	    else
+	       to[key] = val
+	    end
+	 }
+	 to
+      end
+
+      alias _get_ []
+
+      def [](key)
+	 if key.is_a?(Symbol)
+	    key = key.to_s
+	 elsif ! key.is_a?(String)
+	    raise ArgumentError, "Attribute key must be Symbol or String: #{key} -- #{key.class}." 
+	 end
+	 if /^[A-Za-z_]\w*$/ !~ key
+	   raise ArgumentError, "Attribute key must match /^[A-Za-z_]\w*$/"
+         end
+	 self._get_(key)
+      end
+
+      alias _set_ []=
+
+      def []=(key, val)
+	 if _val_allowed?(val)
+	    if key.is_a?(Symbol)
+	       key = key.to_s
+	    elsif ! key.is_a?(String)
+	       raise ArgumentError, "Attribute key must be Symbol or String: #{key} -- #{key.class}." 
+	    end
+	    self._set_(key, val)
+	 else
+	    raise ArgumentError, "Not allowed as an attribute value: #{val} (String or NArray/Array of numerics are required`)" 
+	 end
+	 val
+      end
+
+      def rename(key_from, key_to)
+	 v = self[key_from]
+	 if v==nil; raise "attribute #{key_from} does not exist"; end
+         self[key_to]=v
+	 self.delete(key_from)
+      end
+
+      ## < private methods > ##
+      private
+      def _val_allowed?(val)
+	 # to ensure the compatibility with NetCDFAttr
+	 begin
+	    val.is_a?(String) || 
+	    ##   val.is_a?(Numeric) ||   # disabled 2005/03/25 by horinout
+	       val.is_a?(NilClass) ||
+	       ( ( (val.is_a?(NArray) && val.rank==1) || 
+	           (val.is_a?(Array) && val=NArray.to_na(val)) ) &&
+	         val.typecode <= NArray::DFLOAT )
+	 rescue
+	    # for possible error in val=NArray.to_na(val)) above
+	    false
+	 end
+      end
+   end
+end
+
+if __FILE__ == $0
+   a = NumRu::Attribute.new
+   p a
+   a["name"]="takeshi"
+   p a
+   b = @attr = NumRu::Attribute[:name2,"var", :units,"m/s", :valid_range,nil]
+   p b[:units]
+   p b["units"]
+   p b
+   p b["allowd"] = [1,10]
+   begin
+      b["not_allowd"] = [1,10,'no, no']
+   rescue
+      print "(OK): exception raised as expected\n"
+   end
+end

data/lib/numru/gphys/attributenetcdf.rb

@@ -0,0 +1,80 @@
+require "numru/netcdf.rb"
+require "numru/gphys/attribute.rb"
+require "numru/gphys/netcdf_convention"
+
+=begin
+=class Attribute_NetCDF
+A class to handle NetCDF attributes in the same way as in the 
+NumRu::Attribute class.
+=end
+
+module NumRu
+   class AttributeNetCDF
+      def initialize( ncvar )
+	 raise TypeError unless NetCDFVar===ncvar || NetCDF===ncvar
+	 @nv = ncvar
+	 convention = NetCDF_Conventions.find(ncvar.file)
+	 extend( convention::Attribute_Mixin )
+      end
+
+      def [](name)
+	  ( att = @nv.att(name) ) ? att.get : att
+      end
+
+      def []=(name, val)
+	 @nv.put_att(name,val)
+	 val
+      end
+
+      def copy(to=nil)
+	 # deep copy (clone), or addition to "to" if given.
+	 # ATTENTION!  If the destination "to" is not given, it will
+	 # be an Attribute (not AttributeNetCDF), which is on memory.
+	 if to == nil
+	    to = NumRu::Attribute.new
+	 end
+	 self.each{|key, val|
+	    to[key] = val
+	 }
+	 to
+      end
+
+      def rename(key_from, key_to)
+	 att = @nv.att(key_from)
+	 if att==nil; raise "attribute #{key_from} does not exist"; end
+         att.name= key_to
+      end
+
+      def each
+	 @nv.each_att{|att| yield(att.name, att.get)}
+      end
+
+      def each_key
+	 @nv.each_att{|att| yield(att.name)}
+      end
+
+      def length
+	 @nv.natts
+      end
+
+      def keys
+	 @nv.att_names
+      end
+
+      def delete(key)
+	 @nv.att(key).delete
+      end
+
+      def delete_if
+	 each{|key,val| delete(key) if yield(key,val)}
+      end
+
+      def has_key?(key)
+	 @nv.att(key) ? true : false
+      end
+      alias :include? :has_key?
+      alias :key? :has_key?
+
+   end
+end
+