|
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('_componentlist', [dirname(__file__)]) 00017 except ImportError: 00018 import _componentlist 00019 return _componentlist 00020 if fp is not None: 00021 try: 00022 _mod = imp.load_module('_componentlist', fp, pathname, description) 00023 finally: 00024 fp.close() 00025 return _mod 00026 _componentlist = swig_import_helper() 00027 del swig_import_helper 00028 else: 00029 import _componentlist 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 componentlist(_object): 00071 """Proxy of C++ casac::componentlist class""" 00072 __swig_setmethods__ = {} 00073 __setattr__ = lambda self, name, value: _swig_setattr(self, componentlist, name, value) 00074 __swig_getmethods__ = {} 00075 __getattr__ = lambda self, name: _swig_getattr(self, componentlist, name) 00076 __repr__ = _swig_repr 00077 def __init__(self): 00078 """__init__(self) -> componentlist""" 00079 this = _componentlist.new_componentlist() 00080 try: self.this.append(this) 00081 except: self.this = this 00082 __swig_destroy__ = _componentlist.delete_componentlist 00083 __del__ = lambda self : None; 00084 def open(self, *args, **kwargs): 00085 """ 00086 open(self, filename=string(""), nomodify=False, log=True) -> bool 00087 00088 Summary 00089 Construct an componentlist 00090 from the data in an aipspp table 00091 00092 Input Parameters: 00093 filename The filename of the table 00094 nomodify Should the table be opened read only false 00095 log Send a message to the logger true 00096 00097 -------------------------------------------------------------------------------- 00098 00099 """ 00100 return _componentlist.componentlist_open(self, *args, **kwargs) 00101 00102 def asciitocomponentlist(self, *args, **kwargs): 00103 """ 00104 asciitocomponentlist(self, filename, asciifile, refer=string("J2000"), format=string("ST"), direction=initialize_record(""), 00105 spectrum=initialize_record(""), flux=initialize_record(""), 00106 log=True) -> int 00107 00108 Summary 00109 Create a componentlist from an ascii file 00110 00111 Input Parameters: 00112 filename Name of output component list table 00113 asciifile Name of input ascii file 00114 refer Input reference frame B1950 J2000 00115 format Name of format (only ST supported) ST 00116 direction Direction measure (for relative coordinates) 00117 spectrum Default spectrum field, valid spectrum field [type='Constant', frequency=[type='frequency' , refer='LSR' , m0=[unit='GHz' , value=1.0]] 00118 flux Default flux field, valid flux field [value=[0.0, 0.0, 0.0, 0.0], unit='Jy', polarization='Stokes'] 00119 log Send a message to the logger true 00120 00121 -------------------------------------------------------------------------------- 00122 00123 """ 00124 return _componentlist.componentlist_asciitocomponentlist(self, *args, **kwargs) 00125 00126 def concatenate(self, *args, **kwargs): 00127 """ 00128 concatenate(self, list=initialize_variant(""), which=initialize_vector(1, (int)-1), log=True) -> bool 00129 00130 Summary 00131 Append components from another componentlist. 00132 00133 Input Parameters: 00134 list list to copy from. Can be a componentlist record or a componentlist file name from disk 00135 which which components to copy, -1 unset -1 00136 log Send a message to the logger true 00137 00138 -------------------------------------------------------------------------------- 00139 00140 """ 00141 return _componentlist.componentlist_concatenate(self, *args, **kwargs) 00142 00143 def fromrecord(self, *args, **kwargs): 00144 """ 00145 fromrecord(self, record=initialize_record("")) -> bool 00146 00147 Summary 00148 make a componentlist tool from a record 00149 00150 Input Parameters: 00151 record a component list record 00152 00153 -------------------------------------------------------------------------------- 00154 00155 """ 00156 return _componentlist.componentlist_fromrecord(self, *args, **kwargs) 00157 00158 def torecord(self): 00159 """ 00160 torecord(self) -> record * 00161 00162 Summary 00163 convert componentlist to a record 00164 -------------------------------------------------------------------------------- 00165 00166 """ 00167 return _componentlist.componentlist_torecord(self) 00168 00169 def remove(self, *args, **kwargs): 00170 """ 00171 remove(self, which=initialize_vector(1, (int)-1), log=True) -> bool 00172 00173 Summary 00174 Remove a component from the list. 00175 00176 Input Parameters: 00177 which indices of which component(s) to remove a vector containing unique integers between 0 and one less than the length of the list, -1 for all -1 00178 log Send a message to the logger true 00179 00180 -------------------------------------------------------------------------------- 00181 00182 """ 00183 return _componentlist.componentlist_remove(self, *args, **kwargs) 00184 00185 def purge(self): 00186 """ 00187 purge(self) -> bool 00188 00189 Summary 00190 Permanently delete removed components. 00191 -------------------------------------------------------------------------------- 00192 00193 """ 00194 return _componentlist.componentlist_purge(self) 00195 00196 def recover(self, log=True): 00197 """ 00198 recover(self, log=True) -> bool 00199 00200 Summary 00201 Obtain removed components. 00202 00203 Input Parameters: 00204 log Send a message to the logger true 00205 00206 -------------------------------------------------------------------------------- 00207 00208 """ 00209 return _componentlist.componentlist_recover(self, log) 00210 00211 def length(self): 00212 """ 00213 length(self) -> int 00214 00215 Summary 00216 Find the number of components in the list. 00217 -------------------------------------------------------------------------------- 00218 00219 """ 00220 return _componentlist.componentlist_length(self) 00221 00222 def indices(self): 00223 """ 00224 indices(self) -> std::vector< int > 00225 00226 Summary 00227 Return a vector of indices. 00228 -------------------------------------------------------------------------------- 00229 00230 """ 00231 return _componentlist.componentlist_indices(self) 00232 00233 def sort(self, *args, **kwargs): 00234 """ 00235 sort(self, criteria=string("Flux"), log=True) -> bool 00236 00237 Summary 00238 Sort the components in a list 00239 00240 Input Parameters: 00241 criteria a string containg the criteria to use to sort the list Polarization Position Flux 00242 log Send a message to the logger true 00243 00244 -------------------------------------------------------------------------------- 00245 00246 """ 00247 return _componentlist.componentlist_sort(self, *args, **kwargs) 00248 00249 def isphysical(self, *args, **kwargs): 00250 """ 00251 isphysical(self, which=initialize_vector(1, (int)-1)) -> bool 00252 00253 Summary 00254 Check if a component is physically plausible 00255 00256 Input Parameters: 00257 which A vector of indices Indices must be between 0 and one less than the list length, inclusively -1 00258 00259 -------------------------------------------------------------------------------- 00260 00261 """ 00262 return _componentlist.componentlist_isphysical(self, *args, **kwargs) 00263 00264 def sample(self, *args, **kwargs): 00265 """ 00266 sample(self, direction=initialize_variant("J2000 00h00m00.00 90d00m00.0"), pixellatsize=initialize_variant("0.0deg"), 00267 pixellongsize=initialize_variant("0.0deg"), frequency=initialize_variant("1.4GHz")) -> std::vector< double > 00268 00269 Summary 00270 Sample the flux of the list in a specified direction. 00271 00272 Input Parameters: 00273 direction The direction to sample any valid direction measure. A valid Direction measure or vector of string or string, e.g me.direction('J2000','19h30m00', '-20d00m00') or ['J2000','19h30m00', '-20d00m00'] or 'J2000 19h30m00 -20d00m00' J2000 00h00m00.00 90d00m00.0 00274 pixellatsize the x-size of the in pixels to use when sampling any quantity that has angular units. 0.0deg 00275 pixellongsize the y-size of the in pixels to use when sampling any quantity that has angular units. 0.0deg 00276 frequency The frequency to sample at Any frequency measure 1.4GHz 00277 00278 -------------------------------------------------------------------------------- 00279 00280 """ 00281 return _componentlist.componentlist_sample(self, *args, **kwargs) 00282 00283 def rename(self, *args, **kwargs): 00284 """ 00285 rename(self, filename, log=True) -> bool 00286 00287 Summary 00288 Give the list a name so it can save itself. use close to save to disk 00289 00290 Input Parameters: 00291 filename The filename of the table 00292 log Send a message to the logger true 00293 00294 -------------------------------------------------------------------------------- 00295 00296 """ 00297 return _componentlist.componentlist_rename(self, *args, **kwargs) 00298 00299 def simulate(self, howmany=1, log=True): 00300 """ 00301 simulate(self, howmany=1, log=True) -> bool 00302 00303 Summary 00304 Add some simulated components to the list 00305 00306 Input Parameters: 00307 howmany How many components to simulate, greater than zero 1 00308 log Send a message to the logger true 00309 00310 -------------------------------------------------------------------------------- 00311 00312 """ 00313 return _componentlist.componentlist_simulate(self, howmany, log) 00314 00315 def addcomponent(self, *args, **kwargs): 00316 """ 00317 addcomponent(self, flux=initialize_variant(""), fluxunit=string("Jy"), polarization=string("Stokes"), 00318 dir=initialize_variant("J2000 00h00m00.0 90d00m00.0"), shape=string("point"), 00319 majoraxis=initialize_variant("2.0arcmin"), minoraxis=initialize_variant("1.0arcmin"), 00320 positionangle=initialize_variant("0.0deg"), freq=initialize_variant("LSRK 1.415GHz"), 00321 spectrumtype=string("constant"), index=1.0, label=string("")) -> bool 00322 00323 Summary 00324 Add a component to the list 00325 00326 Input Parameters: 00327 flux The flux value. A vector with four real or complex numbers 00328 fluxunit The units of the flux. Any string with the same dimensions as the Jansky Jy 00329 polarization The polarization of the value field. ``Stokes'', ``linear'' or ``circular'' Circular Linear Stokes 00330 dir The direction measure of the source, it can a be any direction measure from the measures tool or a string of the type 'J2000 10h30m00 -20d00m00.0' or a vector of strings of the type ['J2000', '10:30:00.00', '-20.00.00.0']. Basically the string or strings should have the direction frame and quantities for Ra and Dec J2000 00h00m00.0 90d00m00.0 00331 shape The new shape type. A string that is either 'point', 'Gaussian' or 'disk' disk Gaussian point 00332 majoraxis The width of the larger axis. A quantity with angular units 2.0arcmin 00333 minoraxis The width of the smaller axis. A quantity with angular units 1.0arcmin 00334 positionangle The rotation of the axes with respect to the reference frame. A quantity with angular units 0.0deg 00335 freq The reference frequency. A quantity with units equivalent to the 'Hz' and frame or a frequency measure, e.g ['TOPO', '1.6GHz'], or simply default frame (LSRK) '1.6GHz' LSRK 1.415GHz 00336 spectrumtype The spectrum type, a string that is either 'constant' or 'spectral index' spectral index constant 00337 index The spectral index 1.0 00338 label The label for the component 00339 00340 -------------------------------------------------------------------------------- 00341 00342 """ 00343 return _componentlist.componentlist_addcomponent(self, *args, **kwargs) 00344 00345 def close(self, log=True): 00346 """ 00347 close(self, log=True) -> bool 00348 00349 Summary 00350 Save the componentlist to disk and reset its state. 00351 00352 Input Parameters: 00353 log Send a message to the logger true 00354 00355 -------------------------------------------------------------------------------- 00356 00357 """ 00358 return _componentlist.componentlist_close(self, log) 00359 00360 def edit(self, *args, **kwargs): 00361 """ 00362 edit(self, which, log=True) -> bool 00363 00364 Summary 00365 Start up the component editor gui 00366 00367 Input Parameters: 00368 which An index specifying which component. An integer between 0 and one less than the list length no default 00369 log Send a message to the logger true 00370 00371 -------------------------------------------------------------------------------- 00372 00373 """ 00374 return _componentlist.componentlist_edit(self, *args, **kwargs) 00375 00376 def done(self): 00377 """ 00378 done(self) -> bool 00379 00380 Summary 00381 Delete the componentlist tool 00382 -------------------------------------------------------------------------------- 00383 00384 """ 00385 return _componentlist.componentlist_done(self) 00386 00387 def select(self, *args, **kwargs): 00388 """ 00389 select(self, which) -> bool 00390 00391 Summary 00392 Mark components in the list 00393 00394 Input Parameters: 00395 which A vector of indices. Indices must be between 0 and one less than the list length, inclusively 00396 00397 -------------------------------------------------------------------------------- 00398 00399 """ 00400 return _componentlist.componentlist_select(self, *args, **kwargs) 00401 00402 def deselect(self, *args, **kwargs): 00403 """ 00404 deselect(self, which) -> bool 00405 00406 Summary 00407 Unmark components in the list 00408 00409 Input Parameters: 00410 which A vector of indices Indices must be between 0 and one less than the list length, inclusively 00411 00412 -------------------------------------------------------------------------------- 00413 00414 """ 00415 return _componentlist.componentlist_deselect(self, *args, **kwargs) 00416 00417 def selected(self): 00418 """ 00419 selected(self) -> std::vector< int > 00420 00421 Summary 00422 Determine which components are selected 00423 -------------------------------------------------------------------------------- 00424 00425 """ 00426 return _componentlist.componentlist_selected(self) 00427 00428 def getlabel(self, *args, **kwargs): 00429 """ 00430 getlabel(self, which) -> string 00431 00432 Summary 00433 Get the label of the specified component 00434 00435 Input Parameters: 00436 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00437 00438 -------------------------------------------------------------------------------- 00439 00440 """ 00441 return _componentlist.componentlist_getlabel(self, *args, **kwargs) 00442 00443 def setlabel(self, *args, **kwargs): 00444 """ 00445 setlabel(self, which, value, log=True) -> bool 00446 00447 Summary 00448 Set the label of the specified components 00449 00450 Input Parameters: 00451 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively no default 00452 value The label for the specified components 00453 log Send a message to the logger true 00454 00455 -------------------------------------------------------------------------------- 00456 00457 """ 00458 return _componentlist.componentlist_setlabel(self, *args, **kwargs) 00459 00460 def getfluxvalue(self, *args, **kwargs): 00461 """ 00462 getfluxvalue(self, which) -> std::vector< double > 00463 00464 Summary 00465 Get the flux value of the specified component 00466 00467 Input Parameters: 00468 which An index specifying which component. An integer between 0 and one less than the list length, inclusively no default 00469 00470 -------------------------------------------------------------------------------- 00471 00472 """ 00473 return _componentlist.componentlist_getfluxvalue(self, *args, **kwargs) 00474 00475 def getfluxunit(self, *args, **kwargs): 00476 """ 00477 getfluxunit(self, which) -> string 00478 00479 Summary 00480 Get the flux unit of the specified component 00481 00482 Input Parameters: 00483 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00484 00485 -------------------------------------------------------------------------------- 00486 00487 """ 00488 return _componentlist.componentlist_getfluxunit(self, *args, **kwargs) 00489 00490 def getfluxpol(self, *args, **kwargs): 00491 """ 00492 getfluxpol(self, which) -> string 00493 00494 Summary 00495 Get the polarization representation for the flux of the specified component 00496 00497 Input Parameters: 00498 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00499 00500 -------------------------------------------------------------------------------- 00501 00502 """ 00503 return _componentlist.componentlist_getfluxpol(self, *args, **kwargs) 00504 00505 def getfluxerror(self, *args, **kwargs): 00506 """ 00507 getfluxerror(self, which) -> std::vector< double > 00508 00509 Summary 00510 Get the error in the flux of the 00511 specified component 00512 00513 Input Parameters: 00514 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00515 00516 -------------------------------------------------------------------------------- 00517 00518 """ 00519 return _componentlist.componentlist_getfluxerror(self, *args, **kwargs) 00520 00521 def setflux(self, *args, **kwargs): 00522 """ 00523 setflux(self, which, value=initialize_variant(""), unit=string("Jy"), polarization=string("Stokes"), 00524 error=initialize_variant(""), log=True) -> bool 00525 00526 Summary 00527 Set the flux of the specified components 00528 00529 Input Parameters: 00530 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00531 value The flux values for the specified components A vector with four real or complex numbers 00532 unit The units of the flux. Any string with the same dimensions as the Jansky Jy 00533 polarization The polarization of the value field circular linear Stokes 00534 error The error in the value field. A complex vector of length four. 00535 log Send a message to the logger true 00536 00537 -------------------------------------------------------------------------------- 00538 00539 """ 00540 return _componentlist.componentlist_setflux(self, *args, **kwargs) 00541 00542 def convertfluxunit(self, *args, **kwargs): 00543 """ 00544 convertfluxunit(self, which, unit=string("Jy")) -> bool 00545 00546 Summary 00547 Change (convert) the flux units of the specified components 00548 00549 Input Parameters: 00550 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00551 unit The units of the flux. Any string with the same dimensions as the Jansky Jy 00552 00553 -------------------------------------------------------------------------------- 00554 00555 """ 00556 return _componentlist.componentlist_convertfluxunit(self, *args, **kwargs) 00557 00558 def convertfluxpol(self, *args, **kwargs): 00559 """ 00560 convertfluxpol(self, which, polarization=string("Stokes")) -> bool 00561 00562 Summary 00563 Change (convert) the polarization representation of the specified components 00564 00565 Input Parameters: 00566 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00567 polarization The new polarization representation circular linear Stokes 00568 00569 -------------------------------------------------------------------------------- 00570 00571 """ 00572 return _componentlist.componentlist_convertfluxpol(self, *args, **kwargs) 00573 00574 def getrefdir(self, *args, **kwargs): 00575 """ 00576 getrefdir(self, which) -> record * 00577 00578 Summary 00579 Return the reference direction 00580 00581 Input Parameters: 00582 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00583 00584 -------------------------------------------------------------------------------- 00585 00586 """ 00587 return _componentlist.componentlist_getrefdir(self, *args, **kwargs) 00588 00589 def getrefdirra(self, *args, **kwargs): 00590 """ 00591 getrefdirra(self, which, unit=string("deg"), precision=6) -> string 00592 00593 Summary 00594 Get the RA of the reference direction. 00595 00596 Input Parameters: 00597 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00598 unit The angular unit of the returned value. Any string containing an angular unit or 'angle' or 'time' deg 00599 precision The number of digits in the returned string. Numbers between 1 and 16 make the most sense 6 00600 00601 -------------------------------------------------------------------------------- 00602 00603 """ 00604 return _componentlist.componentlist_getrefdirra(self, *args, **kwargs) 00605 00606 def getrefdirdec(self, *args, **kwargs): 00607 """ 00608 getrefdirdec(self, which, unit=string("deg"), precision=6) -> string 00609 00610 Summary 00611 Get the declination of the reference direction. 00612 00613 Input Parameters: 00614 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00615 unit The angular unit of the returned value. Any string containing an angular unit or 'angle' or 'time' deg 00616 precision The number of digits in the returned string. Numbers between 1 and 16 make the most sense 6 00617 00618 -------------------------------------------------------------------------------- 00619 00620 """ 00621 return _componentlist.componentlist_getrefdirdec(self, *args, **kwargs) 00622 00623 def getrefdirframe(self, *args, **kwargs): 00624 """ 00625 getrefdirframe(self, which) -> string 00626 00627 Summary 00628 Get the reference frame of the reference direction. 00629 00630 Input Parameters: 00631 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00632 00633 -------------------------------------------------------------------------------- 00634 00635 """ 00636 return _componentlist.componentlist_getrefdirframe(self, *args, **kwargs) 00637 00638 def setrefdir(self, *args, **kwargs): 00639 """ 00640 setrefdir(self, which=1, ra=initialize_variant(""), dec=initialize_variant(""), log=True) -> bool 00641 00642 Summary 00643 Set the reference direction 00644 00645 Input Parameters: 00646 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 1 00647 ra The RA of the new direction, A formatted string or a number 00648 dec The declination of the new direction. A formatted string or a number 00649 log Send a message to the logger true 00650 00651 -------------------------------------------------------------------------------- 00652 00653 """ 00654 return _componentlist.componentlist_setrefdir(self, *args, **kwargs) 00655 00656 def setrefdirframe(self, *args, **kwargs): 00657 """ 00658 setrefdirframe(self, which, frame, log=True) -> bool 00659 00660 Summary 00661 Set the reference frame for the direction 00662 00663 Input Parameters: 00664 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00665 frame The new reference frame, A string like 'B1950', 'J2000' or 'galactic' 00666 log Send a message to the logger true 00667 00668 -------------------------------------------------------------------------------- 00669 00670 """ 00671 return _componentlist.componentlist_setrefdirframe(self, *args, **kwargs) 00672 00673 def convertrefdir(self, *args, **kwargs): 00674 """ 00675 convertrefdir(self, which, frame) -> bool 00676 00677 Summary 00678 Convert the reference direction to a new frame 00679 00680 Input Parameters: 00681 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00682 frame The new reference frame A string like 'B1950', 'J2000' or 'galactic' 00683 00684 -------------------------------------------------------------------------------- 00685 00686 """ 00687 return _componentlist.componentlist_convertrefdir(self, *args, **kwargs) 00688 00689 def shapetype(self, *args, **kwargs): 00690 """ 00691 shapetype(self, which) -> string 00692 00693 Summary 00694 Returns the shape type of the component 00695 00696 Input Parameters: 00697 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00698 00699 -------------------------------------------------------------------------------- 00700 00701 """ 00702 return _componentlist.componentlist_shapetype(self, *args, **kwargs) 00703 00704 def getshape(self, *args, **kwargs): 00705 """ 00706 getshape(self, which) -> record * 00707 00708 Summary 00709 Return the shape parameters the component 00710 00711 Input Parameters: 00712 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00713 00714 -------------------------------------------------------------------------------- 00715 00716 """ 00717 return _componentlist.componentlist_getshape(self, *args, **kwargs) 00718 00719 def setshape(self, *args, **kwargs): 00720 """ 00721 setshape(self, which, type=string("Point"), majoraxis=initialize_variant("1.0arcmin"), minoraxis=initialize_variant("1.0arcmin"), 00722 positionangle=initialize_variant("0.0deg"), 00723 majoraxiserror=initialize_variant("0.0arcmin"), minoraxiserror=initialize_variant("0.0arcmin"), 00724 positionangleerror=initialize_variant("0.0deg"), log=True) -> bool 00725 00726 Summary 00727 Change the shape of the component 00728 00729 Input Parameters: 00730 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00731 type The new shape type. A string that is either 'point', 'Gaussian' or 'disk' disk Gaussian Point 00732 majoraxis The width of the larger axis. A quantity with angular units 1.0arcmin 00733 minoraxis The width of the smaller axis. A quantity with angular units 1.0arcmin 00734 positionangle The rotation of the axes with respect to the reference frame. A quantity with angular units 0.0deg 00735 majoraxiserror Error ~The width of the larger axis. A quantity with angular units 0.0arcmin 00736 minoraxiserror Error of the width of the smaller axis. A quantity with angular units 0.0arcmin 00737 positionangleerror Error of the rotation of the axes with respect to the reference frame. A quantity with angular units 0.0deg 00738 log Send a message to the logger true 00739 00740 -------------------------------------------------------------------------------- 00741 00742 """ 00743 return _componentlist.componentlist_setshape(self, *args, **kwargs) 00744 00745 def convertshape(self, *args, **kwargs): 00746 """ 00747 convertshape(self, which, majoraxis=string("arcmin"), minoraxis=string("arcmin"), positionangle=string("deg")) -> bool 00748 00749 Summary 00750 Change the units of the shape parameters 00751 00752 Input Parameters: 00753 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00754 majoraxis The units to use on the larger axis. A string with angular units rad deg mas arcsec arcmin 00755 minoraxis The units to use on the smaller axis. A string with angular units rad deg mas arcsec arcmin 00756 positionangle The units to use for the rotation of these axes. A string with angular units rad deg 00757 00758 -------------------------------------------------------------------------------- 00759 00760 """ 00761 return _componentlist.componentlist_convertshape(self, *args, **kwargs) 00762 00763 def spectrumtype(self, *args, **kwargs): 00764 """ 00765 spectrumtype(self, which) -> string 00766 00767 Summary 00768 Returns the spectral shape of the component 00769 00770 Input Parameters: 00771 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00772 00773 -------------------------------------------------------------------------------- 00774 00775 """ 00776 return _componentlist.componentlist_spectrumtype(self, *args, **kwargs) 00777 00778 def getspectrum(self, *args, **kwargs): 00779 """ 00780 getspectrum(self, which) -> record * 00781 00782 Summary 00783 Return the spectral parameters the component 00784 00785 Input Parameters: 00786 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00787 00788 -------------------------------------------------------------------------------- 00789 00790 """ 00791 return _componentlist.componentlist_getspectrum(self, *args, **kwargs) 00792 00793 def setspectrum(self, *args, **kwargs): 00794 """ 00795 setspectrum(self, which, type=string("spectral index"), index=0.0, tabularfreqs=initialize_vector(1,(double)1.0e11), 00796 tabularflux=initialize_vector(1,(double)1.0), tabularframe=string("LSRK")) -> bool 00797 00798 Summary 00799 Change the spectrum of the component 00800 00801 Input Parameters: 00802 which The index specifying the component to modify. A value between 0 and one less than the list length, inclusively 00803 type The new spectrum type. A string that is either 'constant or 'spectral index' or 'tabular' spectral index spectral index constant tabular 00804 index The spectral index. 0.0 00805 tabularfreqs The frequencies of for the tabular values, in Hz 1.0e11 00806 tabularflux tabular flux density values, in Jy (same length as tabularfreqs) 1.0 00807 tabularframe The frame for which the frequencies given are in LSRK 00808 00809 -------------------------------------------------------------------------------- 00810 00811 """ 00812 return _componentlist.componentlist_setspectrum(self, *args, **kwargs) 00813 00814 def getfreq(self, *args, **kwargs): 00815 """ 00816 getfreq(self, which) -> record * 00817 00818 Summary 00819 Get the reference frequency 00820 00821 Input Parameters: 00822 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00823 00824 -------------------------------------------------------------------------------- 00825 00826 """ 00827 return _componentlist.componentlist_getfreq(self, *args, **kwargs) 00828 00829 def getfreqvalue(self, *args, **kwargs): 00830 """ 00831 getfreqvalue(self, which) -> double 00832 00833 Summary 00834 Get the reference frequency value 00835 00836 Input Parameters: 00837 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00838 00839 -------------------------------------------------------------------------------- 00840 00841 """ 00842 return _componentlist.componentlist_getfreqvalue(self, *args, **kwargs) 00843 00844 def getfrequnit(self, *args, **kwargs): 00845 """ 00846 getfrequnit(self, which) -> string 00847 00848 Summary 00849 Get the reference frequency unit 00850 00851 Input Parameters: 00852 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00853 00854 -------------------------------------------------------------------------------- 00855 00856 """ 00857 return _componentlist.componentlist_getfrequnit(self, *args, **kwargs) 00858 00859 def getfreqframe(self, *args, **kwargs): 00860 """ 00861 getfreqframe(self, which) -> string 00862 00863 Summary 00864 Get the reference frequency frame 00865 00866 Input Parameters: 00867 which An index specifying which component. An integer between 0 and one less than the list length, inclusively 00868 00869 -------------------------------------------------------------------------------- 00870 00871 """ 00872 return _componentlist.componentlist_getfreqframe(self, *args, **kwargs) 00873 00874 def setfreq(self, *args, **kwargs): 00875 """ 00876 setfreq(self, which, value, unit=string("'GHz'"), log=True) -> bool 00877 00878 Summary 00879 Set the reference frequency 00880 00881 Input Parameters: 00882 which A vector of indices specifying the components to modify A vector with indices between 0 and one less than the list length, inclusively no default 00883 value The new frequency value. A number 00884 unit The units of the frequency. Any string with the same dimensions as the 'Hz' 'GHz' 00885 log Send a message to the logger true 00886 00887 -------------------------------------------------------------------------------- 00888 00889 """ 00890 return _componentlist.componentlist_setfreq(self, *args, **kwargs) 00891 00892 def setfreqframe(self, *args, **kwargs): 00893 """ 00894 setfreqframe(self, which, frame=string("LSRK"), log=True) -> bool 00895 00896 Summary 00897 Set the reference frame for the frequency 00898 00899 Input Parameters: 00900 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00901 frame The new reference frame, A string like 'LSR', 'GEO' or 'TOPO TOPO GEO LSR LSRK 00902 log Send a message to the logger true 00903 00904 -------------------------------------------------------------------------------- 00905 00906 """ 00907 return _componentlist.componentlist_setfreqframe(self, *args, **kwargs) 00908 00909 def convertfrequnit(self, *args, **kwargs): 00910 """ 00911 convertfrequnit(self, which, unit=string("'GHz'")) -> bool 00912 00913 Summary 00914 Convert the reference frequency to a new unit 00915 00916 Input Parameters: 00917 which A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively 00918 unit The new frequency unit. Any string with the same dimensions as the 'Hz' 'GHz' 00919 00920 -------------------------------------------------------------------------------- 00921 00922 """ 00923 return _componentlist.componentlist_convertfrequnit(self, *args, **kwargs) 00924 00925 def getcomponent(self, *args, **kwargs): 00926 """ 00927 getcomponent(self, which, iknow=False) -> record * 00928 00929 Summary 00930 Extract a component from the list. 00931 00932 Input Parameters: 00933 which index of which component to extract. integers between 0 and one less than the length of the list, inclusively 00934 iknow Suppress the warning message false 00935 00936 -------------------------------------------------------------------------------- 00937 00938 """ 00939 return _componentlist.componentlist_getcomponent(self, *args, **kwargs) 00940 00941 def add(self, *args, **kwargs): 00942 """ 00943 add(self, thecomponent, iknow=True) -> bool 00944 00945 Summary 00946 Add a component to the list. 00947 00948 Input Parameters: 00949 thecomponent A record that represents a component. any record that contains the required fields 00950 iknow Suppress the warning message true 00951 00952 -------------------------------------------------------------------------------- 00953 00954 """ 00955 return _componentlist.componentlist_add(self, *args, **kwargs) 00956 00957 def replace(self, *args, **kwargs): 00958 """ 00959 replace(self, which, list, whichones=initialize_vector(1, (int)-1)) -> bool 00960 00961 Summary 00962 Replace components in the list. 00963 00964 Input Parameters: 00965 which A vector of indices specifying the components to replace. A vector with indices between 0 and one less than the list length, inclusively 00966 list The list containing the components to copy. A componentlist tool 00967 whichones A vector of indices specifying the components to copy A vector with indices between 1 and the length of the list in the second argument -1 00968 00969 -------------------------------------------------------------------------------- 00970 00971 """ 00972 return _componentlist.componentlist_replace(self, *args, **kwargs) 00973 00974 def summarize(self, *args, **kwargs): 00975 """ 00976 summarize(self, which=-1) -> bool 00977 00978 Summary 00979 Summarize the specified component to the logger 00980 00981 Input Parameters: 00982 which An index specifying which component. Unset or an integer between 0 and one less than the list length, inclusive -1 00983 00984 -------------------------------------------------------------------------------- 00985 00986 """ 00987 return _componentlist.componentlist_summarize(self, *args, **kwargs) 00988 00989 def iscomponentlist(self, *args, **kwargs): 00990 """ 00991 iscomponentlist(self, tool) -> bool 00992 00993 Summary 00994 Is the argument a componentlist tool? 00995 00996 Input Parameters: 00997 tool The variable that you wish to test 00998 00999 -------------------------------------------------------------------------------- 01000 01001 """ 01002 return _componentlist.componentlist_iscomponentlist(self, *args, **kwargs) 01003 01004 componentlist_swigregister = _componentlist.componentlist_swigregister 01005 componentlist_swigregister(componentlist) 01006 01007 # This file is compatible with both classic and new-style classes. 01008 01009
1.8.0
