miriad 4.1.0.0 → 4.1.0.2

data/README

@@ -1,6 +1,6 @@
 --
 
-$Id: README 903 2008-04-17 23:05:44Z davidm $
+$Id: README 7 2008-04-18 07:21:10Z davidm $
 
 This file includes an RDoc hack so that links can be made to open up into a new
 frame rather then the current frame.

data/Rakefile

@@ -1,3 +1,5 @@
+# $Id: Rakefile 10 2008-04-21 19:51:41Z davidm $
+
 require 'rubygems'
 require 'rake/gempackagetask'
 
@@ -12,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.0'
+  s.version = '4.1.0.2'
   s.summary = 'Ruby interface to MIRIAD'
   s.description = <<-EOS
     The MIRIAD-Ruby package...
@@ -25,7 +27,7 @@ spec = Gem::Specification.new do |s|
     EOS
 
   #s.platform = Gem::Platform::Ruby
-  s.required_ruby_version = '>= 1.8.6'
+  s.required_ruby_version = '>= 1.8.4'
   #s.requirements << 'a prerequisite'
   s.add_dependency('narray', '>= 0.5.9')
 
@@ -58,7 +60,7 @@ spec = Gem::Specification.new do |s|
   s.extensions << 'ext/extconf.rb'
 
   # Documentation
-  s.rdoc_options = ['-x', 'ext/.*.c', '-m', 'README', '-t', "MIRIAD-Ruby Documentation"]
+  s.rdoc_options = ['-S', '-x', 'ext/.*.c', '-m', 'README', '-t', "MIRIAD-Ruby Documentation"]
   s.has_rdoc = true
   s.extra_rdoc_files = %w[README ext/miriad_ruby.c]
 

data/ext/bug.c

@@ -34,7 +34,7 @@
 #ifdef MIRIAD_RUBY
 #include "ruby.h"
 
-extern VALUE mirlib_eMirlibError;
+extern VALUE mirlib_eWrappedMirlibError;
 
 #define fprintf(io,fmt,...) \
   do { \
@@ -44,7 +44,7 @@ extern VALUE mirlib_eMirlibError;
         fprintf(io,fmt,__VA_ARGS__); \
         break; \
       default: \
-        rb_raise(mirlib_eMirlibError,fmt,__VA_ARGS__); \
+        rb_raise(mirlib_eWrappedMirlibError,fmt,__VA_ARGS__); \
     } \
   } while(0)
 

data/ext/extconf.rb

@@ -1,4 +1,4 @@
-#$Id: extconf.rb 895 2008-04-17 21:30:28Z davidm $
+# $Id: extconf.rb 7 2008-04-18 07:21:10Z davidm $
 #
 # Usage: ruby extconf.rb --with-narray-include=/path/to/narray.h
 

data/ext/miriad.i

@@ -1,4 +1,4 @@
-/* $Id: miriad.i 899 2008-04-17 21:51:06Z davidm $ */
+/* $Id: miriad.i 11 2008-04-21 20:31:15Z davidm $ */
 
 /* MIRIAD Swig wrapper */
 
@@ -309,6 +309,12 @@ typedef struct {} uvio;
     }
 #endif
 
+    unsigned int visno() {
+      double visno = 0.0;
+      uvinfo_c(self->fd, "visno", &visno);
+      return (unsigned int)visno;
+    }
+
     // void uvflgwr_c  (int tno, Const int *flags);
     void flagwr(int *flags) {
       uvflgwr_c(self->fd, flags);

data/ext/miriad_ruby.c

@@ -1,4 +1,6 @@
 /*
+ * $Id: miriad_ruby.c 16 2008-04-22 05:40:33Z 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.
  * Eventually, it might be nice to dump SWIG since I seem to spend more time
@@ -10,26 +12,18 @@
 
 /*
  * Document-class: Miriad
+ *
+ * In addition to the Uvio and Visibility classes, the Miriad module also
+ * provides some utility methods.
  */
 
 /*
  * Document-class: Miriad::Uvio
- */
-
-/*
- * Document-method: initialize
- * 
- * call-seq: Uvio.new(name, status)
- * 
- * <b>NOTE: This method provides lower-level access than the open() method.  It
- * may disappear in future versions.</b>
  *
- * Opens a uv dataset and readies it for access.  Here +name+ is the dataset's
- * name.  +status+ can be: <tt>'old'</tt> or <tt>'read'</tt> to open an
- * existing dataset for reading, <tt>'new'</tt> or <tt>'write'</tt> to create a
- * new dataset, or <tt>'append'</tt> to add to an existing dataset
+ * The Uvio class is mostly a SWIG wrapper around the UVIO C routines from
+ * MIRIAD.  Some convenience methods are added in
+ * miriad.rb[link:files/lib/miriad_rb.html].
  */
-static VALUE uvio_initialize();
 
 /*
  * Document-method: close
@@ -144,6 +138,12 @@ static VALUE uvio_scan;
  * complex data points.  This will be either half as many elements as +data+
  * (if +data+ has real and imaginary components in consecutive elements) or the
  * same number of elements as +data+ (if +data+ is NArray::SCOMPLEX).
+ *
+ * The +flags+ indicate whether the corresponding +data+ value has been deemed
+ * good or bad:
+ *
+ * * <tt>1</tt> means good
+ * * <tt>0</tt> means bad
  */
 static VALUE uvio_write;
 
@@ -352,8 +352,8 @@ static VALUE uvio_set;
  *
  * * +flags+
  *
- *   The flags indicate whether the corresponding data value has been deemed
- *   good or bad.  A +1+ means good; a +0+ means bad.
+ *   The +flags+ indicate whether the corresponding data value has been deemed
+ *   good or bad.  A <tt>1</tt> means good; a <tt>0</tt> means bad.
  *
  *   * If a Fixnum or Bignum is passed in as +flags+, an NArray that long of
  *     type NArray::LINT is created, populated with +nread+ flag values, and
@@ -395,6 +395,19 @@ static VALUE uvio_uvread;
  */
 static VALUE uvio_uvwread;
 
+/*
+ * Document-method: visno
+ *
+ * call-seq: visno(name) -> Integer
+ *
+ * Returns the number of the last visibility read.  Note that MIRIAD currently
+ * increments the visibiliity number on every read, including reads at (or
+ * beyond) the end of file.  This means that after looping through a dataset
+ * with <tt>while vis = uvio.read(vis)</tt>, +visno+ will return one more than
+ * the visibility number of the last visibility.
+ */
+static VALUE uvio_visno;
+
 /*
  * Document-method: getvr
  *
@@ -543,7 +556,12 @@ static VALUE uvio_select;
  * file), thus overwriting the old flags.
  *
  * +flags+ is either an Array or NArray (of type NArray::LINT) and will
- * typically have been returned by uvread and subsequently modified.
+ * typically have been returned by uvread and subsequently modified.  The
+ * +flags+ indicate whether the corresponding data value has been deemed good
+ * or bad:
+ *
+ * * <tt>1</tt> means good
+ * * <tt>0</tt> means bad
  */
 static VALUE uvio_flagwr;
 
@@ -575,7 +593,6 @@ static VALUE uvio_hiswrite;
 void Init_Uvio() {
   VALUE mMiriad = rb_define_module("Miriad");
   VALUE cUvio = rb_define_class_under(mMiriad,"Uvio",rb_cObject);
-  rb_define_method(cUvio, "initialize", uvio_initialize, 0);
   rb_define_method(cUvio, "close", uvio_close, 0);
   rb_define_method(cUvio, "flush", uvio_flush, 0);
   rb_define_method(cUvio, "uvnext", uvio_uvnext, 0);
@@ -588,6 +605,7 @@ void Init_Uvio() {
   rb_define_method(cUvio, "set", uvio_set, 0);       
   rb_define_method(cUvio, "uvread", uvio_uvread, 0);
   rb_define_method(cUvio, "uvwread", uvio_uvwread, 0);
+  rb_define_method(cUvio, "visno", uvio_visno, 0);
   rb_define_method(cUvio, "getvr", uvio_getvr, 0);
   rb_define_method(cUvio, "updated?", uvio_updated, 0);
   rb_define_method(cUvio, "track", uvio_track, 0);

data/ext/miriad_ruby.i

@@ -1,13 +1,18 @@
-/* Ruby specific typemaps for MIRIAD Swig wrapper */
+/*
+ * $Id: miriad_ruby.i 15 2008-04-22 05:26:51Z davidm $
+ *
+ * Ruby specific typemaps for MIRIAD Swig wrapper 
+ */
 
 #if defined SWIGRUBY
 
 %{
-VALUE mirlib_eMirlibError;
+VALUE mirlib_eWrappedMirlibError;
 %}
 
 %init %{
-  mirlib_eMirlibError = rb_define_class("MirlibError", rb_eStandardError);
+  mirlib_eWrappedMirlibError =
+    rb_define_class("WrappedMirlibError", rb_eStandardError);
 %}
 
 // Requires NArray Ruby extension
@@ -301,8 +306,13 @@ PUTVRX_TYPEMAP(NA_DFLOAT,double,NUM2DBL);
         }
         break;
       case H_BYTE:
-        $1 = RSTRING(rb_ary_entry(vinput3,0))->ptr;
-        $2 = RSTRING(rb_ary_entry(vinput3,0))->len;
+        {
+          // Make sure we have a string!
+          VALUE val = rb_ary_entry(vinput3,0);
+          Check_Type(val, T_STRING);
+          $1 = RSTRING(val)->ptr;
+          $2 = RSTRING(val)->len;
+        }
         break;
       default:
         rb_raise(rb_eArgError,

data/ext/miriad_wrap.c

@@ -1791,7 +1791,7 @@ typedef struct {
 } uvio;
 
 
-VALUE mirlib_eMirlibError;
+VALUE mirlib_eWrappedMirlibError;
 
 
 #include "narray.h"
@@ -2095,6 +2095,28 @@ SWIGINTERN void uvio_sela(uvio *self,char *object,int datasel,char *string){
 SWIGINTERN void uvio_select(uvio *self,char *object,int datasel,double p1,double p2){
       uvselect_c(self->fd, object, p1, p2, datasel);
     }
+SWIGINTERN unsigned int uvio_visno(uvio *self){
+      double visno = 0.0;
+      uvinfo_c(self->fd, "visno", &visno);
+      return (unsigned int)visno;
+    }
+
+  #define SWIG_From_long   LONG2NUM 
+
+
+SWIGINTERNINLINE VALUE
+SWIG_From_unsigned_SS_long  (unsigned long value)
+{
+  return ULONG2NUM(value); 
+}
+
+
+SWIGINTERNINLINE VALUE
+SWIG_From_unsigned_SS_int  (unsigned int value)
+{    
+  return SWIG_From_unsigned_SS_long  (value);
+}
+
 SWIGINTERN void uvio_flagwr(uvio *self,int *flags){
       uvflgwr_c(self->fd, flags);
     }
@@ -2132,9 +2154,6 @@ SWIGINTERN int uvio_haccess(uvio *self,char *keyword,char *status){
     return ihandle;
   }
 
-  #define SWIG_From_long   LONG2NUM 
-
-
 SWIGINTERNINLINE VALUE
 SWIG_From_int  (int value)
 {    
@@ -2535,8 +2554,13 @@ _wrap_Uvio_putvr(int argc, VALUE *argv, VALUE self) {
         }
         break;
       case H_BYTE:
-        arg3 = RSTRING(rb_ary_entry(vinput3,0))->ptr;
-        arg4 = RSTRING(rb_ary_entry(vinput3,0))->len;
+        {
+          // Make sure we have a string!
+          VALUE val = rb_ary_entry(vinput3,0);
+          Check_Type(val, T_STRING);
+          arg3 = RSTRING(val)->ptr;
+          arg4 = RSTRING(val)->len;
+        }
         break;
       default:
         rb_raise(rb_eArgError,
@@ -3546,6 +3570,30 @@ fail:
 }
 
 
+SWIGINTERN VALUE
+_wrap_Uvio_visno(int argc, VALUE *argv, VALUE self) {
+  uvio *arg1 = (uvio *) 0 ;
+  unsigned int result;
+  void *argp1 = 0 ;
+  int res1 = 0 ;
+  VALUE vresult = Qnil;
+  
+  if ((argc < 0) || (argc > 0)) {
+    rb_raise(rb_eArgError, "wrong # of arguments(%d for 0)",argc); SWIG_fail;
+  }
+  res1 = SWIG_ConvertPtr(self, &argp1,SWIGTYPE_p_uvio, 0 |  0 );
+  if (!SWIG_IsOK(res1)) {
+    SWIG_exception_fail(SWIG_ArgError(res1), Ruby_Format_TypeError( "", "uvio *","visno", 1, self )); 
+  }
+  arg1 = (uvio *)(argp1);
+  result = (unsigned int)uvio_visno(arg1);
+  vresult = SWIG_From_unsigned_SS_int((unsigned int)(result));
+  return vresult;
+fail:
+  return Qnil;
+}
+
+
 SWIGINTERN VALUE
 _wrap_Uvio_flagwr(int argc, VALUE *argv, VALUE self) {
   uvio *arg1 = (uvio *) 0 ;
@@ -4168,7 +4216,8 @@ SWIGEXPORT void Init_miriad(void) {
   buglabel_c("mirlib");
   
   
-  mirlib_eMirlibError = rb_define_class("MirlibError", rb_eStandardError);
+  mirlib_eWrappedMirlibError =
+  rb_define_class("WrappedMirlibError", rb_eStandardError);
   
   
   rb_require("narray");
@@ -4195,6 +4244,7 @@ SWIGEXPORT void Init_miriad(void) {
   rb_define_method(cUvio.klass, "track", _wrap_Uvio_track, -1);
   rb_define_method(cUvio.klass, "sela", _wrap_Uvio_sela, -1);
   rb_define_method(cUvio.klass, "select", _wrap_Uvio_select, -1);
+  rb_define_method(cUvio.klass, "visno", _wrap_Uvio_visno, -1);
   rb_define_method(cUvio.klass, "flagwr", _wrap_Uvio_flagwr, -1);
   rb_define_method(cUvio.klass, "wflagwr", _wrap_Uvio_wflagwr, -1);
   rb_define_method(cUvio.klass, "haccess", _wrap_Uvio_haccess, -1);

data/ext/narray_ruby.swg

@@ -1,3 +1,5 @@
+// $Id: narray_ruby.swg 7 2008-04-18 07:21:10Z davidm $
+//
 // Common setup for NArray typemaps
 //
 // Requires NArray Ruby extension

data/lib/miriad.rb

@@ -7,7 +7,7 @@
 #    astronomy related methods to Ruby classes.
 #
 #--
-#$Id: miriad.rb 901 2008-04-17 22:44:07Z davidm $
+# $Id: miriad.rb 15 2008-04-22 05:26:51Z davidm $
 #++
 
 require 'rbconfig'
@@ -16,7 +16,7 @@ require 'date'
 require 'narray'
 miriad_shared_lib = 'miriad.' + Config::CONFIG['DLEXT']
 require miriad_shared_lib
-require 'miriad_ruby_shared_library' if false # Fake out RDoc
+require 'miriad_gem' if false # Fake out RDoc
 #require 'fftw3'
 
 # Add CKMS constant to Math module
@@ -67,7 +67,7 @@ module Math
   def self.h2d(h) h*15.0; end
 end
 
-# Th MIRIAD package adds angle conversion and angle formatting methods to
+# The MIRIAD package adds angle conversion and angle formatting methods to
 # Numeric class.
 class Numeric
   # Convert +self+ to [degrees, minutes, seconds] where degrees and minutes are
@@ -112,7 +112,7 @@ end
 
 # The MIRIAD package adds angle parsing methods to String class.
 class String
-  # Parse a "dd:mm:ss.sss" String to Float degrees.
+  # Parse a "dd:mm:ss.sss" String to Numeric degrees.
   # <b>NOT</b> the inverse of Numeric#to_dmsstr (but may become so).
   def dms_to_d; Math::dms_to_d(*split(':').map{|s| s.to_f}); end
   # Parse a "hh:mm:ss.sss" String to Float hours.
@@ -138,9 +138,11 @@ class DateTime
     2000+(amjd-51544.5)/365.242189813
   end
 
+  # UT2-UT1 (unit is seconds) at the time represented by +self+
+  #
+  # Taken from
+  # http://www.iers.org/products/6/11136/orig/bulletina-xx-042.txt
   def ut2_ut1
-    # Taken from
-    # http://www.iers.org/products/6/11136/orig/bulletina-xx-042.txt
     pi2t=Math::PI*2*(by%1)
     ENV['UT2_UT1'] || 0.022 * Math::sin(pi2t) \
     - 0.012 * Math::cos(pi2t) \
@@ -260,7 +262,7 @@ class DateTime
 end
 
 # A subclass of StandardError raised by wrapped MIRIAD code.
-class MirlibError < StandardError
+class WrappedMirlibError < StandardError
 end
 
 # In addition to the Uvio and Visibility classes, the Miriad module also
@@ -270,35 +272,59 @@ module Miriad
   # The version of mirlib on which this package is based.
   MIRLIB_VERSION = "4.1.0"
 
-  # Contains Polarization code constants.  The values follow the AIPS/FITS
-  # conventions.
-  module Pol
-    # Stokes I
-    I = 1
-    # Stokes Q
-    Q = 2
-    # Stokes U
-    U = 3
-    # Stokes V
-    V = 4
-    # Circular RR
-    RR = -1
-    # Circular LL
-    LL = -2
-    # Circular RL
-    RL = -3
-    # Circular LR
-    LR = -4
-    # Linear XX
-    XX = -5
-    # Linear YY
-    YY = -6
-    # Linear XY
-    XY = -7
-    # Linear YX
-    YX = -8
-  end
-
+  polarization_code_lookup_table = {
+     1 => 'I' ,
+     2 => 'Q' ,
+     3 => 'U' ,
+     4 => 'V' ,
+    -1 => 'RR',
+    -2 => 'LL',
+    -3 => 'RL',
+    -4 => 'LR',
+    -5 => 'XX',
+    -6 => 'YY',
+    -7 => 'XY',
+    -8 => 'YX',
+    'I'  =>  1, 'i'  =>  1,
+    'Q'  =>  2, 'q'  =>  2,
+    'U'  =>  3, 'u'  =>  3,
+    'V'  =>  4, 'v'  =>  4,
+    'RR' => -1, 'rr' => -1,
+    'LL' => -2, 'll' => -2,
+    'RL' => -3, 'rl' => -3,
+    'LR' => -4, 'lr' => -4,
+    'XX' => -5, 'xx' => -5,
+    'YY' => -6, 'yy' => -6,
+    'XY' => -7, 'xy' => -7,
+    'YX' => -8, 'yx' => -8,
+  }.freeze
+
+  # POLMAP is a Hash that can be used to map polarization codes to strings and
+  # vice versa.
+  #
+  # * Whem mapping from codes (i.e. numbers), uppercase strings are returned.
+  #
+  # * Whem mapping from strings, either uppercase or lowercase (but *not* mixed
+  #   case) can be used.
+  #
+  # The values follow the AIPS/FITS conventions.  Here is the mapping:
+  #
+  # 1::  'I' (Stokes I)
+  # 2::  'Q' (Stokes Q)
+  # 3::  'U' (Stokes U)
+  # 4::  'V' (Stokes V)
+  # -1:: 'RR' (Circular RR)
+  # -2:: 'LL' (Circular LL)
+  # -3:: 'RL' (Circular RL)
+  # -4:: 'LR' (Circular LR)
+  # -5:: 'XX' (Linear XX)
+  # -6:: 'YY' (Linear YY)
+  # -7:: 'XY' (Linear XY)
+  # -8:: 'YX' (Linear YX)
+  POLMAP = polarization_code_lookup_table
+
+  # call-seq: Miriad.xyz2uvw(xyz1, xyz2, obsra, obsdec, lst) -> [u, v, w]
+  #
   # Compute the [u,v,w] projection of a baseline with endpoints <tt>xyz1</tt>
   # and <tt>xyz2</tt> in the direction of +obsra+, +obsdec+ (i.e. right
   # ascension and declination in the current epoch) at the local apparent
@@ -329,6 +355,128 @@ module Miriad
     [u,v,w]
   end
 
+  # call-seq:
+  #   Miriad.neu2xyz(n, e, u, latitude) -> [x, y, z]
+  #
+  # Convert topoceptric coordinates to geocentric 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.
+  #
+  # 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)
+    sinlat = Math.sin(latitude)
+    coslat = Math.cos(latitude)
+    [
+      u * coslat - n * sinlat,
+      e,
+      n * coslat + u * sinlat
+    ]
+  end
+
+  # :stopdoc:
+  class << self
+    alias :xyz2neu :neu2xyz
+  end
+  # :startdoc:
+  # RDoc xyz2neu as a method rather than an alias
+  if false
+  # call-seq:
+  #   Miriad.xyz2nue(x, y, z, latitude) -> [n, e, u]
+  #
+  # Convert geocentric 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.
+  #
+  # Output coordinates will be in the same units as the input coordinates.
+  #
+  # See also Miriad.neu2xyz
+  def self.xyz2neu(x, y, z, latitude=String(ENV['LATITUDE']).dms_to_d.d2r)
+    sinlat = Math.sin(latitude)
+    coslat = Math.cos(latitude)
+    [
+      u * coslat - n * sinlat,
+      e,
+      n * coslat + u * sinlat
+    ]
+  end
+  end
+
+  # call-seq: Miriad.azel(obsra, obsdec, lst, latitude) -> [azimuth, elevation]
+  #
+  # Compute +azimuth+ and +elevation+ from +obsra+, +obsdec+, +lst+,
+  # +latitude+.
+  #
+  # NOTE: This calculation is based on a spherical model for the earth, and
+  # does not include any atmospheric effects (e.g. refraction).
+  #
+  # Input:
+  #
+  # +obsra+::    Apparent RA of the source of interest (radians).
+  # +obsdec+::   Apparent DEC of the source of interest (radians).
+  # +lst+::      Local sidereal time (radians).
+  # +latitude+:: Observatory geodetic latitude (radians).  If 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.
+  #
+  # Output:
+  #
+  # +azimuth+::   Azimuth from north (radians).
+  # +elevation+:: Elevation from horizon (radians).
+  #
+  # The body of this method was transcribed from the miriad source file
+  # <tt>ephem.for</tt> originally created by Bob Sault.
+  def self.azel(obsra, obsdec, lst, latitude=String(ENV['LATITUDE']).dms_to_d.d2r)
+    ha = lst - obsra
+    cosha = Math.cos(ha)
+    sinha = Math.sin(ha)
+    cosd = Math.cos(obsdec)
+    sind = Math.sin(obsdec)
+    cosl = Math.cos(latitude)
+    sinl = Math.sin(latitude)
+
+    az = Math.atan2(-cosd*sinha, cosl*sind - sinl*cosd*cosha)
+
+    el = Math.asin(sinl*sind + cosl*cosd*cosha)
+
+    [az, el]
+  end
+
+  # call-seq: Miriad.parang(obsra, obsdec, lst, latitude) -> parallactic_angle
+  #
+  # Compute parallactic angle of an altitude-azimuth telescope. Accuracy is
+  # about 0.0003 radians.
+  #
+  # Input:
+  #
+  # +obsra+::    Apparent RA of the source of interest (radians).
+  # +obsdec+::   Apparent DEC of the source of interest (radians).
+  # +lst+::      Local sidereal time (radians).
+  # +latitude+:: Observatory geodetic latitude (radians).  If 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.
+  #
+  # Output:
+  #
+  # +parang+::   Parallactic angle (radians).
+  #
+  # The body of this method was transcribed from the miriad source file
+  # <tt>ephem.for</tt> originally created by Bob Sault.
+  def self.parang(obsra, obsdec, lst, latitude=String(ENV['LATITUDE']).dms_to_d.d2r)
+    ha = lst - obsra
+    sinq = Math.cos(latitude) * Math.sin(ha)
+    cosq = Math.sin(latitude) * Math.cos(obsdec) -
+           Math.cos(latitude) * Math.sin(obsdec) * Math.cos(ha)
+    Math.atan2(sinq, cosq)
+  end
+
+  # call-seq: Miriad.precess(ra, dec, to_jd, from_jd) -> [ra, dec]
+  #
   # Precess from one mean RA,DEC to another.
   #
   # A simple precession routine, to precess from one set of mean
@@ -336,18 +484,22 @@ module Miriad
   # This is accurate to order 0.3 arcsec over 50 years.
   #
   # Reference:
-  #   Explanatory Supplement to the Astronomical Almanac, 1993. p 105-106.
+  #
+  # <em>Explanatory Supplement to the Astronomical Almanac</em>, 1993. p
+  # 105-106.
   #
   # NOTE: This does not take account of atmospheric refraction,
   # nutation, aberration nor gravitational deflection.
   #
   # Input:
-  #   ra,dec   RA,DEC at the from_jd epoch (radians).
-  #   to_jd    Julian day of the new epoch. (defaults to current time)
-  #   from_jd  Julian day of the known epoch. (defaults to J2000)
+  #
+  # +ra+, +dec+:: RA,DEC at the from_jd epoch (radians).
+  # +to_jd+::     Julian day of the new epoch. (defaults to current time)
+  # +from_jd+::   Julian day of the known epoch. (defaults to J2000)
   #
   # Output:
-  #   [ra+,dec] Precessed coordinates (radians).
+  #
+  # <tt>[ra, dec]</tt>:: Precessed coordinates (radians).
   #
   # The body of this method was transcribed from the miriad source file
   # <tt>ephem.for</tt> originally created by Bob Sault.
@@ -377,24 +529,32 @@ module Miriad
     [ra, dec]
   end
 
-  # Format a MIRIAD baseline number as "A1-A2".
-  def self.basstr(baseline)
+  # call-seq: Miriad.basstr(baseline, format='%d-%d') -> "A1-A2"
+  #
+  # Format a MIRIAD baseline number as a String according to +format+.
+  def self.basstr(baseline, format='%d-%d')
     baseline = baseline.to_i
-    "%d-%d" % basant(baseline)
+    format % basant(baseline)
   end
 
+  # call-seq: Miriad.basant(baseline) -> [a1, a2]
+  #
   # Convert a MIRIAD baseline number into two antenna numbers.
   def self.basant(baseline)
     baseline = baseline.to_i
     [baseline/256, baseline%256]
   end
 
+  # call-seq: Miriad.antbas(a1, a2) -> baseline_number
+  #
   # Convert two antenna numbers into a MIRIAD baseline number
   def self.antbas(a1,a2)
     a1, a2 = a2, a1 if a2 < a1
     a1.to_i*256 + a2.to_i
   end
 
+  # call-seq: Miriad.basidx(a1, a2, n) -> baseline_index
+  #
   # Convert two antenna numbers, <tt>a1</tt> and <tt>a2</tt>, into a baseline
   # index (NOT a MIRIAD baseline number) using +n+ as the maximum antenna
   # number.
@@ -403,6 +563,8 @@ module Miriad
     return a1 + ((2*n+1)*(a2-a1) - (a2-a1)**2) / 2
   end
 
+  # call-seq: Miriad.idxbas(baseline_index, n) -> [a1, a2]
+  #
   # Convert a baseline index (NOT a MIRIAD baseline number) +i+ into two
   # antenna numbers using +n+ as the maximum antenna number.
   def self.idxbas(i,n)
@@ -439,21 +601,29 @@ module Miriad
     def self.[](preamble, data, flags)
       self.new(preamble, data, flags)
     end
-    # Returns the [u,v,w] coordinates from the preamble.
+    # call-seq: coord() -> [u, v, w]
+    #
+    # Returns the [u,v,w] coordinates from this Visibility's preamble.  Note
+    # that the returned array could be an Array or an NArray, depending on how
+    # Uvio#read was called.  If you want to use multiple assignment, be sure to
+    # 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
-    # Returns the Julian date from the preamble.
+    # Computes the uv distance from this Visibility's preamble.
+    def uvdist() Math.sqrt(preamble[0]**2+preamble[1]**2); end
+    # Returns the Julian date from this Visibility's preamble.
     def jd() preamble[3]; end
-    # Returns the baseline number from the preamble.
+    # Returns the baseline number from this Visibility's preamble.
     def baseline() preamble[4].to_i; end
-    # Returns a DateTime object corresponding to the Julian date from the
-    # preamble.
+    # Returns a DateTime object corresponding to the Julian date from this
+    # Visibility's preamble.
     def time() DateTime.ajd(jd); end
     # Returns the two antenna numbers corresponding to the baseline number
-    # from the preamble.
-    def ants() Miriad.basant(baseline); end
-    # True if the baseline is an autocorrelation.
+    # from this Visibility's preamble.
+    def basant() Miriad.basant(baseline); end
+    # True if this Visibility's baseline is an autocorrelation.
     def auto?() a1,a2=Miriad.basant(baseline); a1 == a2; end
-    # True if the baseline is a cross correlation.
+    # True if this Visibility's baseline is a cross correlation.
     def cross?() a1,a2=Miriad.basant(baseline); a1 != a2; end
     ## TODO Make this more robust (i.e. less hard-coded)
     #def lags()
@@ -478,9 +648,33 @@ module Miriad
     # Calls <tt>putvr(var, data, ?d)</tt>
     def putvrd(var,data) putvr(var, data, ?d); end
 
-    # Convenience wrapper around self.new.  Self.new may become private, so use
-    # this method instead.
-    def self.open(name,mode='r')
+    # Make new protected
+    class << self
+      protected :new
+    end
+
+    # call-seq:
+    #   Uvio.open(name, mode='r') -> uvio
+    #   Uvio.open(name, mode='r') {|uvio| ...}
+    #
+    # Opens a uv dataset and readies it for access.
+    #
+    # +name+:: The dataset's name
+    # +mode+:: Specifies how to open the dataset.  Valid values are:
+    #          * <tt>'r'</tt> for reading an existing dataset,
+    #          * <tt>'w'</tt> for writing a new dataset, or
+    #          * <tt>'a'</tt> for appending to an existing dataset.
+    #
+    # Note that datsets opened for reading may still be modified in some ways
+    # (e.g. writing new flags).
+    #
+    # If a block is given, dataset +name+ is opened according to +mode+ and the
+    # resulting Uvio object is passed into the block.  The dataset will be
+    # automatically closed when the block terminates.  In this case, the return
+    # value of Uvio.open is the return value of the block.
+    #
+    # If no block is given, the new Uvio object is returned.
+    def self.open(name, mode='r')
       raise 'invalid dataset name' if name.nil? or name.empty?
       case mode[0]
       when ?r then
@@ -491,7 +685,15 @@ module Miriad
         raise 'invalid dataset given' unless test ?d, name
       end
 
-      self.new(name,mode)
+      uvio = self.new(name,mode)
+
+      return uvio unless block_given?
+
+      begin
+        return yield(uvio)
+      ensure
+        uvio.close() rescue nil
+      end
     end
 
     # call-seq:
@@ -510,6 +712,7 @@ module Miriad
     # future versions!</b>
     def read(*args)
       if args.length == 0 || args[0].nil?
+        nchan = getvr('nchan') || 0
         n, p, d, f = uvread(5,nchan,nchan)
       elsif args.length == 1 && Visibility === args[0]
         n, p, d, f = uvread(args[0].preamble,args[0].data,args[0].flags)
@@ -520,44 +723,128 @@ module Miriad
       # Return nil on EOF
       return nil if n == 0
 
-      # FIXME for Array inputs
       # If nread is different than what was passed in
-      if n != d.length
-        # Shorten data and flags
-        d = d[0...n]
-        f = f[0...n]
-      end
+      dlen = flen = n
+      dlen *= 2 if Array === d
+      # Shorten data and flags
+      d = d[0...dlen] if dlen != d.length
+      f = f[0...flen] if flen != f.length
 
       # Return Visibility
       return args[0] if Visibility === args[0]
       Visibility[p,d,f]
     end
 
-    # call-seq: baseline -> [ant1, ant2]
+    # call-seq: polstr -> String
+    #
+    # Format the current value of the _pol_ uv variable as a String according
+    # to <tt>Miriad::POLMAP</tt>.
+    def polstr
+      Miriad::POLMAP[getvr('pol')]
+    end
+
+    # call-seq: basstr(format='%d-%d') -> "A1-A2"
     #
-    # Decodes the value of the +baseline+ uv variable and returns a two element
+    # Format the current value of the _baseline_ uv variable as a String
+    # according to +format+.
+    def basstr(format='%d-%d')
+      format % basant(getvr('baseline'))
+    end
+
+    # call-seq: basant -> [ant1, ant2]
+    #
+    # Decodes the value of the _baseline_ uv variable and returns a two element
     # array containing the two antenna numbers.
-    def baseline
+    def basant
       bl = getvr('baseline')
       bl = [bl.to_i/256, bl.to_i%256] if bl
     end
 
-    # Uvio.foo, if foo is not a predefined attribute or method, will return the
-    # current value of the MIRIAD UV variable +foo+ or +nil+ if it doesn't
-    # (yet) exist.
+    # Computes hour angle (in radians) as <tt>lst - obsra</tt>.
+    # Returns 0.0 if either one (or both) is undefined.
+    def ha
+      getvr('lst') - getvr('obsra') rescue 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
+    end
+
+    # Computes the azimuth and elevation from the current values of _lst_,
+    # _obsra_, _obsdec_, and _latitude_.  Missing components are assumed to be
+    # 0.0.
     #
-    # Uvio.foo=bar, if foo= is not a predefined attribute or method, will set
-    # the value of the MIRIAD UV variable +foo+ to +bar+.  Only valid for
-    # datasets opened in write mode.  [SETTER FUNCTIONALITY NOT YET
-    # IMPLEMENTED!]
-    def method_missing(sym,*args)
-      val = nil
-      var = sym.to_s
-      case var
-      when /=$/: break
-      else val = getvr(var)
-      end
-      val
+    # See Miriad.azel for more details.
+    def azel
+      obsra = getvr('obsra') || 0.0
+      obsdec = getvr('obsdec') || 0.0
+      lst = getvr('lst') || 0.0
+      latitude = getvr('latitud') || 0.0
+      Miriad.azel(obsra, obsdec, lst, latitude)
+    end
+
+    # Computes the current parallactic angle from the current values of _lst_,
+    # _obsra_, _obsdec_, and _latitude_.  Missing components are assumed to be
+    # 0.0.
+    #
+    # See Miriad.parang for more details.
+    def parang
+      obsra = getvr('obsra') || 0.0
+      obsdec = getvr('obsdec') || 0.0
+      lst = getvr('lst') || 0.0
+      latitude = getvr('latitud') || 0.0
+      Miriad.parang(obsra, obsdec, lst, latitude)
+    end
+
+    # Returns the value of the uv variable _chi_.  If _chi_ is not defined,
+    # return <tt>parang()</tt> plus the value of the _evector_ uv variable
+    # if it is defined.
+    def chi
+      getvr('chi') || (parang + (getvr('evector') || 0.0))
+    end
+
+    # call-seq:
+    #   uvio['name'] -> value or nil
+    #   uvio[:name] -> value or nil
+    #
+    # Returns the current value of the uv variable named +name+ or +nil+ if the
+    # named variable does not (yet) exist.
+    #
+    # This provides a Hash-like interface to the uv variables.
+    #
+    # It is implemented as <tt>getvr(name.to_s)</tt>.
+    def [](name)
+      getvr(name.to_s)
+    end
+
+    # call-seq:
+    #   uvio['name'] = value -> value
+    #   uvio[:name] = value -> value
+    #   uvio['name', type] = value -> value
+    #   uvio[:name, type] = value  -> value
+    #
+    # Sets the uv variable +name+ to +value+.  If +type+ is not given, the
+    # MIRIAD type will be autodetected from +value+.  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
+    def []=(*args)
+      n, t, v = case args.length
+                when 2: [args[0], -1, args[1]]
+                when 3: [args[0], args[1], args[2]]
+                else
+                  raise ArgumentError.new(
+                    "wrong number of arguments (#{args.length} for 3)")
+                end
+      putvr(n.to_s, v, t)
+      v
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: miriad
 version: !ruby/object:Gem::Version 
-  version: 4.1.0.0
+  version: 4.1.0.2
 platform: ruby
 authors: 
 - David MacMahon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-17 00:00:00 -07:00
+date: 2008-04-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,6 +61,7 @@ has_rdoc: true
 homepage: http://miriad.rubyforge.org/
 post_install_message: 
 rdoc_options: 
+- -S
 - -x
 - ext/.*.c
 - -m
@@ -74,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.6
+      version: 1.8.4
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: