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

List of all members.

Public Member Functions

def __init__
def release
def saveastable
def loadfromtable
def summarizevps
def setcannedpb
def setpbairy
def setpbcospoly
def setpbgauss
def setpbinvpoly
def setpbnumeric
def setpbimage
def setpbpoly
def setpbantresptable
def reset
def setuserdefault
def getuserdefault
def getanttypes
def numvps
def getvp
def createantresp
def getrespimagename

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::vpmanager class

Definition at line 70 of file vpmanager.py.


Constructor & Destructor Documentation

__init__(self) -> vpmanager

Definition at line 77 of file vpmanager.py.


Member Function Documentation

def __casac__.vpmanager.vpmanager.createantresp (   self,
  args,
  kwargs 
)
createantresp(self, imdir=string(""), starttime=string(""), bandnames=std::vector< string >(1, ""), bandminfreq=std::vector< string >(1, ""), 
    bandmaxfreq=std::vector< string >(1, "")) -> bool

Summary
Create a standard-format AntennaResponses table

Input Parameters:
imdir            Path to the directory containing the response images 
starttime        Time from which onwards the response is valid, format YYYY/MM/DD/hh:mm:ss 
bandnames        List containing the names of the observatory's frequency bands 
bandminfreq      List containing the lower edges of the observatory's frequency bands, e.g. ['80GHz','120GHz'] 
bandmaxfreq      List containing the upper edges of the observatory's frequency bands, e.g. ['120GHz','180GHz'] 

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

Definition at line 484 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.getanttypes (   self,
  args,
  kwargs 
)
getanttypes(self, telescope=string(""), obstime=initialize_variant(""), freq=initialize_variant(""), 
    obsdirection=initialize_variant("AZEL 0deg 90deg")) -> std::vector< std::string >

Summary
Return the list of available antenna types for the given parameters

Input Parameters:
telescope        Telescope name 
obstime          Time of the observation (for versioning and reference frame calculations) 
freq             Frequency of the observation (may include reference frame, default: LSRK) 
obsdirection     Direction of the observation (may include reference frame, default: J2000). default: Zenith AZEL 0deg 90deg 

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

Definition at line 426 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.getrespimagename (   self,
  args,
  kwargs 
)
getrespimagename(self, telescope=string(""), starttime=string(""), frequency=string(""), functype=string("ANY"), 
    anttype=string(""), azimuth=string("0deg"), elevation=string("45deg"), 
    rectype=string(""), beamnumber=0) -> string

Summary
Get the image name for the given parameters from the given responses table

Input Parameters:
telescope        Which telescope is described by this response? 
starttime        Time at which the response has to be valid, format YYYY/MM/DD/hh:mm:ss 
frequency        The frequency at which the response has to be valid, e.g. '100GHz' 
functype         Type of the responsefunction requested, e.g. 'EFP' ANY 
anttype          Antenna type (observatory-dependent) 
azimuth          Azimuth of the observation (at the location of the observatory, 0 is North), e.g. '5deg' 0deg 
elevation        Elevation of the observation (at the location of the observatory, 0 is North), e.g. '60deg' 45deg 
rectype          Receiver type (observatory-dependent) 
beamnumber       Beam number (for the case of multiple beams per receiver) 0 

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

Definition at line 504 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.getuserdefault (   self,
  args,
  kwargs 
)
getuserdefault(self, telescope=string(""), anttype=string("")) -> int

Summary
Get the vp list number of the present default VP/PB for the given parameters (-1 = internal PB, -2 = none)

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? 
anttype          Which antennatype will use this vp/pb? Default: '' = all 

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

Definition at line 410 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.getvp (   self,
  args,
  kwargs 
)
getvp(self, telescope=string(""), antennatype=string(""), obstime=initialize_variant(""), freq=initialize_variant(""), 
    obsdirection=initialize_variant("AZEL 0deg 90deg")) -> record *

Summary
Return the default vps/pbs record for the given parameters

Input Parameters:
telescope        Telescope name 
antennatype      The antenna type as a string, e.g. 'DV' 
obstime          Time of the observation (for versioning and reference frame calculations), e.g. 2011/12/12T00:00:00 
freq             Frequency of the observation (may include reference frame, default: LSRK) 
obsdirection     Direction of the observation (may include reference frame, default: J2000), default: AZEL 0deg 90deg 

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

Definition at line 464 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.loadfromtable (   self,
  args,
  kwargs 
)
loadfromtable(self, tablename=string("")) -> bool

Summary
Load the vp or pb descriptions from a table (deleting all previous definitions)

Input Parameters:
tablename        Name of table to load vp descriptions from 

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

Definition at line 110 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.numvps (   self,
  args,
  kwargs 
)
numvps(self, telescope=string(""), obstime=initialize_variant(""), freq=initialize_variant(""), 
    obsdirection=initialize_variant("AZEL 0deg 90deg")) -> int

Summary
Return the number of vps/pbs available for the given parameters

Input Parameters:
telescope        Telescope name 
obstime          Time of the observation (for versioning and reference frame calculations) 
freq             Frequency of the observation (may include reference frame, default: LSRK) 
obsdirection     Direction of the observation (may include reference frame, default: J2000). default: Zenith AZEL 0deg 90deg 

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

Definition at line 445 of file vpmanager.py.

release(self)

Summary
Release the VPManager for use by others.
--------------------------------------------------------------------------------

Definition at line 84 of file vpmanager.py.

reset(self) -> bool

Summary
Reinitialize the VPManager (will erase all VPs and defaults defined on the command line)
--------------------------------------------------------------------------------

Definition at line 382 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.saveastable (   self,
  args,
  kwargs 
)
saveastable(self, tablename=string("")) -> bool

Summary
Save the vp or pb descriptions as a table

Input Parameters:
tablename        Name of table to save vp descriptions in 

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

Definition at line 95 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setcannedpb (   self,
  args,
  kwargs 
)
setcannedpb(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, commonpb=string("DEFAULT"), 
    dosquint=False, paincrement=initialize_variant("720deg"), usesymmetricbeam=False) -> record *

Summary
Select a vp/pb from our library of common pb models

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
commonpb         List of common vp/pb models: DEFAULT code figures it out DEFAULT 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 140 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbairy (   self,
  args,
  kwargs 
)
setpbairy(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, dishdiam=initialize_variant("25.0m"), 
    blockagediam=initialize_variant("2.5m"), maxrad=initialize_variant("0.8deg"), 
    reffreq=initialize_variant("1.0GHz"), squintdir=initialize_variant(""), 
    squintreffreq=initialize_variant("1.0GHz"), dosquint=False, 
    paincrement=initialize_variant("720deg"), usesymmetricbeam=False) -> record *

Summary
Make an airy disk vp

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
dishdiam         Effective diameter of dish 25.0m 
blockagediam     Effective diameter of subreflector blockage 2.5m 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 0.8deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0GHz 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 162 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbantresptable (   self,
  args,
  kwargs 
)
setpbantresptable(self, telescope=string(""), othertelescope=string(""), dopb=True, antresppath=string("")) -> bool

Summary
Declare a reference to an antenna responses table

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
antresppath      The path to the antenna responses table (absolute or relative to CASA data dir.) 

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

Definition at line 364 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbcospoly (   self,
  args,
  kwargs 
)
setpbcospoly(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, coeff=initialize_vector(1, (double)-1), 
    scale=initialize_vector(1, (double)-1), maxrad=initialize_variant("0.8deg"), 
    reffreq=initialize_variant("1.0GHz"), isthispb=string("PB"), 
    squintdir=initialize_variant(""), squintreffreq=initialize_variant("1.0GHz"), 
    dosquint=False, paincrement=initialize_variant("720deg"), usesymmetricbeam=False) -> record *

Summary
Make a vp/pb from a polynomial of scaled cosines

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
coeff            Vector of coefficients of cosines -1 
scale            Vector of scale factors of cosines -1 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 0.8deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
isthispb         Do these parameters describe a PB or a VP? PB 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0GHz 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 192 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbgauss (   self,
  args,
  kwargs 
)
setpbgauss(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, halfwidth=initialize_variant("0.5deg"), 
    maxrad=initialize_variant("1.0deg"), reffreq=initialize_variant("1.0GHz"), 
    isthispb=string("PB"), squintdir=initialize_variant(""), 
    squintreffreq=initialize_variant("1.0GHz"), dosquint=False, paincrement=initialize_variant("720deg"), 
    usesymmetricbeam=False) -> record *

Summary
Make a Gaussian vp/pb

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
halfwidth        Half power half width of the Gaussian at the reffreq 0.5deg 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 1.0deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
isthispb         Do these parameters describe a PB or a VP? PB 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0GHz 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 223 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbimage (   self,
  args,
  kwargs 
)
setpbimage(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, realimage=string(""), 
    imagimage=string(""), compleximage=string("")) -> record *

Summary
Make a vp/pb from a user-supplied image

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
realimage        Real part of vp as an image 
imagimage        Imaginary part of vp as an image 
compleximage     complex vp as an image of complex numbers; if specified realimage and imagimage are ignored 

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

Definition at line 313 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbinvpoly (   self,
  args,
  kwargs 
)
setpbinvpoly(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, coeff=initialize_vector(1, (double)-1), 
    maxrad=initialize_variant("0.8deg"), reffreq=initialize_variant("1.0GHz"), 
    isthispb=string("PB"), squintdir=initialize_variant(""), 
    squintreffreq=initialize_variant("1.0"), dosquint=False, paincrement=initialize_variant("720deg"), 
    usesymmetricbeam=False) -> record *

Summary
Make a vp/pb as an inverse polynomial

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
coeff            Coefficients of even powered terms -1 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 0.8deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
isthispb         Do these parameters describe a PB or a VP? PB 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 253 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbnumeric (   self,
  args,
  kwargs 
)
setpbnumeric(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, vect=initialize_vector(1, (double)-1), 
    maxrad=initialize_variant("0.8deg"), reffreq=initialize_variant("1.0GHz"), 
    isthispb=string("PB"), squintdir=initialize_variant(""), 
    squintreffreq=initialize_variant("1.0GHz"), dosquint=False, paincrement=initialize_variant("720deg"), 
    usesymmetricbeam=False) -> record *

Summary
Make a vp/pb from a user-supplied vector

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
vect             Vector of vp/pb samples uniformly spaced from 0 to maxrad -1 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 0.8deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
isthispb         Do these parameters describe a PB or a VP? PB 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0GHz 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720deg 
usesymmetricbeam         Not currently used false 

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

Definition at line 283 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setpbpoly (   self,
  args,
  kwargs 
)
setpbpoly(self, telescope=string("VLA"), othertelescope=string(""), dopb=True, coeff=initialize_vector(1, (double)-1), 
    maxrad=initialize_variant("0.8deg"), reffreq=initialize_variant("1.0GHz"), 
    isthispb=string("PB"), squintdir=initialize_variant(""), 
    squintreffreq=initialize_variant("1.0GHz"), dosquint=False, paincrement=initialize_variant("720"), 
    usesymmetricbeam=False) -> record *

Summary
Make a vp/pb from a polynomial

Input Parameters:
telescope        Which telescope in the MS will use this vp/pb? VLA 
othertelescope   If telescope=='OTHER', specify name here 
dopb             Should we apply the vp/pb to this telescope's data? true 
coeff            Coefficients of even powered terms -1 
maxrad           Maximum radial extent of the vp/pb (scales with 1/freq) 0.8deg 
reffreq          Frequency at which maxrad is specified 1.0GHz 
isthispb         Do these parameters describe a PB or a VP? PB 
squintdir        Offset (Measure) of RR beam from pointing center, azel frame (scales with 1/freq) 
squintreffreq    Frequency at which the squint is specified 1.0GHz 
dosquint         Enable the natural beam squint found in the common vp model false 
paincrement      Increment in Parallactic Angle for asymmetric (ie, squinted) vp application 720 
usesymmetricbeam         Not currently used false 

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

Definition at line 334 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.setuserdefault (   self,
  args,
  kwargs 
)
setuserdefault(self, vplistnum=-1, telescope=string(""), anttype=string("")) -> bool

Summary
Select the VP which is to be used by the imager for the given telescope and antenna type

Input Parameters:
vplistnum        The number of the vp as displayed by summarizevps(), or -1 for internal default, or -2 for unset -1 
telescope        Which telescope in the MS will use this vp/pb? 
anttype          Which antennatype will use this vp/pb? Default: '' = all 

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

Definition at line 393 of file vpmanager.py.

def __casac__.vpmanager.vpmanager.summarizevps (   self,
  verbose = False 
)
summarizevps(self, verbose=False) -> bool

Summary
Summarize the currently accumulated VP descriptions

Input Parameters:
verbose          Print out full record? Otherwise, print summary. false 

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

Definition at line 125 of file vpmanager.py.


Member Data Documentation

Definition at line 83 of file vpmanager.py.

Definition at line 75 of file vpmanager.py.

Definition at line 76 of file vpmanager.py.

Definition at line 73 of file vpmanager.py.

Definition at line 82 of file vpmanager.py.

Definition at line 74 of file vpmanager.py.

Definition at line 72 of file vpmanager.py.

Definition at line 81 of file vpmanager.py.


The documentation for this class was generated from the following file: