miriad 4.1.0.4 → 4.1.0.6

data/Rakefile

@@ -1,4 +1,4 @@
-# $Id: Rakefile 18 2008-04-23 17:31:29Z davidm $
+# $Id: Rakefile 23 2008-04-30 21:42:24Z davidm $
 
 require 'rubygems'
 require 'rake/gempackagetask'
@@ -14,7 +14,7 @@ run_swig unless test ?e, 'ext/miriad_wrap.c'
 spec = Gem::Specification.new do |s|
   # Basics
   s.name = 'miriad'
-  s.version = '4.1.0.4'
+  s.version = '4.1.0.6'
   s.summary = 'Ruby interface to MIRIAD'
   s.description = <<-EOS
     The MIRIAD-Ruby package...

data/ext/miriad_ruby.c

@@ -1,5 +1,5 @@
 /*
- * $Id: miriad_ruby.c 18 2008-04-23 17:31:29Z davidm $
+ * $Id: miriad_ruby.c 23 2008-04-30 21:42:24Z davidm $
  *
  * This file is just to document the classes/methods from the SWIG wrappers
  * that we want to document.  It is for rdoc, not gcc.  At least for now.
@@ -95,10 +95,12 @@ static VALUE uvio_probvr;
  * +data+.  Generally, this works well only for Strings and NArrays, but not
  * for Numeric types.  For full control, specify +type+ as one of...
  *
- * * <tt>?a</tt> - ASCII data
- * * <tt>?i</tt> - Integer data
- * * <tt>?r</tt> - Single precision real data
- * * <tt>?d</tt> - Double precision real data
+ * * <tt>'a'</tt> (or <tt>?a</tt>) - ASCII data
+ * * <tt>'i'</tt> (or <tt>?i</tt>) - Integer data
+ * * <tt>'r'</tt> (or <tt>?r</tt>) - Single precision real data
+ * * <tt>'d'</tt> (or <tt>?d</tt>) - Double precision real data
+ * * <tt>'c'</tt> (or <tt>?c</tt>) - Single precision complex data [NOT YET
+ *   SUPPORTED!]
  */
 static VALUE uvio_putvr;
 
@@ -449,7 +451,8 @@ static VALUE uvio_track;
  *
  * +object+ can be either <tt>'source'</tt> or <tt>'purpose'</tt>.
  *
- * +datasel+ is either 1 to select or 0 to reject.
+ * +datasel+ is either +true+ or <tt>1</tt> to select; +false+ or <tt>0</tt> to
+ * reject.
  *
  * +value+ is a String that will be used as the search critereon.
  *
@@ -474,7 +477,8 @@ static VALUE uvio_sela;
  * +object+ is a String giving the parameter on which a select/discard
  * criterion is based.  See the list below for permissible values for +object+.
  *
- * +datasel+ is either 1 to select or 0 to reject.
+ * +datasel+ is either +true+ or <tt>1</tt> to select; +false+ or <tt>0</tt> to
+ * reject.
  *
  * <tt>p1</tt> and <tt>p2</tt>, both Floats, give added numerical parameters.
  * Generally <tt>p1</tt> and <tt>p2</tt> give a range of parameter values to

data/ext/miriad_ruby.i

@@ -1,5 +1,5 @@
 /*
- * $Id: miriad_ruby.i 18 2008-04-23 17:31:29Z davidm $
+ * $Id: miriad_ruby.i 23 2008-04-30 21:42:24Z davidm $
  *
  * Ruby specific typemaps for MIRIAD Swig wrapper 
  */
@@ -241,7 +241,11 @@ PUTVRX_TYPEMAP(NA_DFLOAT,double,NUM2DBL);
 
 // putvr typemap.
 %typemap(in) (int type) {
-  $1 = NUM2INT($input);
+  if(TYPE($input) == T_STRING) {
+    $1 = (int)((RSTRING($input)->ptr)[0]);
+  } else {
+    $1 = NUM2INT($input);
+  }
   switch($1) {
     case 'a': $1 = H_BYTE; break;
     case 'i': $1 = H_INT; break;
@@ -377,6 +381,17 @@ PUTVRX_TYPEMAP(NA_DFLOAT,double,NUM2DBL);
   }
 }
 
+// Typemap for datasel parameter of sela() and select()
+%typemap(in) (int datasel) {
+  if($input == Qfalse) {
+    $1 = 0;
+  } else if($input == Qtrue) {
+    $1 = 1;
+  } else {
+    $1 = NUM2INT($input);
+  }
+}
+
 // Make updated() a predicate method
 %predicate updated();
 

data/ext/miriad_wrap.c

@@ -2517,7 +2517,11 @@ _wrap_Uvio_putvr(int argc, VALUE *argv, VALUE self) {
   }
   if (argc > 2) {
     {
-      arg5 = NUM2INT(argv[2]);
+      if(TYPE(argv[2]) == T_STRING) {
+        arg5 = (int)((RSTRING(argv[2])->ptr)[0]);
+      } else {
+        arg5 = NUM2INT(argv[2]);
+      }
       switch(arg5) {
         case 'a': arg5 = H_BYTE; break;
         case 'i': arg5 = H_INT; break;
@@ -3373,8 +3377,6 @@ _wrap_Uvio_sela(int argc, VALUE *argv, VALUE self) {
   int res2 ;
   char *buf2 = 0 ;
   int alloc2 = 0 ;
-  int val3 ;
-  int ecode3 = 0 ;
   int res4 ;
   char *buf4 = 0 ;
   int alloc4 = 0 ;
@@ -3392,11 +3394,15 @@ _wrap_Uvio_sela(int argc, VALUE *argv, VALUE self) {
     SWIG_exception_fail(SWIG_ArgError(res2), Ruby_Format_TypeError( "", "char *","sela", 2, argv[0] ));
   }
   arg2 = (char *)(buf2);
-  ecode3 = SWIG_AsVal_int(argv[1], &val3);
-  if (!SWIG_IsOK(ecode3)) {
-    SWIG_exception_fail(SWIG_ArgError(ecode3), Ruby_Format_TypeError( "", "int","sela", 3, argv[1] ));
-  } 
-  arg3 = (int)(val3);
+  {
+    if(argv[1] == Qfalse) {
+      arg3 = 0;
+    } else if(argv[1] == Qtrue) {
+      arg3 = 1;
+    } else {
+      arg3 = NUM2INT(argv[1]);
+    }
+  }
   res4 = SWIG_AsCharPtrAndSize(argv[2], &buf4, NULL, &alloc4);
   if (!SWIG_IsOK(res4)) {
     SWIG_exception_fail(SWIG_ArgError(res4), Ruby_Format_TypeError( "", "char *","sela", 4, argv[2] ));
@@ -3434,8 +3440,6 @@ _wrap_Uvio_select(int argc, VALUE *argv, VALUE self) {
   int res2 ;
   char *buf2 = 0 ;
   int alloc2 = 0 ;
-  int val3 ;
-  int ecode3 = 0 ;
   double val4 ;
   int ecode4 = 0 ;
   double val5 ;
@@ -3454,11 +3458,15 @@ _wrap_Uvio_select(int argc, VALUE *argv, VALUE self) {
     SWIG_exception_fail(SWIG_ArgError(res2), Ruby_Format_TypeError( "", "char *","select", 2, argv[0] ));
   }
   arg2 = (char *)(buf2);
-  ecode3 = SWIG_AsVal_int(argv[1], &val3);
-  if (!SWIG_IsOK(ecode3)) {
-    SWIG_exception_fail(SWIG_ArgError(ecode3), Ruby_Format_TypeError( "", "int","select", 3, argv[1] ));
-  } 
-  arg3 = (int)(val3);
+  {
+    if(argv[1] == Qfalse) {
+      arg3 = 0;
+    } else if(argv[1] == Qtrue) {
+      arg3 = 1;
+    } else {
+      arg3 = NUM2INT(argv[1]);
+    }
+  }
   if (argc > 2) {
     ecode4 = SWIG_AsVal_double(argv[2], &val4);
     if (!SWIG_IsOK(ecode4)) {

data/lib/miriad.rb

@@ -7,12 +7,13 @@
 #    astronomy related methods to Ruby classes.
 #
 #--
-# $Id: miriad.rb 18 2008-04-23 17:31:29Z davidm $
+# $Id: miriad.rb 23 2008-04-30 21:42:24Z davidm $
 #++
 
 require 'rbconfig'
 require 'rubygems'
 require 'date'
+require 'enumerator'
 require 'narray'
 miriad_shared_lib = 'miriad.' + Config::CONFIG['DLEXT']
 require miriad_shared_lib
@@ -126,6 +127,9 @@ class DateTime
   # The J2000 epoch
   J2000 = civil(2000,1,1,12)
 
+  # The sidereal rotation rate of Earth in radians per second
+  OMEGA = 7.29211538e-5
+
   # Create a +DateTime+ object from a numeric Astronomical Julian Date.
   def self.ajd(d)
     J2000 + d - J2000.ajd
@@ -329,7 +333,7 @@ module Miriad
   # and <tt>xyz2</tt> in the direction of +obsra+, +obsdec+ (i.e. right
   # ascension and declination in the current epoch) at the local apparent
   # sidereal time +lst+.  <tt>xyz1</tt> and <tt>xyz2</tt> are three element
-  # arrays containing geocentric coordinates of the baseline endpoints, and
+  # arrays containing equitorial coordinates of the baseline endpoints, and
   # +obsra+, +obsdec+, and +lst+ are all in radians
   #
   # The body of this method was transcribed from the MIRIAD source file
@@ -358,7 +362,7 @@ module Miriad
   # call-seq:
   #   Miriad.neu2xyz(n, e, u, latitude) -> [x, y, z]
   #
-  # Convert topoceptric coordinates to geocentric coordinates.  If given,
+  # Convert topoceptric coordinates to equitorial coordinates.  If given,
   # +latitude+ should be in radians.  If +latitude+ is not given, the value
   # from <tt>ENV['LATITUDE']</tt> (which should be in degrees in
   # <tt>dd:mm:ss.sss</tt> or <tt>dd.ddd</tt> format) will be used.
@@ -366,7 +370,10 @@ module Miriad
   # Output coordinates will be in the same units as the input coordinates.
   #
   # See also Miriad.xyz2neu
-  def self.neu2xyz(n, e, u, latitude=String(ENV['LATITUDE']).dms_to_d.d2r)
+  def self.neu2xyz(*args)
+    n, e, u, latitude, extra = args.flatten!
+    latitude ||= ENV.fetch('LATITUDE','0.0').dms_to_d.d2r
+
     sinlat = Math.sin(latitude)
     coslat = Math.cos(latitude)
     [
@@ -386,7 +393,7 @@ module Miriad
   # call-seq:
   #   Miriad.xyz2nue(x, y, z, latitude) -> [n, e, u]
   #
-  # Convert geocentric coordinates to topocentric coordinates.  If given,
+  # Convert equitorial coordinates to topocentric coordinates.  If given,
   # +latitude+ should be in radians.  If +latitude+ is not given, the value
   # from <tt>ENV['LATITUDE']</tt> (which should be in degrees in
   # <tt>dd:mm:ss.sss</tt> or <tt>dd.ddd</tt> format) will be used.
@@ -446,6 +453,26 @@ module Miriad
     [az, el]
   end
 
+  # call-seq: Miriad.fringe_rate(bx, by, obsra, obsdec, lst, freq)
+  #
+  # Computes the Earth rotation synthesis fringe rate for a source at +obsra+
+  # and +obsdec+ at local sidereal time +lst+ and sky frequency +freq+ as seen
+  # by a baseline with X and Y equitorial components +bx+ and +by+.
+  #
+  # The units of the result depends on the the units of the inputs.  To get
+  # turns per second (i.e. Hz), +bx+ and +by+ should be in nanoseconds and
+  # +freq+ should be in GHz (alternatively, +bx+ and +by+ in seconds and +freq+
+  # in Hz).  To get radians per second, multiply +freq+ by 2*Math::PI.  To get
+  # degrees per second, multiply +freq+ by 360.
+  def self.fringe_rate(bx, by, obsra, obsdec, lst, freq)
+    ha = lst - obsra
+    cosha = Math.cos(ha)
+    sinha = Math.sin(ha)
+    cosd = Math.cos(obsdec)
+
+    -freq * DateTime::OMEGA * (bx*sinha + by*cosha) * cosd
+  end
+
   # call-seq: Miriad.parang(obsra, obsdec, lst, latitude) -> parallactic_angle
   #
   # Compute parallactic angle of an altitude-azimuth telescope. Accuracy is
@@ -613,8 +640,11 @@ module Miriad
     # call +to_a+ on the returned value (otherwise your +u+ variable might end
     # up as a three element NArray and +v+ and +w+ nil.)
     def coord() preamble[0..2]; end
+    # Computes the uv angle (in radians) from this Visibility's preamble using
+    # <tt>atan2(v,u)</tt>.
+    def uvangle() Math.atan2(preamble[1], preamble[0]); end
     # Computes the uv distance from this Visibility's preamble.
-    def uvdist() Math.sqrt(preamble[0]**2+preamble[1]**2); end
+    def uvdist() Math.hypot(preamble[0], preamble[1]); end
     # Returns the Julian date from this Visibility's preamble.
     def jd() preamble[3]; end
     # Returns the baseline number from this Visibility's preamble.
@@ -731,9 +761,119 @@ module Miriad
       vis
     end
 
+    # call-seq: nants -> Integer
+    #
+    # Returns the current value of the _nants_ uv variable or zero if it is not
+    # (yet) present.
+    def nants
+      getvr('nants') || 0
+    end
+
+    # call-seq:
+    #   antpos -> [[0,0,0], [Xa1,Ya1,Za1], ..., [Xan, Yan, Zan]]
+    #   antpos(a1, a2) -> [[Xa1,Ya1,Za1], [Xa2, Ya2, Za2]]
+    #   antpos([a1, a2]) -> [[Xa1,Ya1,Za1], [Xa2, Ya2, Za2]]
+    #   antpos(a) -> [Xa,Ya,Za]
+    #
+    # If called without a parameter (other than the optional Hash, see below),
+    # returns the current value of the _antpos_ uv variable array arranged for
+    # convenient indexing by a 1-based antenna number (e.g. as retuned by
+    # basant).  The 0th position in the array contains a [0,0,0] place holder
+    # position.
+    #
+    # If called with multiple integer parameters or an Array of Integers,
+    # returns an array of positions of the specified antennas.  In this case,
+    # the returned array will not contain a <tt>[0,0,0]</tt> placeholder in the
+    # 0th position.
+    #
+    # If called with a single Integer parameter, returns the position of the
+    # specified antenna.
+    #
+    # An optional Hash can be passed in as the last parameter to specify units
+    # and coordinates.  The following key/value entries are recognized:
+    #
+    # :coord => :xyz::    Position(s) in equitorial coordinates (default)
+    # :coord => :neu::    Position(s) in topocentric coordinates (uses the
+    #                     _latitude_ uv variable for conversion from XYZ to
+    #                     NEU)
+    # :coord => :uvw::    Projection of position in the direction of _obsra_
+    #                     and _obsdec_ at the local apparent sidereal time
+    #                     _lst_
+    #
+    # :units => :ns::     Position(s) in nanoseconds (default)
+    # :units => :meter::  Position(s) in meters
+    # :units => :lamda::  Position(s) in wavelengths
+    # :units => :klamda:: Position(s) in kilo-wavelengths
+    #
+    # The following are some examples of common usage:
+    #
+    #   a1xyz_ns, a2xyz_ns = uvio.antpos(uvio.basant)
+    #
+    #   ant5neu_m = uvio.antpos(5, :coord => :neu, :units => :meter)
+    def antpos(*args)
+      opts = {:coord => :xyz, :units => :ns}
+      opts.merge!(args.pop) if Hash === args[-1]
+      return nil unless ap = getvr('antpos')
+      args.flatten!
+      ap = ap.enum_slice(ap.length/3).entries.transpose.unshift([0,0,0])
+      ap = ap.values_at(*args.flatten) if args.length > 0
+
+      # Do units scaling, if requested
+      scale = case opts[:units]
+              when :ns: nil
+              when :meter: Math::CKMS / 1e6
+              when :lambda: getvr('freq') || 1.0
+              when :klambda: (getvr('freq') || 1.0) / 1000
+              else raise "Unrecognized units '#{opts[:units]}'"
+              end
+      ap.map!{|p| p.map!{|c| c*scale}} if scale
+
+      # Do coordinate conversion, if requested
+      if opts[:coord] == :neu
+        latitude = getvr('latitud') || 0.0
+        ap.map!{|p| Miriad.xyz2neu(p,latitude)}
+      elsif opts[:coord] == :uvw
+        obsra = getvr('obsra') || 0.0
+        obsdec = getvr('obsdec') || 0.0
+        lst = getvr('lst') || 0.0
+        ap.map!{|p| Miriad.xyz2uvw([0.0, 0.0, 0.0], p, obsra, obsdec, lst)}
+      elsif opts[:coord] != :xyz
+        raise "Unrecognized coordinate system '#{opts[:coord]}'"
+      end
+
+      # Return single position if only one was asked for
+      args.length == 1 ? ap[0] : ap
+    end
+
+    # call-seq:
+    #   baseline -> [bx, by, bz]
+    #   baseline(a1, a2) -> [Xa2-Xa1, Ya2-Ya1, Za2-Za1]
+    #
+    # If called without a parameter (other than the optional Hash, see below),
+    # returns the dimensions of the current baseline.
+    #
+    # If called with two antenna numbers, returns the dimension of their
+    # baseline.  The two antenna numbers will be swapped if a1 > a2.
+    #
+    # In either case, an optional Hash can be passed in.  This hash is passed
+    # to antpos, so see antpos for a decription of what options are available.
+    def baseline(*args)
+      opts = (Hash === args[-1]) ? args.pop : {}
+      a1, a2 = case args.length
+               when 0: basant
+               when 2: args
+               else raise ArgumentError(
+                 "wrong number of arguments (#{args.length} for 0 or 2)")
+               end
+      a1, a2 = a2, a1 if a1 > a2
+      p1, p2 = antpos(a1, a2, opts)
+      [p2[0]-p1[0], p2[1]-p1[1], p2[2]-p1[2]]
+    end
+
     # call-seq: nchan -> Integer
     #
-    # Returns the current value of the _nchan_ uv variable or zero if it is not (yet) present.
+    # Returns the current value of the _nchan_ uv variable or zero if it is not
+    # (yet) present.
     def nchan
       getvr('nchan') || 0
     end
@@ -769,11 +909,19 @@ module Miriad
       getvr('lst') - getvr('obsra') rescue 0.0
     end
 
+    # Computes the uv angle (in radians) from the current value of the _coord_
+    # uv variable using <tt>atan2(v,u)</tt>.  Returns 0.0 if _coord_ is
+    # undefined or maldefined.
+    def uvangle
+      u, v, w = getvr('coord')
+      (u && v) ? Math.atan2(v, u) : 0.0
+    end
+
     # Computes the uv distance from the current value of the _coord_ uv
     # variable.  Returns 0.0 if _coord_ is undefined or maldefined.
     def uvdist
       u, v, w = getvr('coord')
-      (u && v) ? Math.sqrt(u**2+v**2) : 0.0
+      (u && v) ? Math.hypot(u, v) : 0.0
     end
 
     # Computes the azimuth and elevation from the current values of _lst_,
@@ -789,6 +937,25 @@ module Miriad
       Miriad.azel(obsra, obsdec, lst, latitude)
     end
 
+    # Computes the Earth rotation synthesis fringe rate in Hz using the current
+    # values of the _obsra_, _obsdec_, _lst_, _antpos_, and _baseline_ uv
+    # variables.  +freq_ghz+ is the sky frequency, in GHz, for which the fringe
+    # rate will be determined.  If it is not given, the _freq_ uv variable will
+    # be used.
+    def fringe_hz(freq_ghz = getvr('freq'))
+      bx, by, bz = baseline
+      obsra = getvr('obsra') || 0.0
+      obsdec = getvr('obsdec') || 0.0
+      lst = getvr('lst') || 0.0
+      freq_ghz ||= 0.0
+      Miriad.fringe_rate(bx, by, obsra, obsdec, lst, freq_ghz)
+    end
+
+    # Returns <tt>getvr('inttime')</tt> or 0.0 if it is not (yet) defined.
+    def tau
+      getvr('inttime') || 0.0
+    end
+
     # Computes the current parallactic angle from the current values of _lst_,
     # _obsra_, _obsdec_, and _latitude_.  Missing components are assumed to be
     # 0.0.
@@ -809,6 +976,31 @@ module Miriad
       getvr('chi') || (parang + (getvr('evector') || 0.0))
     end
 
+    # Returns a Hash whose keys are the names of all uv variables present in
+    # this dataset, with corresponding values indicating the type code
+    # (suitable for passing to getvr()) of the uv variable.
+    #
+    # This reads the _vartable_ item, thus when using this method on a dataset
+    # opened in 'write' mode, you must call flush() before calling this method,
+    # otherwise the _vartable_ item will be up to date.
+    def vartable
+      v = {}
+      begin
+        item = haccess('vartable','r')
+      rescue
+        return nil
+      end
+      begin
+        while (line = hreadln(item))
+          type, name = line.split
+          v[name] = type[0,1]
+        end
+      ensure
+        hdaccess(item)
+      end
+      v
+    end
+
     # call-seq:
     #   uvio['name'] -> value or nil
     #   uvio[:name] -> value or nil
@@ -834,10 +1026,12 @@ module Miriad
     # well only for Strings and NArrays, but not for Numeric types.  For full
     # control, specify +type+ as one of...
     #
-    # * <tt>?a</tt> - ASCII data
-    # * <tt>?i</tt> - Integer data
-    # * <tt>?r</tt> - Single precision real data
-    # * <tt>?d</tt> - Double precision real data
+    # * <tt>'a'</tt> (or <tt>?a</tt>) - ASCII data
+    # * <tt>'i'</tt> (or <tt>?i</tt>) - Integer data
+    # * <tt>'r'</tt> (or <tt>?r</tt>) - Single precision real data
+    # * <tt>'d'</tt> (or <tt>?d</tt>) - Double precision real data
+    # * <tt>'c'</tt> (or <tt>?c</tt>) - Single precision complex data [NOT YET
+    #   SUPPORTED!]
     def []=(*args)
       n, t, v = case args.length
                 when 2: [args[0], -1, args[1]]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: miriad
 version: !ruby/object:Gem::Version 
-  version: 4.1.0.4
+  version: 4.1.0.6
 platform: ruby
 authors: 
 - David MacMahon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-23 00:00:00 -07:00
+date: 2008-04-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: miriad
-rubygems_version: 1.1.0
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Ruby interface to MIRIAD