|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
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('_image', [dirname(__file__)]) 00017 except ImportError: 00018 import _image 00019 return _image 00020 if fp is not None: 00021 try: 00022 _mod = imp.load_module('_image', fp, pathname, description) 00023 finally: 00024 fp.close() 00025 return _mod 00026 _image = swig_import_helper() 00027 del swig_import_helper 00028 else: 00029 import _image 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 image(_object): 00071 """Proxy of C++ casac::image class""" 00072 __swig_setmethods__ = {} 00073 __setattr__ = lambda self, name, value: _swig_setattr(self, image, name, value) 00074 __swig_getmethods__ = {} 00075 __getattr__ = lambda self, name: _swig_getattr(self, image, name) 00076 __repr__ = _swig_repr 00077 def __init__(self): 00078 """__init__(self) -> image""" 00079 this = _image.new_image() 00080 try: self.this.append(this) 00081 except: self.this = this 00082 __swig_destroy__ = _image.delete_image 00083 __del__ = lambda self : None; 00084 def newimage(self, *args, **kwargs): 00085 """ 00086 newimage(self, infile) -> image 00087 00088 Summary 00089 Construct a new image analysis tool using the specified image. 00090 (Also known as newimagefromfile.) 00091 00092 Input Parameters: 00093 infile Input image file name 00094 00095 -------------------------------------------------------------------------------- 00096 00097 """ 00098 return _image.image_newimage(self, *args, **kwargs) 00099 00100 def newimagefromfile(self, *args, **kwargs): 00101 """ 00102 newimagefromfile(self, infile) -> image 00103 00104 Summary 00105 Construct a new image analysis tool using the specified image. 00106 (Also known as newimage.) 00107 00108 Input Parameters: 00109 infile Input image file name 00110 00111 -------------------------------------------------------------------------------- 00112 00113 """ 00114 return _image.image_newimagefromfile(self, *args, **kwargs) 00115 00116 def imagecalc(self, *args, **kwargs): 00117 """ 00118 imagecalc(self, outfile=string(""), pixels=string(""), overwrite=False) -> image 00119 00120 Summary 00121 Perform mathematical calculations on an image or images. 00122 00123 Input Parameters: 00124 outfile Output image file name. If blank the resulting image is not written, but it can still be accessed via the returned image analysis tool. 00125 pixels LEL expression. Must be specified. For example 'myimage1.im + myimage2.im'. 00126 overwrite Overwrite (unprompted) pre-existing output file? false 00127 00128 -------------------------------------------------------------------------------- 00129 00130 """ 00131 return _image.image_imagecalc(self, *args, **kwargs) 00132 00133 def collapse(self, *args, **kwargs): 00134 """ 00135 collapse(self, function=string(""), axes=initialize_variant("0"), outfile=string(""), region=initialize_variant(""), 00136 box=string(""), chans=string(""), stokes=string(""), mask=string(""), 00137 overwrite=False, stretch=False) -> image 00138 00139 Summary 00140 Collapse image along specified axis, computing aggregate function of pixels along that axis. 00141 00142 Input Parameters: 00143 function Aggregate function to apply: max, mean, median, min, rms, stdev, sum, variance. 00144 axes Zero-based axis number along which to collapse image. 0 00145 outfile Output image file name. If blank, no image is written but a new image tool referencing the collapsed image is returned. 00146 region Region specification. See help par.region. Default is to use the full image. 00147 box Box to use in position plane specified by four numbers 'blcx, blcy, trcx, trcy' 00148 chans Channels to use. Channels must be contigous. Default is to use all channels. 00149 stokes Stokes planes to use. Planes must be contiguous. Default is to use all stokes. 00150 mask Mask to use. See help par.mask. Default is none. 00151 overwrite Overwrite (unprompted) pre-existing output file? Ignored if outfile is blank. false 00152 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 00153 00154 -------------------------------------------------------------------------------- 00155 00156 """ 00157 return _image.image_collapse(self, *args, **kwargs) 00158 00159 def imageconcat(self, *args, **kwargs): 00160 """ 00161 imageconcat(self, outfile=string(""), infiles=initialize_variant(""), axis=-1, relax=False, tempclose=True, 00162 overwrite=False) -> image 00163 00164 Summary 00165 Construct a casa image by concatenating images 00166 00167 Input Parameters: 00168 outfile Output image file name. Default is unset. 00169 infiles List of input \casa\ image files to concatenate; wild cards accepted. Default is empty string. 00170 axis Concatenation pixel axis. Use ia.coordsys().names() to get a list of axes. A negative value means use the spectral axis if there is one, if not an exception is thrown. -1 00171 relax Relax constraints that axis coordinate descriptors match false 00172 tempclose Keep all lattices closed until needed true 00173 overwrite Overwrite (unprompted) pre-existing output file? false 00174 00175 -------------------------------------------------------------------------------- 00176 00177 """ 00178 return _image.image_imageconcat(self, *args, **kwargs) 00179 00180 def fromarray(self, *args, **kwargs): 00181 """ 00182 fromarray(self, outfile=string(""), pixels=initialize_variant(""), csys=initialize_record(""), linear=False, 00183 overwrite=False, log=True) -> bool 00184 00185 Summary 00186 Construct a casa image from a numerical (integer or float) array 00187 00188 Input Parameters: 00189 outfile Output image file name. Default is unset. 00190 pixels Numeric array 00191 csys Coordinate System. Default is unset. 00192 linear Make a linear Coordinate System if csys not given false 00193 overwrite Overwrite (unprompted) pre-existing output file? false 00194 log Write image creation messages to logger true 00195 00196 -------------------------------------------------------------------------------- 00197 00198 """ 00199 return _image.image_fromarray(self, *args, **kwargs) 00200 00201 def fromascii(self, *args, **kwargs): 00202 """ 00203 fromascii(self, outfile=string(""), infile=string(""), shape=initialize_vector(1, (int)-1), sep=string(":"), 00204 csys=initialize_record(""), linear=False, overwrite=False) -> bool 00205 00206 Summary 00207 This function converts a pre-existing ascii file into a casa image. 00208 00209 Input Parameters: 00210 outfile Output image file name. Default is unset. 00211 infile Input ascii disk file name. Must be specified.. 00212 shape Shape of image. Must be specified. -1 00213 sep Separator in ascii file. Default is space character. : 00214 csys Coordinate System record from coordsys torecord(). Default is unset. 00215 linear Make a linear Coordinate System if csys not given false 00216 overwrite Overwrite (unprompted) pre-existing output file? false 00217 00218 -------------------------------------------------------------------------------- 00219 00220 """ 00221 return _image.image_fromascii(self, *args, **kwargs) 00222 00223 def fromfits(self, *args, **kwargs): 00224 """ 00225 fromfits(self, outfile=string(""), infile=string(""), whichrep=0, whichhdu=0, zeroblanks=False, 00226 overwrite=False) -> bool 00227 00228 Summary 00229 Construct a casa image by conversion from a FITS image file 00230 00231 Input Parameters: 00232 outfile Output image file name. Default is unset. 00233 infile Input FITS disk file name. Must be specified. 00234 whichrep If this FITS file contains multiple coordinate representations, which one should we read (0-based) 0 00235 whichhdu If this FITS file contains multiple images, which one should we read (0-based). 0 00236 zeroblanks If there are blanked pixels, set them to zero instead of NaN false 00237 overwrite Overwrite (unprompted) pre-existing output file? false 00238 00239 -------------------------------------------------------------------------------- 00240 00241 """ 00242 return _image.image_fromfits(self, *args, **kwargs) 00243 00244 def fromimage(self, *args, **kwargs): 00245 """ 00246 fromimage(self, outfile=string(""), infile=string(""), region=initialize_record(""), mask=initialize_variant(""), 00247 dropdeg=False, overwrite=False) -> bool 00248 00249 Summary 00250 Construct a (sub)image from a region of a casa image 00251 00252 Input Parameters: 00253 outfile Output sub-image file name. Default is unset. 00254 infile Input image file name. Must be specified. 00255 region The region of interest. Default is whole image. 00256 mask Mask to use. See help par.mask. Default is none. 00257 dropdeg Drop degenerate axes false 00258 overwrite Overwrite (unprompted) pre-existing output file? false 00259 00260 -------------------------------------------------------------------------------- 00261 00262 """ 00263 return _image.image_fromimage(self, *args, **kwargs) 00264 00265 def fromshape(self, *args, **kwargs): 00266 """ 00267 fromshape(self, outfile=string(""), shape=initialize_vector(1, (int)0), csys=initialize_record(""), 00268 linear=False, overwrite=False, log=True) -> bool 00269 00270 Summary 00271 Construct an empty casa image from a shape 00272 00273 Input Parameters: 00274 outfile Name of output image file. Default is unset. 00275 shape Shape of image. Must be specified. 0 00276 csys Coordinate System. Default is unset. 00277 linear Make a linear Coordinate System if csys not given? false 00278 overwrite Overwrite (unprompted) pre-existing output file? false 00279 log Write image creation messages to logger true 00280 00281 -------------------------------------------------------------------------------- 00282 00283 """ 00284 return _image.image_fromshape(self, *args, **kwargs) 00285 00286 def maketestimage(self, *args, **kwargs): 00287 """ 00288 maketestimage(self, outfile=string(""), overwrite=False) -> bool 00289 00290 Summary 00291 Construct a casa image from a test FITS file 00292 00293 00294 Input Parameters: 00295 outfile Output image file name. Default is unset. 00296 overwrite Overwrite (unprompted) pre-existing output file? false 00297 00298 -------------------------------------------------------------------------------- 00299 00300 """ 00301 return _image.image_maketestimage(self, *args, **kwargs) 00302 00303 def adddegaxes(self, *args, **kwargs): 00304 """ 00305 adddegaxes(self, outfile=string(""), direction=False, spectral=False, stokes=string(""), linear=False, 00306 tabular=False, overwrite=False) -> image 00307 00308 Summary 00309 Add degenerate axes of the specified type to the image 00310 00311 Input Parameters: 00312 outfile Output image file name. Default is unset. 00313 direction Add direction axes? false 00314 spectral Add spectral axis? false 00315 stokes Add Stokes axis? Default is empty string. 00316 linear Add linear axis? false 00317 tabular Add tabular axis? false 00318 overwrite Overwrite (unprompted) pre-existing output file? false 00319 00320 -------------------------------------------------------------------------------- 00321 00322 """ 00323 return _image.image_adddegaxes(self, *args, **kwargs) 00324 00325 def addnoise(self, *args, **kwargs): 00326 """ 00327 addnoise(self, type=string("normal"), pars=initialize_vector(2,(double)0.0, (double)1.0), region=initialize_record(""), 00328 zero=False) -> bool 00329 00330 Summary 00331 Add noise to the image 00332 00333 Input Parameters: 00334 type Type of distribution, normal normal 00335 pars Parameters of distribution 0.0 1.0 00336 region Region of interest. Default is whole image. 00337 zero Zero image first? false 00338 00339 -------------------------------------------------------------------------------- 00340 00341 """ 00342 return _image.image_addnoise(self, *args, **kwargs) 00343 00344 def convolve(self, *args, **kwargs): 00345 """ 00346 convolve(self, outfile=string(""), kernel=initialize_variant(""), scale=-1.0, region=initialize_record(""), 00347 mask=initialize_variant(""), overwrite=False, stretch=False, async=False) -> image 00348 00349 Summary 00350 Convolve image with an array or another image 00351 00352 Input Parameters: 00353 outfile Output image file name. Default is unset. 00354 kernel Convolution kernel - array or image filename. Must be specified. 00355 scale Scale factor. Default is autoscale. -1.0 00356 region Region of interest. Default is whole image. 00357 mask Mask to use. See help par.mask. Default is none. 00358 overwrite Overwrite (unprompted) pre-existing output file? false 00359 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00360 async Run asynchronously? false 00361 00362 -------------------------------------------------------------------------------- 00363 00364 """ 00365 return _image.image_convolve(self, *args, **kwargs) 00366 00367 def boundingbox(self, *args, **kwargs): 00368 """ 00369 boundingbox(self, region=initialize_record("")) -> record * 00370 00371 Summary 00372 Get the bounding box of the specified region 00373 00374 Input Parameters: 00375 region The region of interest. Default is whole image. 00376 00377 -------------------------------------------------------------------------------- 00378 00379 """ 00380 return _image.image_boundingbox(self, *args, **kwargs) 00381 00382 def brightnessunit(self): 00383 """ 00384 brightnessunit(self) -> string 00385 00386 Summary 00387 Get the image brightness unit 00388 -------------------------------------------------------------------------------- 00389 00390 """ 00391 return _image.image_brightnessunit(self) 00392 00393 def calc(self, *args, **kwargs): 00394 """ 00395 calc(self, pixels) -> bool 00396 00397 Summary 00398 Image calculator 00399 00400 Input Parameters: 00401 pixels LEL expression 00402 00403 -------------------------------------------------------------------------------- 00404 00405 """ 00406 return _image.image_calc(self, *args, **kwargs) 00407 00408 def calcmask(self, *args, **kwargs): 00409 """ 00410 calcmask(self, mask=string(""), name=string(""), asdefault=True) -> bool 00411 00412 Summary 00413 Image mask calculator 00414 00415 Input Parameters: 00416 mask Mask to use. See help par.mask. Default is none. 00417 name Mask name. Default is auto new name. 00418 asdefault Make specified mask the default mask? true 00419 00420 -------------------------------------------------------------------------------- 00421 00422 """ 00423 return _image.image_calcmask(self, *args, **kwargs) 00424 00425 def close(self): 00426 """ 00427 close(self) -> bool 00428 00429 Summary 00430 Close the image tool 00431 -------------------------------------------------------------------------------- 00432 00433 """ 00434 return _image.image_close(self) 00435 00436 def continuumsub(self, *args, **kwargs): 00437 """ 00438 continuumsub(self, outline=string(""), outcont=string("continuumsub.im"), region=initialize_record(""), 00439 channels=initialize_vector(1, (int)-1), pol=string(""), fitorder=0, overwrite=False) -> image 00440 00441 Summary 00442 Image plane continuum subtraction 00443 00444 Input Parameters: 00445 outline Output line image filename. Default is unset. 00446 outcont Output continuum image filename continuumsub.im 00447 region Region over which output is desired. Default is whole image. 00448 channels Channels to use for continuum estimation. Default is all. -1 00449 pol Polarization to process. String from 'I Q U V XX RR' etc. Default is unset. I Q U V XX RR 00450 fitorder Polynomial order for continuum estimation 0 00451 overwrite Auto-overwrite output files if they exist? false 00452 00453 -------------------------------------------------------------------------------- 00454 00455 """ 00456 return _image.image_continuumsub(self, *args, **kwargs) 00457 00458 def convertflux(self, *args, **kwargs): 00459 """ 00460 convertflux(self, value=initialize_variant("0Jy/beam"), major=initialize_variant("1arcsec"), minor=initialize_variant("1arcsec"), 00461 type=string("Gaussian"), topeak=True, channel=-1, 00462 polarization=-1) -> record * 00463 00464 Summary 00465 Convert flux density between peak and integral 00466 00467 Input Parameters: 00468 value Flux density to convert. Must be specified. 0Jy/beam 00469 major Major axis of component. Must be specified. 1arcsec 00470 minor Minor axis of component. Must be specified. 1arcsec 00471 type Type of component. String from Gaussian, Disk. Gaussian 00472 topeak Convert to peak or integral flux desnity true 00473 channel Channel to use if and only if image has per plane beams. -1 00474 polarization Zero-based polarization number to use for beam if and only if image has per plane beams. -1 00475 00476 -------------------------------------------------------------------------------- 00477 00478 """ 00479 return _image.image_convertflux(self, *args, **kwargs) 00480 00481 def convolve2d(self, *args, **kwargs): 00482 """ 00483 convolve2d(self, outfile=string(""), axes=initialize_vector(2,(int)0, (int)1), type=string("gaussian"), 00484 major=initialize_variant("0deg"), minor=initialize_variant("0deg"), pa=initialize_variant("0deg"), 00485 scale=-1, region=initialize_record(""), mask=initialize_variant(""), 00486 overwrite=False, stretch=False, targetres=False, beam=initialize_record("")) -> image 00487 00488 Summary 00489 Convolve image by a 2D kernel 00490 00491 Input Parameters: 00492 outfile Output image file name. Default is unset. 00493 axes Axes to convolve. Default is [0,1]. 01 00494 type Type of convolution kernel gaussian 00495 major Major axis, Quantity, string, numeric. Must be specified. 0deg 00496 minor Minor axis, Quantity, string, numeric. Must be specified. 0deg 00497 pa Position Angle, Quantity, string, numeric. Default is 0deg. 0deg 00498 scale Scale factor. Default is autoscale. -1 00499 region Region of interest. Default is whole image. 00500 mask Mask to use. See help par.mask. Default is none. 00501 overwrite Overwrite (unprompted) pre-existing output file? false 00502 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00503 targetres If True and type='gaussian', major, minor, and pa are interpreted as the image resolution that the user wants to achieve. false 00504 beam Alternate way of describing a Gaussian. Must have fields 'major', 'minor', and 'pa' (or 'positionangle') 00505 00506 -------------------------------------------------------------------------------- 00507 00508 """ 00509 return _image.image_convolve2d(self, *args, **kwargs) 00510 00511 def coordsys(self, *args, **kwargs): 00512 """ 00513 coordsys(self, axes=initialize_vector(1, (int)-1)) -> casac::coordsys * 00514 00515 Summary 00516 Get the Coordinate System of the image 00517 00518 Input Parameters: 00519 axes Axes to which the Coordinate System pertains. Default is all axes. -1 00520 00521 -------------------------------------------------------------------------------- 00522 00523 """ 00524 return _image.image_coordsys(self, *args, **kwargs) 00525 00526 def coordmeasures(self, *args, **kwargs): 00527 """ 00528 coordmeasures(self, pixel=initialize_vector(1, (double)-1)) -> record * 00529 00530 Summary 00531 Convert from pixel to world coordinate wrapped as Measures 00532 00533 Input Parameters: 00534 pixel Absolute pixel coordinate. Default is reference pixel. -1 00535 00536 -------------------------------------------------------------------------------- 00537 00538 """ 00539 return _image.image_coordmeasures(self, *args, **kwargs) 00540 00541 def decompose(self, *args, **kwargs): 00542 """ 00543 decompose(self, region=initialize_record(""), mask=initialize_variant(""), simple=False, threshold=-1, 00544 ncontour=11, minrange=1, naxis=2, fit=True, maxrms=-1, maxretry=-1, maxiter=256, 00545 convcriteria=0.0001, stretch=False) -> record * 00546 00547 Summary 00548 Separate a complex image into individual components 00549 00550 Input Parameters: 00551 region Region of interest. Default is unset. 00552 mask Mask to use. See help par.mask. Default is none. 00553 simple Skip contour deblending and scan for local maxima false 00554 threshold Value of minimum positive contour. Must be set and nonnegative. -1 00555 ncontour Number of contours to use in deblending (>= 2) 11 00556 minrange Minimum number of closed contours in a component (> 0) 1 00557 naxis Max number of perpendicular steps between contiguous pixels. Values of 1, 2 or 3 are allowed. 2 00558 fit Fit to the components after deblending? true 00559 maxrms Maximum RMS of fit residuals to not retry fit (> 0). Default is unset. -1 00560 maxretry Maximum number of times to retry the fit (>= 0). Default is unset. -1 00561 maxiter Maximum number of iterations allowed in a single fit (> 0) 256 00562 convcriteria Criterion to establish convergence (>=0) 0.0001 00563 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00564 00565 -------------------------------------------------------------------------------- 00566 00567 """ 00568 return _image.image_decompose(self, *args, **kwargs) 00569 00570 def deconvolvecomponentlist(self, *args, **kwargs): 00571 """ 00572 deconvolvecomponentlist(self, complist, channel=-1, polarization=-1) -> record * 00573 00574 Summary 00575 Deconvolve a componentlist from the restoring beam 00576 00577 Input Parameters: 00578 complist Componentlist to deconvolve 00579 channel Zero-based channel number to use for beam for per plane images. Not used if the image has a single beam. -1 00580 polarization Zero-based polarization number to use for beam for per plane images. Not used if the image has a single beam. -1 00581 00582 -------------------------------------------------------------------------------- 00583 00584 """ 00585 return _image.image_deconvolvecomponentlist(self, *args, **kwargs) 00586 00587 def deconvolvefrombeam(self, *args, **kwargs): 00588 """ 00589 deconvolvefrombeam(self, source=initialize_variant(""), beam=initialize_variant("")) -> record * 00590 00591 Summary 00592 Helper function to deconvolve the given source Gaussian 00593 from a beam Gaussian to return a model Gaussian 00594 00595 00596 Input Parameters: 00597 source Three quantities that define the source majoraxis, minoraxis and Position angle 00598 beam Three quantities that define the beam majoraxis, minoraxis and Position angle 00599 00600 -------------------------------------------------------------------------------- 00601 00602 """ 00603 return _image.image_deconvolvefrombeam(self, *args, **kwargs) 00604 00605 def remove(self, done=False, verbose=True): 00606 """ 00607 remove(self, done=False, verbose=True) -> bool 00608 00609 Summary 00610 Delete the image file associated with this image tool 00611 00612 Input Parameters: 00613 done Destroy this tool after deletion false 00614 verbose Send a progress report to the logger. true 00615 00616 -------------------------------------------------------------------------------- 00617 00618 """ 00619 return _image.image_remove(self, done, verbose) 00620 00621 def removefile(self, *args, **kwargs): 00622 """ 00623 removefile(self, file) -> bool 00624 00625 Summary 00626 Delete an unattached image file from disk. 00627 Note: use remove() if the image file is attached to the image tool. 00628 00629 00630 Input Parameters: 00631 file Name of image file/directory to be removed. Must be specified. 00632 00633 -------------------------------------------------------------------------------- 00634 00635 """ 00636 return _image.image_removefile(self, *args, **kwargs) 00637 00638 def done(self, remove=False, verbose=True): 00639 """ 00640 done(self, remove=False, verbose=True) -> bool 00641 00642 Summary 00643 Destroy this image tool 00644 00645 Input Parameters: 00646 remove Delete disk file as well? false 00647 verbose Send a progress report to the logger. true 00648 00649 -------------------------------------------------------------------------------- 00650 00651 """ 00652 return _image.image_done(self, remove, verbose) 00653 00654 def fft(self, *args, **kwargs): 00655 """ 00656 fft(self, real=string(""), imag=string(""), amp=string(""), phase=string(""), axes=initialize_vector(1, (int)-1), 00657 region=initialize_record(""), mask=initialize_variant(""), 00658 stretch=False) -> bool 00659 00660 Summary 00661 FFT the image 00662 00663 Input Parameters: 00664 real Output real image file name 00665 imag Output imaginary image file name 00666 amp Output amplitude image file name 00667 phase Output phase image file name 00668 axes Specify pixel axes to FFT. Default is sky plane(s). -1 00669 region The region of interest. Default is whole image. 00670 mask Mask to use. See help par.mask. Default is none. 00671 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00672 00673 -------------------------------------------------------------------------------- 00674 00675 """ 00676 return _image.image_fft(self, *args, **kwargs) 00677 00678 def findsources(self, *args, **kwargs): 00679 """ 00680 findsources(self, nmax=20, cutoff=0.1, region=initialize_record(""), mask=initialize_variant(""), point=True, 00681 width=5, negfind=False) -> record * 00682 00683 Summary 00684 Find point sources in the sky 00685 00686 Input Parameters: 00687 nmax Maximum number of sources to find, > 0 20 00688 cutoff Fractional cutoff level 0.1 00689 region The 2-D region of interest to fit. Default is whole image. 00690 mask Mask to use. See help par.mask. Default is none. 00691 point Find only point sources? true 00692 width Half-width of fit grid when point=F 5 00693 negfind Find negative sources as well as positive? false 00694 00695 -------------------------------------------------------------------------------- 00696 00697 """ 00698 return _image.image_findsources(self, *args, **kwargs) 00699 00700 def fitprofile(self, *args, **kwargs): 00701 """ 00702 fitprofile(self, box=string(""), region=initialize_variant(""), chans=string(""), stokes=string(""), 00703 axis=-1, mask=initialize_variant(""), ngauss=1, poly=-1, estimates=string(""), 00704 minpts=0, multifit=False, model=string(""), residual=string(""), amp=string(""), 00705 amperr=string(""), center=string(""), centererr=string(""), fwhm=string(""), 00706 fwhmerr=string(""), integral=string(""), integralerr=string(""), 00707 stretch=False, logresults=True, pampest=initialize_variant(""), pcenterest=initialize_variant(""), 00708 pfwhmest=initialize_variant(""), pfix=initialize_variant(""), 00709 gmncomps=initialize_variant("0"), gmampcon=initialize_variant(""), 00710 gmcentercon=initialize_variant(""), gmfwhmcon=initialize_variant(""), 00711 gmampest=initialize_vector(1, (double)0.0), gmcenterest=initialize_vector(1, (double)0.0), 00712 gmfwhmest=initialize_vector(1, (double)0.0), gmfix=initialize_variant(""), 00713 logfile=string(""), append=True, pfunc=initialize_variant(""), 00714 goodamprange=initialize_vector(1, (double)0.0), goodcenterrange=initialize_vector(1, (double)0.0), 00715 goodfwhmrange=initialize_vector(1, (double)0.0), 00716 sigma=initialize_variant(""), outsigma=string("")) -> record * 00717 00718 Summary 00719 Fit gaussians and/or polynomials to a 1-dimensional profile. 00720 00721 Input Parameters: 00722 box Rectangular box in direction coordinate blc, trc. Default: entire image (''). 00723 region Region name, Default: no region (''). 00724 chans Channels to use. Channels must be contigous. Default: all channels (''). 00725 stokes Stokes planes to use. Planes must be contiguous. Default: all stokes (''). 00726 axis The profile axis. Default: use the spectral axis if one exists, axis 0 otherwise (<0). -1 00727 mask Mask to use. See help par.mask. Default is none. 00728 ngauss Number of Gaussian elements. Default: 1. 1 00729 poly Order of polynomial element. Default: do not fit a polynomial (<0). -1 00730 estimates Name of file containing initial estimates. Default: No initial estimates (''). 00731 minpts Minimum number of unmasked points necessary to attempt fit. 0 00732 multifit If true, fit a profile along the desired axis at each pixel in the specified region. If false, average the non-fit axis pixels and do a single fit to that average profile. Default False. false 00733 model Name of model image. Default: do not write the model image (''). 00734 residual Name of residual image. Default: do not write the residual image (''). 00735 amp Prefix of name of amplitude solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00736 amperr Prefix of name of amplitude error solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00737 center Prefix of name of center solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00738 centererr Prefix of name of center error solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00739 fwhm Prefix of name of FWHM solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00740 fwhmerr Prefix of name of FWHM error solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00741 integral Prefix of name of integral solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00742 integralerr Prefix of name of integral error solution image. Name of image will have gaussian component number appended. Default: do not write the image (''). 00743 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00744 logresults Output results to logger? true 00745 pampest Initial estimate PCF profile amplitudes. 00746 pcenterest Initial estimate PCF profile centers, in pixels. 00747 pfwhmest Initial estimate PCF profile FWHMs, in pixels. 00748 pfix PCF parameters to fix during fit. Any combination of 'p', 'c', or 'f'. 00749 gmncomps Number of components in each gaussian multiplet to fit 0 00750 gmampcon The amplitude ratio constraints for non-reference components to reference component in gaussian multiplets. 00751 gmcentercon The center offset constraints (in pixels) for non-reference components to reference component in gaussian multiplets. 00752 gmfwhmcon The FWHM ratio constraints for non-reference components to reference component in gaussian multiplets. 00753 gmampest Initial estimate of individual gaussian amplitudes in gaussian multiplets. 0.0 00754 gmcenterest Initial estimate of individual gaussian centers in gaussian multiplets, in pixels. 0.0 00755 gmfwhmest Initial estimate of individual gaussian FWHMss in gaussian multiplets, in pixels. 0.0 00756 gmfix Parameters of individual gaussians in gaussian multiplets to fix during fit. 00757 logfile File in which to log results. Default is not to write a logfile. 00758 append Append results to logfile? Logfile must be specified. Default is to append. False means overwrite existing file if it exists. true 00759 pfunc PCF singlet functions to fit. 'gaussian' or 'lorentzian' (minimal match supported). Unspecified means all gaussians. 00760 goodamprange Acceptable amplitude solution range. [0.0] => all amplitude solutions are acceptable. 0.0 00761 goodcenterrange Acceptable center solution range in pixels relative to region start. [0.0] => all center solutions are acceptable. 0.0 00762 goodfwhmrange Acceptable FWHM solution range in pixels. [0.0] => all FWHM solutions are acceptable. 0.0 00763 sigma Standard deviation array or image name. 00764 outsigma Name of output image used for standard deviations. Ignored if sigma is empty. 00765 00766 -------------------------------------------------------------------------------- 00767 00768 """ 00769 return _image.image_fitprofile(self, *args, **kwargs) 00770 00771 def fitcomponents(self, *args, **kwargs): 00772 """ 00773 fitcomponents(self, box=string(""), region=initialize_variant(""), chans=initialize_variant(""), stokes=string(""), 00774 mask=initialize_variant(""), includepix=initialize_vector(1, (double)-1), 00775 excludepix=initialize_vector(1, (double)-1), residual=string(""), 00776 model=string(""), estimates=string(""), logfile=string(""), append=True, 00777 newestimates=string(""), complist=string(""), overwrite=False, dooff=False, 00778 offset=0.0, fixoffset=False, stretch=False) -> record * 00779 00780 Summary 00781 Fit 2-dimensional models to an image. 00782 00783 Input Parameters: 00784 box One or more boxes to use for fit region(s). Default is to use the entire plane. 00785 region The 2-D region of interest to fit. Default is entire plane. If both box and region are specified, box is used and region is not. 00786 chans The frequency planes to use in the fit. Default is 0 (first plane). 00787 stokes The polarization to use in the fit. Default is to use the first stokes plane. 00788 mask Mask to use. See help par.mask. Default is none. 00789 includepix Range of pixel values to include. Default is to include all pixels. -1 00790 excludepix Range of pixel values to exclude. Default is to exclude no pixels. -1 00791 residual Name of the residual image to write. Default is not to write the residual. 00792 model Name of the model image to write. Default is not to write the model. 00793 estimates Name of the input estimates file. Default is to auto-estimate in which case a single gaussian will be fit. 00794 logfile File in which to log results. Default is not to write a logfile. 00795 append Append results to logfile? Logfile must be specified. Default is to append. False means overwrite existing file if it exists. true 00796 newestimates File to which to write results in 'estimates' format suitable as estimates input for another run. Default is do not write an estimates file. 00797 complist Output component list table name. Default is do not write a component list table. 00798 overwrite Overwrite component list if it already exists. Default is False. false 00799 dooff Also fit a zero level offset? Default is False false 00800 offset Initial estimate of zero-level offset. Only used if doff is True. Default is 0.0 0.0 00801 fixoffset Keep the zero level offset fixed during fit? Default is False false 00802 stretch Stretch the mask if necessary and possible? See help par.stretch. false 00803 00804 -------------------------------------------------------------------------------- 00805 00806 """ 00807 return _image.image_fitcomponents(self, *args, **kwargs) 00808 00809 def fromrecord(self, *args, **kwargs): 00810 """ 00811 fromrecord(self, record, outfile=string("")) -> bool 00812 00813 Summary 00814 Generate an image from a record 00815 00816 Input Parameters: 00817 record Record containing the image 00818 outfile The name of the diskfile to be created for image from record 00819 00820 -------------------------------------------------------------------------------- 00821 00822 """ 00823 return _image.image_fromrecord(self, *args, **kwargs) 00824 00825 def getchunk(self, *args, **kwargs): 00826 """ 00827 getchunk(self, blc=initialize_vector(1, (int)-1), trc=initialize_vector(1, (int)-1), inc=initialize_vector(1, (int)1), 00828 axes=initialize_vector(1, (int)-1), list=False, dropdeg=False, 00829 getmask=False) -> variant * 00830 00831 Summary 00832 Get the pixel values from a regular region of the image into an array 00833 00834 Input Parameters: 00835 blc Bottom-Left-Corner (beginning) of pixel section. Default is start of image. -1 00836 trc Top-Right-Corner (end) of pixel section. Default is end of image. -1 00837 inc increment (stride) along axes 1 00838 axes Axes to average over. Default is none. -1 00839 list List bounding box to logger? false 00840 dropdeg Drop degenerate axes? false 00841 getmask Get the pixel mask rather than the pixel values false 00842 00843 -------------------------------------------------------------------------------- 00844 00845 """ 00846 return _image.image_getchunk(self, *args, **kwargs) 00847 00848 def getregion(self, *args, **kwargs): 00849 """ 00850 getregion(self, region=initialize_record(""), axes=initialize_vector(1, (int)-1), mask=initialize_variant(""), 00851 list=False, dropdeg=False, getmask=False, stretch=False) -> variant * 00852 00853 Summary 00854 Get pixels or mask from a region-of-interest of the image 00855 00856 Input Parameters: 00857 region The region of interest. Default is whole image. 00858 axes Axes to average over. Default is none. -1 00859 mask Mask to use. See help par.mask. Default is none. 00860 list List the bounding box to the logger false 00861 dropdeg Drop degenerate axes false 00862 getmask Get the pixel mask rather than pixel values false 00863 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 00864 00865 -------------------------------------------------------------------------------- 00866 00867 """ 00868 return _image.image_getregion(self, *args, **kwargs) 00869 00870 def getslice(self, *args, **kwargs): 00871 """ 00872 getslice(self, x, y, axes=initialize_vector(2,(int)0, (int)1), coord=initialize_vector(1, (int)-1), 00873 npts=0, method=string("linear")) -> record * 00874 00875 Summary 00876 Get 1-D slice from the image 00877 00878 Input Parameters: 00879 x Polyline x vertices in absolute pixel coordinates 00880 y Polyline y vertices in absolute pixel coordinates 00881 axes Pixel axes of plane holding slice. Default is first two axes. 01 00882 coord Specify pixel coordinate for other axes. Default is first pixel. -1 00883 npts Number of points in slice. Default is auto determination. 0 00884 method The interpolation method, String from 'nearest', 'linear', 'cubic' linear 00885 00886 -------------------------------------------------------------------------------- 00887 00888 """ 00889 return _image.image_getslice(self, *args, **kwargs) 00890 00891 def hanning(self, *args, **kwargs): 00892 """ 00893 hanning(self, outfile=string(""), region=initialize_record(""), mask=initialize_variant(""), axis=-10, 00894 drop=True, overwrite=False, async=False, stretch=False) -> image 00895 00896 Summary 00897 Convolve one axis of image with a Hanning kernel 00898 00899 Input Parameters: 00900 outfile Output image file name. Default is unset. 00901 region Dictionary (record) defining the region of interest, most often obtained from an rg tool method. Default is whole image. 00902 mask Mask to use. See help par.mask. Default is none. 00903 axis Zero based axis to convolve. ia.coordsys().names() gives the order of the axes in the image. Less than 0 means use the spectral axis if there is one, if not an exception is thrown. -10 00904 drop Drop every other pixel on output? true 00905 overwrite Overwrite (unprompted) pre-existing output file? false 00906 async Run asynchronously? false 00907 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 00908 00909 -------------------------------------------------------------------------------- 00910 00911 """ 00912 return _image.image_hanning(self, *args, **kwargs) 00913 00914 def haslock(self): 00915 """ 00916 haslock(self) -> std::vector< bool > 00917 00918 Summary 00919 Does this image have any locks set? 00920 -------------------------------------------------------------------------------- 00921 00922 """ 00923 return _image.image_haslock(self) 00924 00925 def histograms(self, *args, **kwargs): 00926 """ 00927 histograms(self, axes=initialize_vector(1, (int)-1), region=initialize_record(""), mask=initialize_variant(""), 00928 nbins=25, includepix=initialize_vector(1, (double)-1), gauss=False, 00929 cumu=False, log=False, list=True, force=False, disk=False, async=False, 00930 stretch=False) -> record * 00931 00932 Summary 00933 Compute histograms from the image 00934 00935 Input Parameters: 00936 axes List of axes to compute histograms over. Default is all axes. -1 00937 region Region of interest. Default is whole image. 00938 mask Mask to use. See help par.mask. Default is none. 00939 nbins Number of bins in histograms, > 0 25 00940 includepix Range of pixel values to include. Default is to include all pixels. -1 00941 gauss If T overlay a Gaussian on each histogram false 00942 cumu If T plot cumulative histograms, otherwise plot non-cumulatively false 00943 log If T plot the ordinate logarithmically, otherwise plot linearly false 00944 list If T then list some statistics as well true 00945 force If T then force the stored statistical accumulations to be regenerated false 00946 disk If T then force the storage image to disk false 00947 async Run asynchronously? false 00948 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 00949 00950 -------------------------------------------------------------------------------- 00951 00952 """ 00953 return _image.image_histograms(self, *args, **kwargs) 00954 00955 def history(self, list=True, browse=False): 00956 """ 00957 history(self, list=True, browse=False) -> std::vector< std::string > 00958 00959 Summary 00960 Recover and/or list the history file 00961 00962 Input Parameters: 00963 list List history to the logger? true 00964 browse Browse history with table browser? (NOT IMPLEMENTED YET!) false 00965 00966 -------------------------------------------------------------------------------- 00967 00968 """ 00969 return _image.image_history(self, list, browse) 00970 00971 def insert(self, *args, **kwargs): 00972 """ 00973 insert(self, infile=string(""), region=initialize_record(""), locate=initialize_vector(1, (double)-1)) -> image 00974 00975 Summary 00976 Insert specified image into this image 00977 00978 Input Parameters: 00979 infile Image file name. 00980 region The region of interest of the input image. Default is whole image. 00981 locate Location of input image in output image. Default is centrally located. -1 00982 00983 -------------------------------------------------------------------------------- 00984 00985 """ 00986 return _image.image_insert(self, *args, **kwargs) 00987 00988 def isopen(self): 00989 """ 00990 isopen(self) -> bool 00991 00992 Summary 00993 Is this Image tool open? 00994 -------------------------------------------------------------------------------- 00995 00996 """ 00997 return _image.image_isopen(self) 00998 00999 def ispersistent(self): 01000 """ 01001 ispersistent(self) -> bool 01002 01003 Summary 01004 Is the image persistent? 01005 -------------------------------------------------------------------------------- 01006 01007 """ 01008 return _image.image_ispersistent(self) 01009 01010 def lock(self, writelock=False, nattempts=0): 01011 """ 01012 lock(self, writelock=False, nattempts=0) -> bool 01013 01014 Summary 01015 Acquire a lock on the image 01016 01017 Input Parameters: 01018 writelock Acquire a read/write (T) or a readonly (F) lock false 01019 nattempts Number of attempts, > 0. Default is unlimiited. 0 01020 01021 -------------------------------------------------------------------------------- 01022 01023 """ 01024 return _image.image_lock(self, writelock, nattempts) 01025 01026 def makecomplex(self, *args, **kwargs): 01027 """ 01028 makecomplex(self, outfile, imag, region=initialize_record(""), overwrite=False) -> bool 01029 01030 Summary 01031 Make a complex image 01032 01033 Input Parameters: 01034 outfile Output Complex (disk) image file name 01035 imag Imaginary image file name 01036 region The region of interest. Default is whole image. 01037 overwrite Overwrite (unprompted) pre-existing output file? false 01038 01039 -------------------------------------------------------------------------------- 01040 01041 """ 01042 return _image.image_makecomplex(self, *args, **kwargs) 01043 01044 def maskhandler(self, *args, **kwargs): 01045 """ 01046 maskhandler(self, op=string("default"), name=std::vector< string >(1, "")) -> std::vector< std::string > 01047 01048 Summary 01049 Handle pixel masks 01050 01051 Input Parameters: 01052 op The operation. One of 'set', 'delete', 'rename', 'get', 'copy' or 'default' default 01053 name Name of mask or masks. 01054 01055 -------------------------------------------------------------------------------- 01056 01057 """ 01058 return _image.image_maskhandler(self, *args, **kwargs) 01059 01060 def miscinfo(self): 01061 """ 01062 miscinfo(self) -> record * 01063 01064 Summary 01065 Get the miscellaneous information record from an image 01066 -------------------------------------------------------------------------------- 01067 01068 """ 01069 return _image.image_miscinfo(self) 01070 01071 def modify(self, *args, **kwargs): 01072 """ 01073 modify(self, model, region=initialize_record(""), mask=initialize_variant(""), subtract=True, 01074 list=True, async=False, stretch=False) -> bool 01075 01076 Summary 01077 Modify image with a model 01078 01079 Input Parameters: 01080 model Record representation of a ComponentList model 01081 region The 2-D region of interest. Default is whole image. 01082 mask Mask to use. See help par.mask. Default is none. 01083 subtract Subtract or add the model true 01084 list List informative messages to the logger true 01085 async Run asynchronously? false 01086 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01087 01088 -------------------------------------------------------------------------------- 01089 01090 """ 01091 return _image.image_modify(self, *args, **kwargs) 01092 01093 def maxfit(self, *args, **kwargs): 01094 """ 01095 maxfit(self, region=initialize_record(""), point=True, width=5, negfind=False, list=True) -> record * 01096 01097 Summary 01098 Find maximum and do parabolic fit in the sky 01099 01100 Input Parameters: 01101 region The 2-D region of interest to fit. Default is whole image. 01102 point Find only point sources? true 01103 width Half-width of fit grid when point=F 5 01104 negfind Find negative sources as well as positive? false 01105 list List the fitted parameters to the logger? true 01106 01107 -------------------------------------------------------------------------------- 01108 01109 """ 01110 return _image.image_maxfit(self, *args, **kwargs) 01111 01112 def moments(self, *args, **kwargs): 01113 """ 01114 moments(self, moments=initialize_vector(1, (int)0), axis=-10, region=initialize_record(""), mask=initialize_variant(""), 01115 method=std::vector< string >(1, ""), smoothaxes=initialize_vector(1, (int)-1), 01116 smoothtypes=initialize_variant(""), smoothwidths=initialize_vector(1, (double)0.0), 01117 includepix=initialize_vector(1, (double)-1), 01118 excludepix=initialize_vector(1, (double)-1), peaksnr=3.0, stddev=0.0, 01119 doppler=string("RADIO"), outfile=string(""), smoothout=string(""), plotter=string(""), 01120 nx=1, ny=1, yind=False, overwrite=False, drop=True, stretch=False, 01121 async=False) -> image 01122 01123 Summary 01124 Compute moments from an image 01125 01126 Input Parameters: 01127 moments List of moments that you would like to compute. Default is integrated spectrum. 0 01128 axis The moment axis. Default is the spectral axis if there is one. -10 01129 region Region specification. See help par.region. Default is to not use a region. 01130 mask Mask to use. See help par.mask. Default is none. 01131 method List of windowing and/or fitting functions you would like to invoke. Vector of strings from 'window', 'fit' and 'interactive'. The default is to not invoke the window or fit functions, and to not invoke any interactive functions. 01132 smoothaxes List of axes to smooth. Default is no smoothing. -1 01133 smoothtypes List of smoothing kernel types, one for each axis to smooth. Vector of strings from 'gauss', 'boxcar', 'hanning'. Default is no smoothing. 01134 smoothwidths List of widths (full width for boxcar, full width at half maximum for gaussian, 3 for Hanning) in pixels for the smoothing kernels. Vector of numeric. Default is no smoothing. 0.0 01135 includepix Range of pixel values to include. Vector of 1 or 2 doubles. Default is include all pixel. -1 01136 excludepix Range of pixel values to exclude. Default is exclude no pixels. -1 01137 peaksnr The SNR ratio below which the spectrum will be rejected as noise (used by the window and fit functions only) 3.0 01138 stddev Standard deviation of the noise signal in the image (used by the window and fit functions only) 0.0 01139 doppler Velocity doppler definition for velocity computations along spectral axes RADIO 01140 outfile Output image file name (or root for multiple moments). Default is input + an auto-determined suffix. 01141 smoothout Output file name for convolved image. Default is don't save the convolved image. 01142 plotter The PGPLOT device name to make plots on. Default is no plotting. 01143 nx The number of subplots per page in the x direction. 1 01144 ny The number of subplots per page in the y direction. 1 01145 yind Scale the y axis of the profile plots independently false 01146 overwrite Overwrite (unprompted) pre-existing output file? false 01147 drop Drop moments axis from output images? true 01148 stretch Stretch the mask if necessary and possible? false 01149 async Run asynchronously? false 01150 01151 -------------------------------------------------------------------------------- 01152 01153 """ 01154 return _image.image_moments(self, *args, **kwargs) 01155 01156 def name(self, strippath=False): 01157 """ 01158 name(self, strippath=False) -> string 01159 01160 Summary 01161 Name of the image file this tool is attached to 01162 01163 Input Parameters: 01164 strippath Strip off the path before the actual file name? false 01165 01166 -------------------------------------------------------------------------------- 01167 01168 """ 01169 return _image.image_name(self, strippath) 01170 01171 def open(self, *args, **kwargs): 01172 """ 01173 open(self, infile) -> bool 01174 01175 Summary 01176 Open a new image file with this image tool 01177 01178 Input Parameters: 01179 infile image file name 01180 01181 -------------------------------------------------------------------------------- 01182 01183 """ 01184 return _image.image_open(self, *args, **kwargs) 01185 01186 def pixelvalue(self, *args, **kwargs): 01187 """ 01188 pixelvalue(self, pixel=initialize_vector(1, (int)-1)) -> record * 01189 01190 Summary 01191 Get value of image and mask at specified pixel coordinate 01192 01193 Input Parameters: 01194 pixel Pixel coordinate -1 01195 01196 -------------------------------------------------------------------------------- 01197 01198 """ 01199 return _image.image_pixelvalue(self, *args, **kwargs) 01200 01201 def putchunk(self, *args, **kwargs): 01202 """ 01203 putchunk(self, pixels, blc=initialize_vector(1, (int)-1), inc=initialize_vector(1, (int)1), list=False, 01204 locking=True, replicate=False) -> bool 01205 01206 Summary 01207 Put pixels from an array into a regular region of the image 01208 01209 Input Parameters: 01210 pixels Numeric array. Required input. 01211 blc Bottom-Left-Corner (start) of location in image. Default is start of image. -1 01212 inc increment (stride) along axes 1 01213 list List bounding box to logger? false 01214 locking Unlock image after use? true 01215 replicate Replicate array through image false 01216 01217 -------------------------------------------------------------------------------- 01218 01219 """ 01220 return _image.image_putchunk(self, *args, **kwargs) 01221 01222 def putregion(self, *args, **kwargs): 01223 """ 01224 putregion(self, pixels=initialize_variant(""), pixelmask=initialize_variant(""), region=initialize_record(""), 01225 list=False, usemask=True, locking=True, replicate=False) -> bool 01226 01227 Summary 01228 Put pixels and mask into a region-of-interest of the image 01229 01230 Input Parameters: 01231 pixels The pixel values. Default is none. 01232 pixelmask The pixel mask values. Default is none. 01233 region The region of interest. Default is whole image. 01234 list List the bounding box and any mask creation to the logger false 01235 usemask Honour the mask when putting pixels true 01236 locking Unlock image after use? true 01237 replicate Replicate array through image false 01238 01239 -------------------------------------------------------------------------------- 01240 01241 """ 01242 return _image.image_putregion(self, *args, **kwargs) 01243 01244 def rebin(self, *args, **kwargs): 01245 """ 01246 rebin(self, outfile, bin, region=initialize_record(""), mask=initialize_variant(""), dropdeg=False, 01247 overwrite=False, async=False, stretch=False) -> image 01248 01249 Summary 01250 rebin the image by the specified factors 01251 01252 Input Parameters: 01253 outfile Output image file name. Default is unset. 01254 bin Binning factors for each axis 01255 region The region of interest. Default is whole image. 01256 mask Mask to use. See help par.mask. Default is none. 01257 dropdeg Drop degenerate axes false 01258 overwrite Overwrite (unprompted) pre-existing output file? false 01259 async Run asynchronously? false 01260 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01261 01262 -------------------------------------------------------------------------------- 01263 01264 """ 01265 return _image.image_rebin(self, *args, **kwargs) 01266 01267 def regrid(self, *args, **kwargs): 01268 """ 01269 regrid(self, outfile=string(""), shape=initialize_vector(1, (int)-1), csys=initialize_record(""), 01270 axes=initialize_vector(1, (int)-1), region=initialize_record(""), mask=initialize_variant(""), 01271 method=string("linear"), decimate=10, replicate=False, 01272 doref=True, dropdeg=False, overwrite=False, force=False, asvelocity=False, 01273 async=False, stretch=False) -> image 01274 01275 Summary 01276 regrid this image to the specified Coordinate System 01277 01278 Input Parameters: 01279 outfile Output image file name. Default is unset. 01280 shape Shape of output image. Default is input shape. -1 01281 csys Coordinate System for output image. Default is input image coordinate system. 01282 axes The output pixel axes to regrid. Default is all. -1 01283 region The region of interest. Default is the whole image. 01284 mask Mask to use. See help par.mask. Default is none. 01285 method The interpolation method. String from 'nearest', 'linear', 'cubic'. linear 01286 decimate Decimation factor for coordinate grid computation 10 01287 replicate Replicate image rather than regrid? false 01288 doref Turn on reference frame changes true 01289 dropdeg Drop degenerate axes false 01290 overwrite Overwrite (unprompted) pre-existing output file? false 01291 force Force specified axes to be regridded false 01292 asvelocity Regrid spectral axis in velocity space rather than frequency space? false 01293 async Run asynchronously? false 01294 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01295 01296 -------------------------------------------------------------------------------- 01297 01298 """ 01299 return _image.image_regrid(self, *args, **kwargs) 01300 01301 def transpose(self, *args, **kwargs): 01302 """ 01303 transpose(self, outfile=string(""), order=initialize_variant("")) -> image 01304 01305 Summary 01306 Transpose the image. 01307 01308 Input Parameters: 01309 outfile Output image file name. Default is unset. 01310 order Zero-based order of axes in output image (eg '120' => input->output 0->2, 1->0, 2->1)) 01311 01312 -------------------------------------------------------------------------------- 01313 01314 """ 01315 return _image.image_transpose(self, *args, **kwargs) 01316 01317 def rotate(self, *args, **kwargs): 01318 """ 01319 rotate(self, outfile=string(""), shape=initialize_vector(1, (int)-1), pa=initialize_variant("0deg"), 01320 region=initialize_record(""), mask=initialize_variant(""), method=string("cubic"), 01321 decimate=0, replicate=False, dropdeg=False, overwrite=False, 01322 async=False, stretch=False) -> image 01323 01324 Summary 01325 rotate the direction coordinate axes attached to the image and regrid the image to the rotated Coordinate System 01326 01327 Input Parameters: 01328 outfile Output image file name. Default is unset. 01329 shape Shape of output image. Default is shape of input image. -1 01330 pa Angle by which to rotate. Default is no rotation. 0deg 01331 region The region of interest. Default is whole image. 01332 mask Mask to use. See help par.mask. Default is none. 01333 method The interpolation method. String from 'nearest', 'linear', or 'cubic'. cubic 01334 decimate Decimation factor for coordinate grid computation 0 01335 replicate Replicate image rather than regrid? false 01336 dropdeg Drop degenerate axes false 01337 overwrite Overwrite (unprompted) pre-existing output file? false 01338 async Run asynchronously? false 01339 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01340 01341 -------------------------------------------------------------------------------- 01342 01343 """ 01344 return _image.image_rotate(self, *args, **kwargs) 01345 01346 def rename(self, *args, **kwargs): 01347 """ 01348 rename(self, name, overwrite=False) -> bool 01349 01350 Summary 01351 Rename the image file associated with this image tool 01352 01353 Input Parameters: 01354 name The new image file name 01355 overwrite Overwrite target file if it already exists false 01356 01357 -------------------------------------------------------------------------------- 01358 01359 """ 01360 return _image.image_rename(self, *args, **kwargs) 01361 01362 def replacemaskedpixels(self, *args, **kwargs): 01363 """ 01364 replacemaskedpixels(self, pixels, region=initialize_record(""), mask=initialize_variant(""), update=False, 01365 list=False, stretch=False) -> bool 01366 01367 Summary 01368 replace the values of pixels which are masked bad 01369 01370 Input Parameters: 01371 pixels The new value(s), Numeric scalar or LEL expression 01372 region The region of interest. Default is whole image. 01373 mask Mask to use. See help par.mask. Default is none. 01374 update Update mask as well? false 01375 list List the bounding box to the logger false 01376 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01377 01378 -------------------------------------------------------------------------------- 01379 01380 """ 01381 return _image.image_replacemaskedpixels(self, *args, **kwargs) 01382 01383 def restoringbeam(self, *args, **kwargs): 01384 """ 01385 restoringbeam(self, channel=-1, polarization=-1) -> record * 01386 01387 Summary 01388 Get the restoring beam(s). 01389 01390 Input Parameters: 01391 channel The zero-based spectral channel number for a per-plane beam. Default -1 -1 01392 polarization The zero-based polarization plane number for a per-plane beam. Default -1 -1 01393 01394 -------------------------------------------------------------------------------- 01395 01396 """ 01397 return _image.image_restoringbeam(self, *args, **kwargs) 01398 01399 def sepconvolve(self, *args, **kwargs): 01400 """ 01401 sepconvolve(self, outfile=string(""), axes=initialize_vector(1, (int)-1), types=std::vector< string >(1, ""), 01402 widths=initialize_variant(""), scale=-1, region=initialize_record(""), 01403 mask=initialize_variant(""), overwrite=False, async=False, stretch=False) -> image 01404 01405 Summary 01406 Separable convolution 01407 01408 Input Parameters: 01409 outfile Output image file name. Default is unset. 01410 axes Axes to convolve. Default is [0,1,...]. -1 01411 types Type of convolution kernel. Vector of strings from 'boxcar', 'gaussian', and 'hanning'. Default is appropriately sized vector of 'gaussian'. 01412 widths Convolution kernel widths, Vector of numeric, quantity or string 01413 scale Scale factor. Default is autoscale. -1 01414 region Region of interest. Default is whole image. 01415 mask Mask to use. See help par.mask. Default is none. 01416 overwrite Overwrite (unprompted) pre-existing output file? false 01417 async Run asynchronously? false 01418 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01419 01420 -------------------------------------------------------------------------------- 01421 01422 """ 01423 return _image.image_sepconvolve(self, *args, **kwargs) 01424 01425 def set(self, *args, **kwargs): 01426 """ 01427 set(self, pixels=initialize_variant(""), pixelmask=-1, region=initialize_record(""), list=False) -> bool 01428 01429 Summary 01430 Set pixel and/or mask values with a scalar in a region-of-interest of the image 01431 01432 Input Parameters: 01433 pixels The pixel value, LEL scalar expression or numeric scalar. Default is unset. 01434 pixelmask The pixel mask value. Either 0 or 1 if set. Default is unset. -1 01435 region The region of interest. Default is whole image. 01436 list List the bounding box and any mask creation to the logger false 01437 01438 -------------------------------------------------------------------------------- 01439 01440 """ 01441 return _image.image_set(self, *args, **kwargs) 01442 01443 def setbrightnessunit(self, *args, **kwargs): 01444 """ 01445 setbrightnessunit(self, unit) -> bool 01446 01447 Summary 01448 Set the image brightness unit 01449 01450 Input Parameters: 01451 unit New brightness unit 01452 01453 -------------------------------------------------------------------------------- 01454 01455 """ 01456 return _image.image_setbrightnessunit(self, *args, **kwargs) 01457 01458 def setcoordsys(self, *args, **kwargs): 01459 """ 01460 setcoordsys(self, csys) -> bool 01461 01462 Summary 01463 Set new Coordinate System 01464 01465 Input Parameters: 01466 csys Record describing new Coordinate System 01467 01468 -------------------------------------------------------------------------------- 01469 01470 """ 01471 return _image.image_setcoordsys(self, *args, **kwargs) 01472 01473 def sethistory(self, *args, **kwargs): 01474 """ 01475 sethistory(self, origin=string(""), history=std::vector< string >(1, "")) -> bool 01476 01477 Summary 01478 Set the history for an image 01479 01480 Input Parameters: 01481 origin Used to set message origin. Default is image::sethistory. 01482 history New history 01483 01484 -------------------------------------------------------------------------------- 01485 01486 """ 01487 return _image.image_sethistory(self, *args, **kwargs) 01488 01489 def setmiscinfo(self, *args, **kwargs): 01490 """ 01491 setmiscinfo(self, info) -> bool 01492 01493 Summary 01494 Set the miscellaneous information record for an image 01495 01496 Input Parameters: 01497 info Miscellaneous REPLACEMENT header 01498 01499 -------------------------------------------------------------------------------- 01500 01501 """ 01502 return _image.image_setmiscinfo(self, *args, **kwargs) 01503 01504 def shape(self): 01505 """ 01506 shape(self) -> std::vector< int > 01507 01508 Summary 01509 Length of each axis in the image 01510 -------------------------------------------------------------------------------- 01511 01512 """ 01513 return _image.image_shape(self) 01514 01515 def setrestoringbeam(self, *args, **kwargs): 01516 """ 01517 setrestoringbeam(self, major=initialize_variant("1arcsec"), minor=initialize_variant("1arcsec"), pa=initialize_variant("0deg"), 01518 beam=initialize_record(""), remove=False, log=True, 01519 channel=-1, polarization=-1) -> bool 01520 01521 Summary 01522 Set the restoringbeam 01523 01524 Input Parameters: 01525 major Major axis FWHM, Quantity or float (e.g., 1arcsec). Default is unset. 1arcsec 01526 minor Minor axis FWHM, Quantity or float (e.g., 1arcsec). Default is unset. 1arcsec 01527 pa Position angle, Quantity or float (e.g., '5deg'). Default is unset. 0deg 01528 beam The complete restoring beam (output of restoringbeam()). Default is unset. 01529 remove Delete the restoring beam? false 01530 log Write new beam values to the logger? true 01531 channel Zero-based channel number for which to set a per plane beam. If the image has a traditional beam, set to less than zero. Default -1. -1 01532 polarization Zero-based polarization number for which to set a per plane beam. If the image has a traditional beam, set to less than zero. Default -1. -1 01533 01534 -------------------------------------------------------------------------------- 01535 01536 """ 01537 return _image.image_setrestoringbeam(self, *args, **kwargs) 01538 01539 def statistics(self, *args, **kwargs): 01540 """ 01541 statistics(self, axes=initialize_vector(1, (int)-1), region=initialize_record(""), mask=initialize_variant(""), 01542 plotstats=std::vector< string >(1, ""), includepix=initialize_vector(1, (double)-1), 01543 excludepix=initialize_vector(1, (double)-1), plotter=string(""), 01544 nx=1, ny=1, list=True, force=False, disk=False, robust=False, 01545 verbose=True, async=False, stretch=False, logfile=string(""), append=True) -> record * 01546 01547 Summary 01548 Compute statistics from the image 01549 01550 Input Parameters: 01551 axes List of axes to evaluate statistics over. Default is all axes. -1 01552 region Region of interest. Default is whole image. 01553 mask Mask to use. See help par.mask. Default is none. 01554 plotstats List of statistics to plot String containing any combination of 'npts', 'sum', 'flux', 'sumsq', 'min', 'max', 'mean', 'sigma' (or 'stddev'), 'rms', 'median', 'medabsdevmed', 'quartile' Default is ['mean','sigma']. 01555 includepix Range of pixel values to include. Vector of 1 or 2 doubles. Default is to include all pixels. -1 01556 excludepix Range of pixel values to exclude. Vector of 1 or 2 doubles. Default is exclude no pixels. -1 01557 plotter The PGPLOT device name to make plots on. Default is no plotting. 01558 nx The number of subplots per page in the x direction, > 0 1 01559 ny The number of subplots per page in the y direction, > 0 1 01560 list If True print bounding box and statistics to logger. true 01561 force If T then force the stored statistical accumulations to be regenerated false 01562 disk If T then force the storage image to disk false 01563 robust If T then compute robust statistics as well false 01564 verbose If T then log statistics true 01565 async Run asynchronously? false 01566 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01567 logfile Name of file to which to write statistics. 01568 append Append results to logfile? Logfile must be specified. Default is to append. False means overwrite existing file if it exists. true 01569 01570 -------------------------------------------------------------------------------- 01571 01572 """ 01573 return _image.image_statistics(self, *args, **kwargs) 01574 01575 def twopointcorrelation(self, *args, **kwargs): 01576 """ 01577 twopointcorrelation(self, outfile=string(""), region=initialize_record(""), mask=initialize_variant(""), axes=initialize_vector(1, (int)-1), 01578 method=string("structurefunction"), overwrite=False, 01579 stretch=False) -> bool 01580 01581 Summary 01582 Compute two point correlation function from the image 01583 01584 Input Parameters: 01585 outfile Output image file name. Default is unset. 01586 region The region of interest. Default is whole image. 01587 mask Mask to use. See help par.mask. Default is none. 01588 axes The pixel axes to compute structure function over. The default is sky or first two axes. -1 01589 method The method of computation. String from 'structurefunction'. structurefunction 01590 overwrite Overwrite (unprompted) pre-existing output file? false 01591 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01592 01593 -------------------------------------------------------------------------------- 01594 01595 """ 01596 return _image.image_twopointcorrelation(self, *args, **kwargs) 01597 01598 def subimage(self, *args, **kwargs): 01599 """ 01600 subimage(self, outfile=string(""), region=initialize_variant(""), mask=initialize_variant(""), dropdeg=False, 01601 overwrite=False, list=True, stretch=False) -> image 01602 01603 Summary 01604 Create a (sub)image from a region of the image 01605 01606 Input Parameters: 01607 outfile Output image file name. Default is unset. 01608 region Region of interest. Default is whole image. 01609 mask Mask to use. See help par.mask. Default is none. 01610 dropdeg Drop degenerate axes false 01611 overwrite Overwrite (unprompted) pre-existing output file? false 01612 list List informative messages to the logger true 01613 stretch Stretch the mask if necessary and possible? false 01614 01615 -------------------------------------------------------------------------------- 01616 01617 """ 01618 return _image.image_subimage(self, *args, **kwargs) 01619 01620 def summary(self, *args, **kwargs): 01621 """ 01622 summary(self, doppler=string("RADIO"), list=True, pixelorder=True, verbose=False) -> record * 01623 01624 Summary 01625 Summarize basic information about the image 01626 01627 Input Parameters: 01628 doppler If there is a spectral axis, list velocity too, with this doppler definition RADIO 01629 list List the summary to the logger true 01630 pixelorder List axis descriptors in pixel or world axis order true 01631 verbose Give a full listing of beams or just a short summary? Only used when the image has multiple beams. false 01632 01633 -------------------------------------------------------------------------------- 01634 01635 """ 01636 return _image.image_summary(self, *args, **kwargs) 01637 01638 def tofits(self, *args, **kwargs): 01639 """ 01640 tofits(self, outfile=string(""), velocity=False, optical=True, bitpix=-32, minpix=1, maxpix=-1, 01641 region=initialize_record(""), mask=initialize_variant(""), overwrite=False, 01642 dropdeg=False, deglast=False, dropstokes=False, stokeslast=True, wavelength=False, 01643 airwavelength=False, async=False, stretch=False) -> bool 01644 01645 Summary 01646 Convert the image to a FITS file 01647 01648 Input Parameters: 01649 outfile FITS file name. Default is input name + '.fits' 01650 velocity prefer velocity (rather than frequency) as primary spectral axis? false 01651 optical use the optical (rather than radio) velocity convention? true 01652 bitpix Bits per pixel, -32 (floating point) or 16 (integer) -32 01653 minpix Minimum pixel value for BITPIX=16, Default is to autoscale if minpix > maxpix. 1 01654 maxpix Maximum pixel value for BITPIX=16, Default is to autoscale if maxpix < minpix. -1 01655 region The region of interest. Default is whole image. 01656 mask Mask to use. See help par.mask. Default is none. 01657 overwrite Overwrite (unprompted) pre-existing output file? false 01658 dropdeg Drop degenerate axes? false 01659 deglast Put degenerate axes last in header? false 01660 dropstokes Drop Stokes axis? false 01661 stokeslast Put Stokes axis last in header? true 01662 wavelength Write spectral axis in units of wavelength (instead of velocity or frequency)? false 01663 airwavelength When wirting the spectral axis in units of wavelength, use air wavelength instead of vacuum wavelength? false 01664 async Run asynchronously? false 01665 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01666 01667 -------------------------------------------------------------------------------- 01668 01669 """ 01670 return _image.image_tofits(self, *args, **kwargs) 01671 01672 def toASCII(self, *args, **kwargs): 01673 """ 01674 toASCII(self, outfile, region=initialize_record(""), mask=initialize_variant(""), sep=string(":"), 01675 format=string("%e"), maskvalue=-999, overwrite=False, stretch=False) -> bool 01676 01677 Summary 01678 Convert the image to an ASCII file 01679 01680 Input Parameters: 01681 outfile ASCII file name. Default is input name + '.ascii'. 01682 region The region of interest. Default is whole image. 01683 mask Mask to use. See help par.mask. Default is none. 01684 sep Separator of data in ascii file. Default is space character. : 01685 format Format of data in ascii file %e 01686 maskvalue Value to replace masked pixels by, -999 is no change. -999 01687 overwrite Overwrite (unprompted) pre-existing output file? false 01688 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01689 01690 -------------------------------------------------------------------------------- 01691 01692 """ 01693 return _image.image_toASCII(self, *args, **kwargs) 01694 01695 def torecord(self): 01696 """ 01697 torecord(self) -> record * 01698 01699 Summary 01700 Return a record containg the image associated with this 01701 tool 01702 01703 -------------------------------------------------------------------------------- 01704 01705 """ 01706 return _image.image_torecord(self) 01707 01708 def type(self): 01709 """ 01710 type(self) -> string 01711 01712 Summary 01713 Return the type of this tool 01714 -------------------------------------------------------------------------------- 01715 01716 """ 01717 return _image.image_type(self) 01718 01719 def topixel(self, *args, **kwargs): 01720 """ 01721 topixel(self, value) -> record * 01722 01723 Summary 01724 Convert from world to pixel coordinate 01725 01726 Input Parameters: 01727 value Absolute world coordinate, Numeric vector, vector of quantities or record. Default is reference value. 01728 01729 -------------------------------------------------------------------------------- 01730 01731 """ 01732 return _image.image_topixel(self, *args, **kwargs) 01733 01734 def toworld(self, *args, **kwargs): 01735 """ 01736 toworld(self, value=initialize_variant(""), format=string("n")) -> record * 01737 01738 Summary 01739 Convert from pixel to world coordinate 01740 01741 Input Parameters: 01742 value Absolute pixel coordinate. Numeric vector is allowed. Default is reference pixel. 01743 format What type of formatting? String from combination of 'n' (numeric), 'q' (quantity), 'm' (measure), 's' (string). n 01744 01745 -------------------------------------------------------------------------------- 01746 01747 """ 01748 return _image.image_toworld(self, *args, **kwargs) 01749 01750 def unlock(self): 01751 """ 01752 unlock(self) -> bool 01753 01754 Summary 01755 Release any lock on the image 01756 -------------------------------------------------------------------------------- 01757 01758 """ 01759 return _image.image_unlock(self) 01760 01761 def newimagefromarray(self, *args, **kwargs): 01762 """ 01763 newimagefromarray(self, outfile=string(""), pixels=initialize_variant(""), csys=initialize_record(""), linear=False, 01764 overwrite=False, log=True) -> image 01765 01766 Summary 01767 Construct a casa image from an array 01768 01769 Input Parameters: 01770 outfile Output image file name. Default is unset. 01771 pixels A numeric array is required. 01772 csys Coordinate System. Default is unset. 01773 linear Make a linear Coordinate System if csys not given false 01774 overwrite Overwrite (unprompted) pre-existing output file? false 01775 log Write image creation messages to logger true 01776 01777 -------------------------------------------------------------------------------- 01778 01779 """ 01780 return _image.image_newimagefromarray(self, *args, **kwargs) 01781 01782 def newimagefromfits(self, *args, **kwargs): 01783 """ 01784 newimagefromfits(self, outfile=string(""), infile=string(""), whichrep=0, whichhdu=0, zeroblanks=False, 01785 overwrite=False) -> image 01786 01787 Summary 01788 Construct a casa image by conversion from a FITS image file 01789 01790 Input Parameters: 01791 outfile Output image file name. Default is unset. 01792 infile Input FITS disk file name. Required. 01793 whichrep If this FITS file contains multiple coordinate representations, which one should we read 0 01794 whichhdu If this FITS file contains multiple images, which one should we read (0-based). 0 01795 zeroblanks If there are blanked pixels, set them to zero instead of NaN false 01796 overwrite Overwrite (unprompted) pre-existing output file? false 01797 01798 -------------------------------------------------------------------------------- 01799 01800 """ 01801 return _image.image_newimagefromfits(self, *args, **kwargs) 01802 01803 def newimagefromimage(self, *args, **kwargs): 01804 """ 01805 newimagefromimage(self, infile=string(""), outfile=string(""), region=initialize_record(""), mask=initialize_variant(""), 01806 dropdeg=False, overwrite=False) -> image 01807 01808 Summary 01809 Construct an on-the-fly image tool from a region of a casa image file 01810 01811 Input Parameters: 01812 infile Input image file name. Required. 01813 outfile Output sub-image file name. Default is unset. 01814 region The region of interest. Default is the whole image. 01815 mask Mask to use. See help par.mask. Default is none. 01816 dropdeg Drop degenerate axes false 01817 overwrite Overwrite (unprompted) pre-existing output file? false 01818 01819 -------------------------------------------------------------------------------- 01820 01821 """ 01822 return _image.image_newimagefromimage(self, *args, **kwargs) 01823 01824 def newimagefromshape(self, *args, **kwargs): 01825 """ 01826 newimagefromshape(self, outfile=string(""), shape=initialize_vector(1, (int)0), csys=initialize_record(""), 01827 linear=False, overwrite=False, log=True) -> image 01828 01829 Summary 01830 Construct an empty casa image from a shape 01831 01832 Input Parameters: 01833 outfile Name of output image file. Default is unset. 01834 shape Shape of image. Required. 0 01835 csys Record describing Coordinate System. Default is unset. 01836 linear Make a linear Coordinate System if csys not given? false 01837 overwrite Overwrite (unprompted) pre-existing output file? false 01838 log Write image creation messages to logger true 01839 01840 -------------------------------------------------------------------------------- 01841 01842 """ 01843 return _image.image_newimagefromshape(self, *args, **kwargs) 01844 01845 def pbcor(self, *args, **kwargs): 01846 """ 01847 pbcor(self, pbimage=initialize_variant(""), outfile=string(""), overwrite=False, box=string(""), 01848 region=initialize_variant(""), chans=string(""), stokes=string(""), mask=string(""), 01849 mode=string("divide"), cutoff=-1.0, stretch=False) -> image 01850 01851 Summary 01852 01853 Construct a primary beam corrected image from an image and a primary beam 01854 01855 01856 Input Parameters: 01857 pbimage Name of the primary beam image which must exist or array of values for the pb response. Default '' 01858 outfile Output image name. If empty, no image is written. Default '' 01859 overwrite Overwrite the output if it exists? Default False false 01860 box One or more boxes to use for fit region(s). Default is to use the entire directional plane. 01861 region The region to correct. Default is entire image. If both box and region are specified, box is used and region is not. 01862 chans The frequency planes to correct. Default is all frequencies. 01863 stokes The correlations to correct. Default is all. 01864 mask Mask to use. See help par.mask. Default is none. 01865 mode Divide or multiply the image by the primary beam image. Minimal match supported. Default 'divide' divide 01866 cutoff PB cutoff. If mode is 'd', all values less than this will be masked. If 'm', all values greater will be masked. Less than 0, no cutoff. Default no cutoff -1.0 01867 stretch Stretch the mask if necessary and possible? See help par.stretch. Default False false 01868 01869 -------------------------------------------------------------------------------- 01870 01871 """ 01872 return _image.image_pbcor(self, *args, **kwargs) 01873 01874 def makearray(self, *args, **kwargs): 01875 """ 01876 makearray(self, v=0.0, shape=initialize_vector(1, (int)0)) -> variant * 01877 01878 Summary 01879 Construct an initialized multi-dimensional array. 01880 01881 01882 Input Parameters: 01883 v Value with which to initial array elements 0.0 01884 shape Vector containing array dimensions. 0 01885 01886 -------------------------------------------------------------------------------- 01887 01888 """ 01889 return _image.image_makearray(self, *args, **kwargs) 01890 01891 def setboxregion(self, *args, **kwargs): 01892 """ 01893 setboxregion(self, blc=initialize_vector(1, (double)-1), trc=initialize_vector(1, (double)-1), frac=False, 01894 infile=string("")) -> record * 01895 01896 Summary 01897 DEPRECATED. Use rg.box() instead. Set a pixel box region of interest in the image 01898 01899 Input Parameters: 01900 blc Bottom-Left-Corner (beginning) of pixel section. Default is blc of image. -1 01901 trc Top-Right-Corner (end) of pixel section. Default is trc of image. -1 01902 frac Pixel or fractional coordinates false 01903 infile Input image file name 01904 01905 -------------------------------------------------------------------------------- 01906 01907 """ 01908 return _image.image_setboxregion(self, *args, **kwargs) 01909 01910 def echo(self, *args, **kwargs): 01911 """ 01912 echo(self, v, godeep=False) -> record * 01913 01914 Summary 01915 returns input record 01916 01917 Input Parameters: 01918 v a measure value 01919 godeep force the use of MeasureHolder record conversions false 01920 01921 -------------------------------------------------------------------------------- 01922 01923 """ 01924 return _image.image_echo(self, *args, **kwargs) 01925 01926 def isconform(self, *args, **kwargs): 01927 """ 01928 isconform(self, other) -> bool 01929 01930 Summary 01931 Returns true of the shape, coordinate system, and axes order of the specified image matches this image. 01932 01933 Input Parameters: 01934 other name of image to test 01935 01936 -------------------------------------------------------------------------------- 01937 01938 """ 01939 return _image.image_isconform(self, *args, **kwargs) 01940 01941 image_swigregister = _image.image_swigregister 01942 image_swigregister(image) 01943 01944 # This file is compatible with both classic and new-style classes. 01945 01946
1.8.0
