casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
imagepol.py
Go to the documentation of this file.
00001 # This file was automatically generated by SWIG (http://www.swig.org).
00002 # Version 2.0.5
00003 #
00004 # Do not make changes to this file unless you know what you are doing--modify
00005 # the SWIG interface file instead.
00006 
00007 
00008 
00009 from sys import version_info
00010 if version_info >= (2,6,0):
00011     def swig_import_helper():
00012         from os.path import dirname
00013         import imp
00014         fp = None
00015         try:
00016             fp, pathname, description = imp.find_module('_imagepol', [dirname(__file__)])
00017         except ImportError:
00018             import _imagepol
00019             return _imagepol
00020         if fp is not None:
00021             try:
00022                 _mod = imp.load_module('_imagepol', fp, pathname, description)
00023             finally:
00024                 fp.close()
00025             return _mod
00026     _imagepol = swig_import_helper()
00027     del swig_import_helper
00028 else:
00029     import _imagepol
00030 del version_info
00031 try:
00032     _swig_property = property
00033 except NameError:
00034     pass # Python < 2.2 doesn't have 'property'.
00035 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
00036     if (name == "thisown"): return self.this.own(value)
00037     if (name == "this"):
00038         if type(value).__name__ == 'SwigPyObject':
00039             self.__dict__[name] = value
00040             return
00041     method = class_type.__swig_setmethods__.get(name,None)
00042     if method: return method(self,value)
00043     if (not static):
00044         self.__dict__[name] = value
00045     else:
00046         raise AttributeError("You cannot add attributes to %s" % self)
00047 
00048 def _swig_setattr(self,class_type,name,value):
00049     return _swig_setattr_nondynamic(self,class_type,name,value,0)
00050 
00051 def _swig_getattr(self,class_type,name):
00052     if (name == "thisown"): return self.this.own()
00053     method = class_type.__swig_getmethods__.get(name,None)
00054     if method: return method(self)
00055     raise AttributeError(name)
00056 
00057 def _swig_repr(self):
00058     try: strthis = "proxy of " + self.this.__repr__()
00059     except: strthis = ""
00060     return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
00061 
00062 try:
00063     _object = object
00064     _newclass = 1
00065 except AttributeError:
00066     class _object : pass
00067     _newclass = 0
00068 
00069 
00070 class imagepol(_object):
00071     """Proxy of C++ casac::imagepol class"""
00072     __swig_setmethods__ = {}
00073     __setattr__ = lambda self, name, value: _swig_setattr(self, imagepol, name, value)
00074     __swig_getmethods__ = {}
00075     __getattr__ = lambda self, name: _swig_getattr(self, imagepol, name)
00076     __repr__ = _swig_repr
00077     def __init__(self): 
00078         """__init__(self) -> imagepol"""
00079         this = _imagepol.new_imagepol()
00080         try: self.this.append(this)
00081         except: self.this = this
00082     __swig_destroy__ = _imagepol.delete_imagepol
00083     __del__ = lambda self : None;
00084     def imagepoltestimage(self, *args, **kwargs):
00085         """
00086         imagepoltestimage(self, outfile=string("imagepol.iquv"), rm=initialize_vector(1, (double)0.0), pa0=0.0, sigma=0.01, 
00087             nx=32, ny=32, nf=32, f0=1.4e9, bw=128.0e6) -> bool
00088 
00089         Summary
00090                 Attach the Imagepol tool to a test image file
00091 
00092         Input Parameters:
00093                 outfile          Output image file name imagepol.iquv 
00094                 rm               Rotation Measure (rad/m/m). Default is auto no-ambiguity determine. 0.0 
00095                 pa0              Position angle (degrees) at zero wavelength 0.0 
00096                 sigma            Fractional noise level 0.01 
00097                 nx               Shape of image in x direction 32 
00098                 ny               Shape of image in y direction 32 
00099                 nf               Shape of image in frequency direction 32 
00100                 f0               Reference frequency (Hz) 1.4e9 
00101                 bw               Bandwidth (Hz) 128.0e6 
00102                 
00103         --------------------------------------------------------------------------------
00104                       
00105         """
00106         return _imagepol.imagepol_imagepoltestimage(self, *args, **kwargs)
00107 
00108     def complexlinpol(self, *args, **kwargs):
00109         """
00110         complexlinpol(self, outfile) -> bool
00111 
00112         Summary
00113                 Complex linear polarization
00114 
00115         Input Parameters:
00116                 outfile          Output image file name 
00117                 
00118         --------------------------------------------------------------------------------
00119                       
00120         """
00121         return _imagepol.imagepol_complexlinpol(self, *args, **kwargs)
00122 
00123     def complexfraclinpol(self, *args, **kwargs):
00124         """
00125         complexfraclinpol(self, outfile) -> bool
00126 
00127         Summary
00128                 Complex fractional linear polarization
00129 
00130         Input Parameters:
00131                 outfile          Output image file name 
00132                 
00133         --------------------------------------------------------------------------------
00134                       
00135         """
00136         return _imagepol.imagepol_complexfraclinpol(self, *args, **kwargs)
00137 
00138     def depolratio(self, *args, **kwargs):
00139         """
00140         depolratio(self, infile, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00141 
00142         Summary
00143                 Linear depolarization ratio
00144 
00145         Input Parameters:
00146                 infile           Other image 
00147                 debias           Debias the linearly polarized intensity ? false 
00148                 clip             Clip level for auto-sigma determination 10.0 
00149                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00150                 outfile          Output image file name. Default is unset. 
00151                 
00152         --------------------------------------------------------------------------------
00153                       
00154         """
00155         return _imagepol.imagepol_depolratio(self, *args, **kwargs)
00156 
00157     def close(self):
00158         """
00159         close(self) -> bool
00160 
00161         Summary
00162                 Close the image tool
00163         --------------------------------------------------------------------------------
00164                       
00165         """
00166         return _imagepol.imagepol_close(self)
00167 
00168     def done(self):
00169         """
00170         done(self) -> bool
00171 
00172         Summary
00173                 Close this Imagepol tool
00174         --------------------------------------------------------------------------------
00175                       
00176         """
00177         return _imagepol.imagepol_done(self)
00178 
00179     def fourierrotationmeasure(self, *args, **kwargs):
00180         """
00181         fourierrotationmeasure(self, complex=string(""), amp=string(""), pa=string(""), real=string(""), imag=string(""), 
00182             zerolag0=False) -> bool
00183 
00184         Summary
00185                 Find Rotation Measure (Fourier approach)
00186 
00187         Input Parameters:
00188                 complex          Output complex linear polarization image file name. Default is unset. 
00189                 amp              Output linear polarization amplitude image file name Default is unset. 
00190                 pa               Output linear polarization position angle (degrees) image file name Default is unset. 
00191                 real             Output linear polarization real image file name Default is unset. 
00192                 imag             Output linear polarization imaginary angle image file name Default is unset. 
00193                 zerolag0         Force zero lag to 0 ? false 
00194                 
00195         --------------------------------------------------------------------------------
00196                       
00197         """
00198         return _imagepol.imagepol_fourierrotationmeasure(self, *args, **kwargs)
00199 
00200     def fraclinpol(self, *args, **kwargs):
00201         """
00202         fraclinpol(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00203 
00204         Summary
00205                 Fractional linear polarization
00206 
00207         Input Parameters:
00208                 debias           Debias the linearly polarized intensity ? false 
00209                 clip             Clip level for auto-sigma determination 10.0 
00210                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00211                 outfile          Output image file name Default is unset. 
00212                 
00213         --------------------------------------------------------------------------------
00214                       
00215         """
00216         return _imagepol.imagepol_fraclinpol(self, *args, **kwargs)
00217 
00218     def fractotpol(self, *args, **kwargs):
00219         """
00220         fractotpol(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00221 
00222         Summary
00223                 Fractional total polarization
00224 
00225         Input Parameters:
00226                 debias           Debias the total polarized intensity ? false 
00227                 clip             Clip level for auto-sigma determination 10.0 
00228                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00229                 outfile          Output image file name. Default is unset. 
00230                 
00231         --------------------------------------------------------------------------------
00232                       
00233         """
00234         return _imagepol.imagepol_fractotpol(self, *args, **kwargs)
00235 
00236     def linpolint(self, *args, **kwargs):
00237         """
00238         linpolint(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00239 
00240         Summary
00241                 Linearly polarized intensity
00242 
00243         Input Parameters:
00244                 debias           Debias the linearly polarized intensity ? false 
00245                 clip             Clip level for auto-sigma determination 10.0 
00246                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00247                 outfile          Output image file name. Default is unset. 
00248                 
00249         --------------------------------------------------------------------------------
00250                       
00251         """
00252         return _imagepol.imagepol_linpolint(self, *args, **kwargs)
00253 
00254     def linpolposang(self, *args, **kwargs):
00255         """
00256         linpolposang(self, outfile=string("")) -> casac::image *
00257 
00258         Summary
00259                 Linearly polarized position angle
00260 
00261         Input Parameters:
00262                 outfile          Output image file name. Default is unset. 
00263                 
00264         --------------------------------------------------------------------------------
00265                       
00266         """
00267         return _imagepol.imagepol_linpolposang(self, *args, **kwargs)
00268 
00269     def makecomplex(self, *args, **kwargs):
00270         """
00271         makecomplex(self, complex, real=string(""), imag=string(""), amp=string(""), phase=string("")) -> bool
00272 
00273         Summary
00274                 Make a Complex image
00275 
00276         Input Parameters:
00277                 complex          Output complex image file name. Must be specified. 
00278                 real             Input real image file name. Default is unset. 
00279                 imag             Input imaginary image file name. Default is unset. 
00280                 amp              Input amplitude image file name. Default is unset. 
00281                 phase            Input phase image file name. Default is unset. 
00282                 
00283         --------------------------------------------------------------------------------
00284                       
00285         """
00286         return _imagepol.imagepol_makecomplex(self, *args, **kwargs)
00287 
00288     def open(self, *args, **kwargs):
00289         """
00290         open(self, image=initialize_variant("")) -> bool
00291 
00292         Summary
00293                 Open a new image with this imagepol tool
00294 
00295         Input Parameters:
00296                 image            image file name or image record (generated by ia.torecord()) 
00297                 
00298         --------------------------------------------------------------------------------
00299                       
00300         """
00301         return _imagepol.imagepol_open(self, *args, **kwargs)
00302 
00303     def pol(self, *args, **kwargs):
00304         """
00305         pol(self, which, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00306 
00307         Summary
00308                 Polarized quantities
00309 
00310         Input Parameters:
00311                 which            Specify operation. One of 'lpi', 'tpi', 'lppa', 'flp', 'ftp' (case insensitive) 
00312                 debias           Debias the polarized intensity ? false 
00313                 clip             Clip level for auto-sigma determination 10.0 
00314                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00315                 outfile          Output image file name. Default is unset. 
00316                 
00317         --------------------------------------------------------------------------------
00318                       
00319         """
00320         return _imagepol.imagepol_pol(self, *args, **kwargs)
00321 
00322     def rotationmeasure(self, *args, **kwargs):
00323         """
00324         rotationmeasure(self, rm=string(""), rmerr=string(""), pa0=string(""), pa0err=string(""), nturns=string(""), 
00325             chisq=string(""), sigma=-1, rmfg=0.0, rmmax=0.0, maxpaerr=1e30, plotter=string(""), 
00326             nx=5, ny=5) -> bool
00327 
00328         Summary
00329                 Find Rotation Measure (traditional approach)
00330 
00331         Input Parameters:
00332                 rm               Output Rotation Measure image file name. Default is unset. 
00333                 rmerr            Output Rotation Measure error image file name. Default is unset. 
00334                 pa0              Output position angle (degrees) at zero wavelength image file name. Default is unset. 
00335                 pa0err           Output position angle (degrees) at zero wavelength error image file name. Default is unset. 
00336                 nturns           Output number of turns image file name. Default is unset. 
00337                 chisq            Output reduced chi squared image file name. Default is unset. 
00338                 sigma            Estimate of the thermal noise. Default is auto estimate. -1 
00339                 rmfg             Foreground Rotation Measure (rad/m/m) to subtract 0.0 
00340                 rmmax            Maximum Rotation Measure (rad/m/m) to solve for 0.0 
00341                 maxpaerr         Maximum input position angle error (degrees) to allow 1e30 
00342                 plotter          Name of plotter. Default is none. 
00343                 nx               Number of plots in x direction 5 
00344                 ny               Number of plots in y direction 5 
00345                 
00346         --------------------------------------------------------------------------------
00347                       
00348         """
00349         return _imagepol.imagepol_rotationmeasure(self, *args, **kwargs)
00350 
00351     def sigma(self, clip=10.0):
00352         """
00353         sigma(self, clip=10.0) -> double
00354 
00355         Summary
00356                 Find best guess at thermal noise
00357 
00358         Input Parameters:
00359                 clip             Clip level for auto-sigma determination 10.0 
00360                 
00361         --------------------------------------------------------------------------------
00362                       
00363         """
00364         return _imagepol.imagepol_sigma(self, clip)
00365 
00366     def sigmadepolratio(self, *args, **kwargs):
00367         """
00368         sigmadepolratio(self, infile, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00369 
00370         Summary
00371                 Error in linear depolarization ratio
00372 
00373         Input Parameters:
00374                 infile           Other image. Required input. 
00375                 debias           Debias the linearly polarized intensity ? false 
00376                 clip             Clip level for auto-sigma determination 10.0 
00377                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00378                 outfile          Output image file name. Default is unset. 
00379                 
00380         --------------------------------------------------------------------------------
00381                       
00382         """
00383         return _imagepol.imagepol_sigmadepolratio(self, *args, **kwargs)
00384 
00385     def sigmafraclinpol(self, *args, **kwargs):
00386         """
00387         sigmafraclinpol(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00388 
00389         Summary
00390                 Error in fractional linear polarization
00391 
00392         Input Parameters:
00393                 clip             Clip level for auto-sigma determination 10.0 
00394                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00395                 outfile          Output image file name. Default is unset. 
00396                 
00397         --------------------------------------------------------------------------------
00398                       
00399         """
00400         return _imagepol.imagepol_sigmafraclinpol(self, *args, **kwargs)
00401 
00402     def sigmafractotpol(self, *args, **kwargs):
00403         """
00404         sigmafractotpol(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00405 
00406         Summary
00407                 Error in fractional total polarization
00408 
00409         Input Parameters:
00410                 clip             Clip level for auto-sigma determination 10.0 
00411                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00412                 outfile          Output image file name. Default is unset. 
00413                 
00414         --------------------------------------------------------------------------------
00415                       
00416         """
00417         return _imagepol.imagepol_sigmafractotpol(self, *args, **kwargs)
00418 
00419     def sigmalinpolint(self, *args, **kwargs):
00420         """
00421         sigmalinpolint(self, clip=10.0, sigma=-1, outfile=string("")) -> double
00422 
00423         Summary
00424                 Error in linearly polarized intensity
00425 
00426         Input Parameters:
00427                 clip             Clip level for auto-sigma determination 10.0 
00428                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00429                 outfile          Output image file name. Default is unset. 
00430                 
00431         --------------------------------------------------------------------------------
00432                       
00433         """
00434         return _imagepol.imagepol_sigmalinpolint(self, *args, **kwargs)
00435 
00436     def sigmalinpolposang(self, *args, **kwargs):
00437         """
00438         sigmalinpolposang(self, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00439 
00440         Summary
00441                 Error in linearly polarized position angle
00442 
00443         Input Parameters:
00444                 clip             Clip level for auto-sigma determination 10.0 
00445                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00446                 outfile          Output image file name. Default is unset. 
00447                 
00448         --------------------------------------------------------------------------------
00449                       
00450         """
00451         return _imagepol.imagepol_sigmalinpolposang(self, *args, **kwargs)
00452 
00453     def sigmastokes(self, *args, **kwargs):
00454         """
00455         sigmastokes(self, which, clip=10.0) -> double
00456 
00457         Summary
00458                 Find standard deviation of specified Stokes data
00459 
00460         Input Parameters:
00461                 which            Must specify Stokes parameter. One of 'I', 'Q', 'U', 'V' (case insensitive) 
00462                 clip             Clip level for auto-sigma determination 10.0 
00463                 
00464         --------------------------------------------------------------------------------
00465                       
00466         """
00467         return _imagepol.imagepol_sigmastokes(self, *args, **kwargs)
00468 
00469     def sigmastokesi(self, clip=10.0):
00470         """
00471         sigmastokesi(self, clip=10.0) -> double
00472 
00473         Summary
00474                 Find standard deviation of Stokes I data
00475 
00476         Input Parameters:
00477                 clip             Clip level for auto-sigma determination 10.0 
00478                 
00479         --------------------------------------------------------------------------------
00480                       
00481         """
00482         return _imagepol.imagepol_sigmastokesi(self, clip)
00483 
00484     def sigmastokesq(self, clip=10.0):
00485         """
00486         sigmastokesq(self, clip=10.0) -> double
00487 
00488         Summary
00489                 Find standard deviation of Stokes Q data
00490 
00491         Input Parameters:
00492                 clip             Clip level for auto-sigma determination 10.0 
00493                 
00494         --------------------------------------------------------------------------------
00495                       
00496         """
00497         return _imagepol.imagepol_sigmastokesq(self, clip)
00498 
00499     def sigmastokesu(self, clip=10.0):
00500         """
00501         sigmastokesu(self, clip=10.0) -> double
00502 
00503         Summary
00504                 Find standard deviation of Stokes U data
00505 
00506         Input Parameters:
00507                 clip             Clip level for auto-sigma determination 10.0 
00508                 
00509         --------------------------------------------------------------------------------
00510                       
00511         """
00512         return _imagepol.imagepol_sigmastokesu(self, clip)
00513 
00514     def sigmastokesv(self, clip=10.0):
00515         """
00516         sigmastokesv(self, clip=10.0) -> double
00517 
00518         Summary
00519                 Find standard deviation of Stokes V data
00520 
00521         Input Parameters:
00522                 clip             Clip level for auto-sigma determination 10.0 
00523                 
00524         --------------------------------------------------------------------------------
00525                       
00526         """
00527         return _imagepol.imagepol_sigmastokesv(self, clip)
00528 
00529     def sigmatotpolint(self, *args, **kwargs):
00530         """
00531         sigmatotpolint(self, clip=10.0, sigma=-1) -> double
00532 
00533         Summary
00534                 Error in total polarized intensity
00535 
00536         Input Parameters:
00537                 clip             Clip level for auto-sigma determination 10.0 
00538                 sigma            Standard deviation of thermal noise. Default is auto determined. -1 
00539                 
00540         --------------------------------------------------------------------------------
00541                       
00542         """
00543         return _imagepol.imagepol_sigmatotpolint(self, *args, **kwargs)
00544 
00545     def stokes(self, *args, **kwargs):
00546         """
00547         stokes(self, which, outfile=string("")) -> casac::image *
00548 
00549         Summary
00550                 Stokes
00551 
00552         Input Parameters:
00553                 which            Must specify Stokes. One of 'I', 'Q', 'U', 'V' (case insensitive) 
00554                 outfile          Output image file name. Default is unset. 
00555                 
00556         --------------------------------------------------------------------------------
00557                       
00558         """
00559         return _imagepol.imagepol_stokes(self, *args, **kwargs)
00560 
00561     def stokesi(self, *args, **kwargs):
00562         """
00563         stokesi(self, outfile=string("")) -> casac::image *
00564 
00565         Summary
00566                 Stokes I
00567 
00568         Input Parameters:
00569                 outfile          Output image file name. Default is unset. 
00570                 
00571         --------------------------------------------------------------------------------
00572                       
00573         """
00574         return _imagepol.imagepol_stokesi(self, *args, **kwargs)
00575 
00576     def stokesq(self, *args, **kwargs):
00577         """
00578         stokesq(self, outfile=string("")) -> casac::image *
00579 
00580         Summary
00581                 Stokes Q
00582 
00583         Input Parameters:
00584                 outfile          Output image file name. Default is unset. 
00585                 
00586         --------------------------------------------------------------------------------
00587                       
00588         """
00589         return _imagepol.imagepol_stokesq(self, *args, **kwargs)
00590 
00591     def stokesu(self, *args, **kwargs):
00592         """
00593         stokesu(self, outfile=string("")) -> casac::image *
00594 
00595         Summary
00596                 Stokes U
00597 
00598         Input Parameters:
00599                 outfile          Output image file name. Default is unset. 
00600                 
00601         --------------------------------------------------------------------------------
00602                       
00603         """
00604         return _imagepol.imagepol_stokesu(self, *args, **kwargs)
00605 
00606     def stokesv(self, *args, **kwargs):
00607         """
00608         stokesv(self, outfile=string("")) -> casac::image *
00609 
00610         Summary
00611                 Stokes V
00612 
00613         Input Parameters:
00614                 outfile          Output image file name. Default is unset. 
00615                 
00616         --------------------------------------------------------------------------------
00617                       
00618         """
00619         return _imagepol.imagepol_stokesv(self, *args, **kwargs)
00620 
00621     def summary(self):
00622         """
00623         summary(self) -> bool
00624 
00625         Summary
00626                 Summarise Imagepol tool
00627         --------------------------------------------------------------------------------
00628                       
00629         """
00630         return _imagepol.imagepol_summary(self)
00631 
00632     def totpolint(self, *args, **kwargs):
00633         """
00634         totpolint(self, debias=False, clip=10.0, sigma=-1, outfile=string("")) -> casac::image *
00635 
00636         Summary
00637                 Total polarized intensity
00638 
00639         Input Parameters:
00640                 debias           Debias the total polarized intensity ? false 
00641                 clip             Clip level for auto-sigma determination 10.0 
00642                 sigma            Standard deviation of thermal noised. Default is auto determined. -1 
00643                 outfile          Output image file name. Default is unset. 
00644                 
00645         --------------------------------------------------------------------------------
00646                       
00647         """
00648         return _imagepol.imagepol_totpolint(self, *args, **kwargs)
00649 
00650 imagepol_swigregister = _imagepol.imagepol_swigregister
00651 imagepol_swigregister(imagepol)
00652 
00653 # This file is compatible with both classic and new-style classes.
00654 
00655