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

List of all members.

Public Member Functions

def __init__
def imagepoltestimage
def complexlinpol
def complexfraclinpol
def depolratio
def close
def done
def fourierrotationmeasure
def fraclinpol
def fractotpol
def linpolint
def linpolposang
def makecomplex
def open
def pol
def rotationmeasure
def sigma
def sigmadepolratio
def sigmafraclinpol
def sigmafractotpol
def sigmalinpolint
def sigmalinpolposang
def sigmastokes
def sigmastokesi
def sigmastokesq
def sigmastokesu
def sigmastokesv
def sigmatotpolint
def stokes
def stokesi
def stokesq
def stokesu
def stokesv
def summary
def totpolint

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

Definition at line 70 of file imagepol.py.

Constructor & Destructor Documentation

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

Definition at line 77 of file imagepol.py.

Member Function Documentation

def __casac__.imagepol.imagepol.close (   self) 
close(self) -> bool

Summary
Close the image tool
--------------------------------------------------------------------------------

Definition at line 157 of file imagepol.py.

def __casac__.imagepol.imagepol.complexfraclinpol (   self,
  args,
  kwargs 
) 
complexfraclinpol(self, outfile) -> bool

Summary
Complex fractional linear polarization

Input Parameters:
outfile          Output image file name 

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

Definition at line 123 of file imagepol.py.

def __casac__.imagepol.imagepol.complexlinpol (   self,
  args,
  kwargs 
) 
complexlinpol(self, outfile) -> bool

Summary
Complex linear polarization

Input Parameters:
outfile          Output image file name 

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

Definition at line 108 of file imagepol.py.

def __casac__.imagepol.imagepol.depolratio (   self,
  args,
  kwargs 
) 
depolratio(self, infile, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Linear depolarization ratio

Input Parameters:
infile           Other image 
debias           Debias the linearly polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 138 of file imagepol.py.

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

Summary
Close this Imagepol tool
--------------------------------------------------------------------------------

Definition at line 168 of file imagepol.py.

def __casac__.imagepol.imagepol.fourierrotationmeasure (   self,
  args,
  kwargs 
) 
fourierrotationmeasure(self, complex=string(""), amp=string(""), pa=string(""), real=string(""), imag=string(""), 
    zerolag0=False) -> bool

Summary
Find Rotation Measure (Fourier approach)

Input Parameters:
complex          Output complex linear polarization image file name. Default is unset. 
amp              Output linear polarization amplitude image file name Default is unset. 
pa               Output linear polarization position angle (degrees) image file name Default is unset. 
real             Output linear polarization real image file name Default is unset. 
imag             Output linear polarization imaginary angle image file name Default is unset. 
zerolag0         Force zero lag to 0 ? false 

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

Definition at line 179 of file imagepol.py.

def __casac__.imagepol.imagepol.fraclinpol (   self,
  args,
  kwargs 
) 
fraclinpol(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Fractional linear polarization

Input Parameters:
debias           Debias the linearly polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name Default is unset. 

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

Definition at line 200 of file imagepol.py.

def __casac__.imagepol.imagepol.fractotpol (   self,
  args,
  kwargs 
) 
fractotpol(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Fractional total polarization

Input Parameters:
debias           Debias the total polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 218 of file imagepol.py.

def __casac__.imagepol.imagepol.imagepoltestimage (   self,
  args,
  kwargs 
) 
imagepoltestimage(self, outfile=string("imagepol.iquv"), rm=initialize_vector(1, (double)0.0), pa0=0.0, sigma=0.01, 
    nx=32, ny=32, nf=32, f0=1.4e9, bw=128.0e6) -> bool

Summary
Attach the Imagepol tool to a test image file

Input Parameters:
outfile          Output image file name imagepol.iquv 
rm               Rotation Measure (rad/m/m). Default is auto no-ambiguity determine. 0.0 
pa0              Position angle (degrees) at zero wavelength 0.0 
sigma            Fractional noise level 0.01 
nx               Shape of image in x direction 32 
ny               Shape of image in y direction 32 
nf               Shape of image in frequency direction 32 
f0               Reference frequency (Hz) 1.4e9 
bw               Bandwidth (Hz) 128.0e6 

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

Definition at line 84 of file imagepol.py.

def __casac__.imagepol.imagepol.linpolint (   self,
  args,
  kwargs 
) 
linpolint(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Linearly polarized intensity

Input Parameters:
debias           Debias the linearly polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 236 of file imagepol.py.

def __casac__.imagepol.imagepol.linpolposang (   self,
  args,
  kwargs 
) 
linpolposang(self, outfile=string("")) -> casac::image *

Summary
Linearly polarized position angle

Input Parameters:
outfile          Output image file name. Default is unset. 

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

Definition at line 254 of file imagepol.py.

def __casac__.imagepol.imagepol.makecomplex (   self,
  args,
  kwargs 
) 
makecomplex(self, complex, real=string(""), imag=string(""), amp=string(""), phase=string("")) -> bool

Summary
Make a Complex image

Input Parameters:
complex          Output complex image file name. Must be specified. 
real             Input real image file name. Default is unset. 
imag             Input imaginary image file name. Default is unset. 
amp              Input amplitude image file name. Default is unset. 
phase            Input phase image file name. Default is unset. 

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

Definition at line 269 of file imagepol.py.

def __casac__.imagepol.imagepol.open (   self,
  args,
  kwargs 
) 
open(self, image=initialize_variant("")) -> bool

Summary
Open a new image with this imagepol tool

Input Parameters:
image            image file name or image record (generated by ia.torecord()) 

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

Definition at line 288 of file imagepol.py.

def __casac__.imagepol.imagepol.pol (   self,
  args,
  kwargs 
) 
pol(self, which, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Polarized quantities

Input Parameters:
which            Specify operation. One of 'lpi', 'tpi', 'lppa', 'flp', 'ftp' (case insensitive) 
debias           Debias the polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 303 of file imagepol.py.

def __casac__.imagepol.imagepol.rotationmeasure (   self,
  args,
  kwargs 
) 
rotationmeasure(self, rm=string(""), rmerr=string(""), pa0=string(""), pa0err=string(""), nturns=string(""), 
    chisq=string(""), sigma=-1, rmfg=0.0, rmmax=0.0, maxpaerr=1e30, plotter=string(""), 
    nx=5, ny=5) -> bool

Summary
Find Rotation Measure (traditional approach)

Input Parameters:
rm               Output Rotation Measure image file name. Default is unset. 
rmerr            Output Rotation Measure error image file name. Default is unset. 
pa0              Output position angle (degrees) at zero wavelength image file name. Default is unset. 
pa0err           Output position angle (degrees) at zero wavelength error image file name. Default is unset. 
nturns           Output number of turns image file name. Default is unset. 
chisq            Output reduced chi squared image file name. Default is unset. 
sigma            Estimate of the thermal noise. Default is auto estimate. -1 
rmfg             Foreground Rotation Measure (rad/m/m) to subtract 0.0 
rmmax            Maximum Rotation Measure (rad/m/m) to solve for 0.0 
maxpaerr         Maximum input position angle error (degrees) to allow 1e30 
plotter          Name of plotter. Default is none. 
nx               Number of plots in x direction 5 
ny               Number of plots in y direction 5 

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

Definition at line 322 of file imagepol.py.

def __casac__.imagepol.imagepol.sigma (   self,
  clip = 10.0 
) 
sigma(self, clip=10.0) -> double

Summary
Find best guess at thermal noise

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 351 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmadepolratio (   self,
  args,
  kwargs 
) 
sigmadepolratio(self, infile, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Error in linear depolarization ratio

Input Parameters:
infile           Other image. Required input. 
debias           Debias the linearly polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 366 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmafraclinpol (   self,
  args,
  kwargs 
) 
sigmafraclinpol(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Error in fractional linear polarization

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 385 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmafractotpol (   self,
  args,
  kwargs 
) 
sigmafractotpol(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Error in fractional total polarization

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 402 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmalinpolint (   self,
  args,
  kwargs 
) 
sigmalinpolint(self, clip=10.0, sigma=-1, outfile=string("")) -> double

Summary
Error in linearly polarized intensity

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 419 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmalinpolposang (   self,
  args,
  kwargs 
) 
sigmalinpolposang(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Error in linearly polarized position angle

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 436 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmastokes (   self,
  args,
  kwargs 
) 
sigmastokes(self, which, clip=10.0) -> double

Summary
Find standard deviation of specified Stokes data

Input Parameters:
which            Must specify Stokes parameter. One of 'I', 'Q', 'U', 'V' (case insensitive) 
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 453 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmastokesi (   self,
  clip = 10.0 
) 
sigmastokesi(self, clip=10.0) -> double

Summary
Find standard deviation of Stokes I data

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 469 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmastokesq (   self,
  clip = 10.0 
) 
sigmastokesq(self, clip=10.0) -> double

Summary
Find standard deviation of Stokes Q data

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 484 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmastokesu (   self,
  clip = 10.0 
) 
sigmastokesu(self, clip=10.0) -> double

Summary
Find standard deviation of Stokes U data

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 499 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmastokesv (   self,
  clip = 10.0 
) 
sigmastokesv(self, clip=10.0) -> double

Summary
Find standard deviation of Stokes V data

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 

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

Definition at line 514 of file imagepol.py.

def __casac__.imagepol.imagepol.sigmatotpolint (   self,
  args,
  kwargs 
) 
sigmatotpolint(self, clip=10.0, sigma=-1) -> double

Summary
Error in total polarized intensity

Input Parameters:
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noise. Default is auto determined. -1 

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

Definition at line 529 of file imagepol.py.

def __casac__.imagepol.imagepol.stokes (   self,
  args,
  kwargs 
) 
stokes(self, which, outfile=string("")) -> casac::image *

Summary
Stokes

Input Parameters:
which            Must specify Stokes. One of 'I', 'Q', 'U', 'V' (case insensitive) 
outfile          Output image file name. Default is unset. 

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

Definition at line 545 of file imagepol.py.

def __casac__.imagepol.imagepol.stokesi (   self,
  args,
  kwargs 
) 
stokesi(self, outfile=string("")) -> casac::image *

Summary
Stokes I

Input Parameters:
outfile          Output image file name. Default is unset. 

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

Definition at line 561 of file imagepol.py.

def __casac__.imagepol.imagepol.stokesq (   self,
  args,
  kwargs 
) 
stokesq(self, outfile=string("")) -> casac::image *

Summary
Stokes Q

Input Parameters:
outfile          Output image file name. Default is unset. 

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

Definition at line 576 of file imagepol.py.

def __casac__.imagepol.imagepol.stokesu (   self,
  args,
  kwargs 
) 
stokesu(self, outfile=string("")) -> casac::image *

Summary
Stokes U

Input Parameters:
outfile          Output image file name. Default is unset. 

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

Definition at line 591 of file imagepol.py.

def __casac__.imagepol.imagepol.stokesv (   self,
  args,
  kwargs 
) 
stokesv(self, outfile=string("")) -> casac::image *

Summary
Stokes V

Input Parameters:
outfile          Output image file name. Default is unset. 

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

Definition at line 606 of file imagepol.py.

def __casac__.imagepol.imagepol.summary (   self) 
summary(self) -> bool

Summary
Summarise Imagepol tool
--------------------------------------------------------------------------------

Definition at line 621 of file imagepol.py.

def __casac__.imagepol.imagepol.totpolint (   self,
  args,
  kwargs 
) 
totpolint(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *

Summary
Total polarized intensity

Input Parameters:
debias           Debias the total polarized intensity ? false 
clip             Clip level for auto-sigma determination 10.0 
sigma            Standard deviation of thermal noised. Default is auto determined. -1 
outfile          Output image file name. Default is unset. 

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

Definition at line 632 of file imagepol.py.

Member Data Documentation

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

Definition at line 83 of file imagepol.py.

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

Definition at line 75 of file imagepol.py.

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

Definition at line 76 of file imagepol.py.

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

Definition at line 73 of file imagepol.py.

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

Definition at line 82 of file imagepol.py.

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

Definition at line 74 of file imagepol.py.

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

Definition at line 72 of file imagepol.py.

__casac__.imagepol.imagepol.this

Definition at line 81 of file imagepol.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