casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | Static Private Attributes
__casac__.measures.measures Class Reference
Inheritance diagram for __casac__.measures.measures:
__casac__.measures._object

List of all members.

Public Member Functions

def __init__
def dirshow
def show
def epoch
def direction
def getvalue
def gettype
def getref
def getoffset
def cometname
def comettype
def cometdist
def cometangdiam
def comettopo
def framecomet
def position
def observatory
def obslist
def linelist
def spectralline
def sourcelist
def source
def frequency
def doppler
def radialvelocity
def uvw
def touvw
def expand
def earthmagnetic
def baseline
def asbaseline
def listcodes
def measure
def doframe
def framenow
def showframe
def toradialvelocity
def tofrequency
def todoppler
def torestfrequency
def rise
def riseset
def posangle
def separation
def addxvalue
def type
def done
def ismeasure

Public Attributes

 this

Static Private Attributes

dictionary __swig_setmethods__
tuple __setattr__
dictionary __swig_getmethods__
tuple __getattr__
 __repr__
 __swig_destroy__
 __del__

Detailed Description

Proxy of C++ casac::measures class

Definition at line 70 of file measures.py.

Constructor & Destructor Documentation

def __casac__.measures.measures.__init__ (   self) 
__init__(self) -> measures

Definition at line 86 of file measures.py.

Member Function Documentation

def __casac__.measures.measures.addxvalue (   self,
  args,
  kwargs 
) 
addxvalue(self, a) -> record *

Summary
get some additional measure information

Input Parameters:
a                measures for which extra information is to be gotten 

--------------------------------------------------------------------------------

Definition at line 758 of file measures.py.

def __casac__.measures.measures.asbaseline (   self,
  args,
  kwargs 
) 
asbaseline(self, pos) -> record *

Summary
define a baseline from a position measure

Input Parameters:
pos              position measure 

--------------------------------------------------------------------------------

Definition at line 541 of file measures.py.

def __casac__.measures.measures.baseline (   self,
  args,
  kwargs 
) 
baseline(self, rf=string("ITRF"), v0=initialize_variant(""), v1=initialize_variant(""), v2=initialize_variant(""), 
    off=initialize_record("")) -> record *

Summary
define a baseline measure

Input Parameters:
rf               reference code ITRF 
v0               longitude or x 
v1               latitude or y 
v2               height or z 
off              optional offset baseline measure 

--------------------------------------------------------------------------------

Definition at line 521 of file measures.py.

def __casac__.measures.measures.cometangdiam (   self) 
cometangdiam(self) -> record *

Summary
get the angular diameter of the current comet in the current frame
--------------------------------------------------------------------------------

Definition at line 256 of file measures.py.

def __casac__.measures.measures.cometdist (   self) 
cometdist(self) -> record *

Summary
get the distance of the current comet in the current frame
--------------------------------------------------------------------------------

Definition at line 245 of file measures.py.

def __casac__.measures.measures.cometname (   self) 
cometname(self) -> string

Summary
get the current comet name
--------------------------------------------------------------------------------

Definition at line 223 of file measures.py.

def __casac__.measures.measures.comettopo (   self) 
comettopo(self) -> record *

Summary
get the current comet table coordinates
--------------------------------------------------------------------------------

Definition at line 267 of file measures.py.

def __casac__.measures.measures.comettype (   self) 
comettype(self) -> string

Summary
get the current comet table type
--------------------------------------------------------------------------------

Definition at line 234 of file measures.py.

def __casac__.measures.measures.direction (   self,
  args,
  kwargs 
) 
direction(self, rf=string("J2000"), v0=initialize_variant(""), v1=initialize_variant(""), off=initialize_record("")) -> record *

Summary
define a direction measure

Input Parameters:
rf               reference code J2000 
v0               longitude 
v1               latitude 
off              optional offset direction measure 

--------------------------------------------------------------------------------

Definition at line 145 of file measures.py.

def __casac__.measures.measures.dirshow (   self,
  args,
  kwargs 
) 
dirshow(self, v) -> string

Summary


Show direction measure as a string.
   

Input Parameters:
v                a direction measure value to be converted to string 

--------------------------------------------------------------------------------

Definition at line 93 of file measures.py.

def __casac__.measures.measures.doframe (   self,
  args,
  kwargs 
) 
doframe(self, v) -> bool

Summary
save a measure as frame reference

Input Parameters:
v                measure to be set in frame 

--------------------------------------------------------------------------------

Definition at line 588 of file measures.py.

def __casac__.measures.measures.done (   self) 
done(self) -> bool

Summary
free resources used by tool.
--------------------------------------------------------------------------------

Definition at line 784 of file measures.py.

def __casac__.measures.measures.doppler (   self,
  args,
  kwargs 
) 
doppler(self, rf=string("RADIO"), v0=initialize_variant(""), off=initialize_record("")) -> record *

Summary
define a doppler measure

Input Parameters:
rf               reference code RADIO 
v0               doppler ratio/velocity 
off              optional offset doppler measure 

--------------------------------------------------------------------------------

Definition at line 408 of file measures.py.

Referenced by task_sdplot.sdplot_worker.initialize_scan(), and task_sdplot.sdplot_worker.plot_grid().

def __casac__.measures.measures.earthmagnetic (   self,
  args,
  kwargs 
) 
earthmagnetic(self, rf=string("IGRF"), v0=initialize_variant(""), v1=initialize_variant(""), v2=initialize_variant(""), 
    off=initialize_record("")) -> record *

Summary
define an earthmagnetic measure

Input Parameters:
rf               reference code IGRF 
v0               Field strength 
v1               longitude 
v2               latitude 
off              optional offset earthmagnetic measure 

--------------------------------------------------------------------------------

Definition at line 501 of file measures.py.

def __casac__.measures.measures.epoch (   self,
  args,
  kwargs 
) 
epoch(self, rf=string("UTC"), v0=initialize_variant(""), off=initialize_record("")) -> record *

Summary
define an epoch measure

Input Parameters:
rf               reference code UTC 
v0               epoch value 
off              optional offset epoch measure 

--------------------------------------------------------------------------------

Definition at line 128 of file measures.py.

def __casac__.measures.measures.expand (   self,
  args,
  kwargs 
) 
expand(self, v=initialize_record(""), _xyz=_xyz_expand) -> record *

Summary
expand n positions to n*(n-1)/2 baselines

Input Parameters:
v                measure (baseline, position or uvw measure) 


Output Parameters:
_xyz             uvw (quantity array) 

--------------------------------------------------------------------------------

Definition at line 482 of file measures.py.

def __casac__.measures.measures.framecomet (   self,
  args,
  kwargs 
) 
framecomet(self, v=string("")) -> bool

Summary
set the current comet table

Input Parameters:
v                name of a table 

--------------------------------------------------------------------------------

Definition at line 278 of file measures.py.

def __casac__.measures.measures.framenow (   self) 
framenow(self) -> bool

Summary
set the active frame time at now
--------------------------------------------------------------------------------

Definition at line 603 of file measures.py.

def __casac__.measures.measures.frequency (   self,
  args,
  kwargs 
) 
frequency(self, rf=string("LSRK"), v0=initialize_variant(""), off=initialize_record("")) -> record *

Summary
define a frequency measure

Input Parameters:
rf               reference code LSRK 
v0               frequency/wavelength/\ldots 
off              optional offset frequency measure 

--------------------------------------------------------------------------------

Definition at line 391 of file measures.py.

def __casac__.measures.measures.getoffset (   self,
  args,
  kwargs 
) 
getoffset(self, v) -> record *

Summary
get the offset of a measure

Input Parameters:
v                measure (array of measures) 

--------------------------------------------------------------------------------

Definition at line 208 of file measures.py.

def __casac__.measures.measures.getref (   self,
  args,
  kwargs 
) 
getref(self, v) -> string

Summary
get the reference code of a measure

Input Parameters:
v                measure (array of measures) 

--------------------------------------------------------------------------------

Definition at line 193 of file measures.py.

def __casac__.measures.measures.gettype (   self,
  args,
  kwargs 
) 
gettype(self, v) -> string

Summary
get the type of a measure

Input Parameters:
v                measure (array of measures) 

--------------------------------------------------------------------------------

Definition at line 178 of file measures.py.

def __casac__.measures.measures.getvalue (   self,
  args,
  kwargs 
) 
getvalue(self, v) -> record *

Summary
get the value of a measure

Input Parameters:
v                measure (array of measures) 

--------------------------------------------------------------------------------

Definition at line 163 of file measures.py.

def __casac__.measures.measures.ismeasure (   self,
  args,
  kwargs 
) 
ismeasure(self, v) -> bool

Summary
Check if measure

Input Parameters:
v                value to be tested 

--------------------------------------------------------------------------------

Definition at line 795 of file measures.py.

def __casac__.measures.measures.linelist (   self) 
linelist(self) -> string

Summary
get a list of known spectral lines
--------------------------------------------------------------------------------

Definition at line 339 of file measures.py.

def __casac__.measures.measures.listcodes (   self,
  args,
  kwargs 
) 
listcodes(self, ms) -> record *

Summary
get known reference codes

Input Parameters:
ms               the measure type for which to list 

--------------------------------------------------------------------------------

Definition at line 556 of file measures.py.

def __casac__.measures.measures.measure (   self,
  args,
  kwargs 
) 
measure(self, v, rf, off=initialize_record("")) -> record *

Summary
convert a measure to another reference

Input Parameters:
v                measure to be converted 
rf               output reference code 
off              optional output offset measure 

--------------------------------------------------------------------------------

Definition at line 571 of file measures.py.

def __casac__.measures.measures.observatory (   self,
  args,
  kwargs 
) 
observatory(self, name=string("ALMA")) -> record *

Summary
get position of an observatory

Input Parameters:
name             observatory name - case insensitive ALMA 

--------------------------------------------------------------------------------

Definition at line 313 of file measures.py.

def __casac__.measures.measures.obslist (   self) 
obslist(self) -> string

Summary
get a list of known observatories
--------------------------------------------------------------------------------

Definition at line 328 of file measures.py.

def __casac__.measures.measures.posangle (   self,
  args,
  kwargs 
) 
posangle(self, m1, m2) -> record *

Summary
get position angle of two directions

Input Parameters:
m1               direction of source (direction measure) 
m2               direction of other source (direction measure) 

--------------------------------------------------------------------------------

Definition at line 726 of file measures.py.

def __casac__.measures.measures.position (   self,
  args,
  kwargs 
) 
position(self, rf=string("WGS84"), v0=initialize_variant(""), v1=initialize_variant(""), v2=initialize_variant(""), 
    off=initialize_record("")) -> record *

Summary
define a position measure

Input Parameters:
rf               reference code WGS84 
v0               longitude or x 
v1               latitude or y 
v2               height or z 
off              optional offset position measure 

--------------------------------------------------------------------------------

Definition at line 293 of file measures.py.

def __casac__.measures.measures.radialvelocity (   self,
  args,
  kwargs 
) 
radialvelocity(self, rf=string("LSRK"), v0=initialize_variant(""), off=initialize_record("")) -> record *

Summary
define a radialvelocity measure

Input Parameters:
rf               reference code LSRK 
v0               radial velocity 
off              optional offset radialvelocity measure 

--------------------------------------------------------------------------------

Definition at line 425 of file measures.py.

def __casac__.measures.measures.rise (   self,
  args,
  kwargs 
) 
rise(self, crd=initialize_variant(""), ev=initialize_variant("0.0deg")) -> record *

Summary
get rise and set sidereal time

Input Parameters:
crd              direction of source (direction measure) 
ev               elevation angle limit 0.0deg 

--------------------------------------------------------------------------------

Definition at line 694 of file measures.py.

def __casac__.measures.measures.riseset (   self,
  args,
  kwargs 
) 
riseset(self, crd, ev=initialize_variant("0.0deg")) -> record *

Summary
get rise and set times 

Input Parameters:
crd              direction of source (direction measure) 
ev               elevation limit 0.0deg 

--------------------------------------------------------------------------------

Definition at line 710 of file measures.py.

def __casac__.measures.measures.separation (   self,
  args,
  kwargs 
) 
separation(self, m1, m2) -> record *

Summary
get separation angle between two directions

Input Parameters:
m1               direction of source (direction measure) 
m2               direction of other source (direction measure) 

--------------------------------------------------------------------------------

Definition at line 742 of file measures.py.

def __casac__.measures.measures.show (   self,
  args,
  kwargs 
) 
show(self, v, refcode=True) -> string

Summary
 Show a measure as a string
   

Input Parameters:
v                measure value to be converted to string 
refcode          add the reference code to output true 

--------------------------------------------------------------------------------

Definition at line 111 of file measures.py.

Referenced by imageTest.ImageTest._retryFit(), imageTest.ImageTest.bmodel(), imageTest.ImageTest.bmodel_old(), asap.asaplotbase.asaplotbase.delete(), asap.asaplotbase.asaplotbase.plot(), asap.asaplotbase.asaplotbase.release(), asap.asaplotbase.asaplotbase.set_axes(), asap.asaplotbase.asaplotbase.set_figure(), and imageTest.ImageTest.simple_stats().

def __casac__.measures.measures.showframe (   self) 
showframe(self) -> string

Summary
show the currently active frame reference
--------------------------------------------------------------------------------

Definition at line 614 of file measures.py.

def __casac__.measures.measures.source (   self,
  args,
  kwargs 
) 
source(self, name=initialize_variant("1934-638")) -> record *

Summary
get direction of a source

Input Parameters:
name             name 1934-638 

--------------------------------------------------------------------------------

Definition at line 376 of file measures.py.

def __casac__.measures.measures.sourcelist (   self) 
sourcelist(self) -> string

Summary
get a list of known sources
--------------------------------------------------------------------------------

Definition at line 365 of file measures.py.

def __casac__.measures.measures.spectralline (   self,
  args,
  kwargs 
) 
spectralline(self, name=string("HI")) -> record *

Summary
get frequency of a spectral line

Input Parameters:
name             name HI 

--------------------------------------------------------------------------------

Definition at line 350 of file measures.py.

def __casac__.measures.measures.todoppler (   self,
  args,
  kwargs 
) 
todoppler(self, rf, v0, rfq=initialize_variant("")) -> record *

Summary
convert a frequency or radialvelocity measure
to a doppler measure

Input Parameters:
rf               doppler reference type 
v0               radial velocity or frequency measure 
rfq              rest frequency (frequency measure or frequency quantity) 

--------------------------------------------------------------------------------

Definition at line 659 of file measures.py.

def __casac__.measures.measures.tofrequency (   self,
  args,
  kwargs 
) 
tofrequency(self, rf, v0, rfq) -> record *

Summary
convert a doppler type value to a frequency

Input Parameters:
rf               frequency reference type 
v0               doppler measure value 
rfq              rest frequency (frequency measure or freuency quantity) 

--------------------------------------------------------------------------------

Definition at line 642 of file measures.py.

def __casac__.measures.measures.toradialvelocity (   self,
  args,
  kwargs 
) 
toradialvelocity(self, rf, v0) -> record *

Summary
convert a doppler type value to a real
radial velocity

Input Parameters:
rf               radial velocity reference type 
v0               doppler value measure 

--------------------------------------------------------------------------------

Definition at line 625 of file measures.py.

def __casac__.measures.measures.torestfrequency (   self,
  args,
  kwargs 
) 
torestfrequency(self, v0, d0) -> record *

Summary
convert a frequency and doppler measure
to a rest frequency

Input Parameters:
v0               frequency reference type 
d0               doppler measure value 

--------------------------------------------------------------------------------

Definition at line 677 of file measures.py.

def __casac__.measures.measures.touvw (   self,
  args,
  kwargs 
) 
touvw(self, v=initialize_record(""), _dot=_dot_touvw, _xyz=_xyz_touvw) -> record *

Summary
calculate a uvw measure from a baseline

Input Parameters:
v                baseline measure 


Output Parameters:
_dot             uvw-dot (quantity array) 
_xyz             uvw (quantity array) 

--------------------------------------------------------------------------------

Definition at line 462 of file measures.py.

def __casac__.measures.measures.type (   self) 
type(self) -> string

Summary
type of tool
--------------------------------------------------------------------------------

Definition at line 773 of file measures.py.

def __casac__.measures.measures.uvw (   self,
  args,
  kwargs 
) 
uvw(self, rf=string("ITRF"), v0=initialize_variant(""), v1=initialize_variant(""), v2=initialize_variant(""), 
    off=initialize_record("")) -> record *

Summary
define a uvw measure

Input Parameters:
rf               reference code ITRF 
v0               longitude or x 
v1               latitude or y 
v2               height or z 
off              optional offset uvw measure 

--------------------------------------------------------------------------------

Definition at line 442 of file measures.py.

Member Data Documentation

__casac__.measures.measures.__del__ [static, private]

Definition at line 92 of file measures.py.

tuple __casac__.measures.measures.__getattr__ [static, private]

Definition at line 75 of file measures.py.

__casac__.measures.measures.__repr__ [static, private]

Definition at line 76 of file measures.py.

tuple __casac__.measures.measures.__setattr__ [static, private]

Definition at line 73 of file measures.py.

__casac__.measures.measures.__swig_destroy__ [static, private]

Definition at line 91 of file measures.py.

dictionary __casac__.measures.measures.__swig_getmethods__ [static, private]

Definition at line 74 of file measures.py.

dictionary __casac__.measures.measures.__swig_setmethods__ [static, private]

Definition at line 72 of file measures.py.

__casac__.measures.measures.this

Definition at line 90 of file measures.py.

The documentation for this class was generated from the following file:
Generated on Thu Nov 15 2012 15:57:14 for casa by   doxygen 1.8.0