00001
00002
00003
00004
00005
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('_quanta', [dirname(__file__)])
00017 except ImportError:
00018 import _quanta
00019 return _quanta
00020 if fp is not None:
00021 try:
00022 _mod = imp.load_module('_quanta', fp, pathname, description)
00023 finally:
00024 fp.close()
00025 return _mod
00026 _quanta = swig_import_helper()
00027 del swig_import_helper
00028 else:
00029 import _quanta
00030 del version_info
00031 try:
00032 _swig_property = property
00033 except NameError:
00034 pass
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 quanta(_object):
00071 """Proxy of C++ casac::quanta class"""
00072 __swig_setmethods__ = {}
00073 __setattr__ = lambda self, name, value: _swig_setattr(self, quanta, name, value)
00074 __swig_getmethods__ = {}
00075 __getattr__ = lambda self, name: _swig_getattr(self, quanta, name)
00076 __repr__ = _swig_repr
00077 def __init__(self):
00078 """__init__(self) -> quanta"""
00079 this = _quanta.new_quanta()
00080 try: self.this.append(this)
00081 except: self.this = this
00082 __swig_destroy__ = _quanta.delete_quanta
00083 __del__ = lambda self : None;
00084 def convertfreq(self, *args, **kwargs):
00085 """
00086 convertfreq(self, v=initialize_variant("1.0"), outunit=string("Hz")) -> record *
00087
00088 Summary
00089 convert a frequency quantity to another unit
00090
00091 Input Parameters:
00092 v quantity to convert 1.0
00093 outunit unit to convert to Hz
00094
00095 --------------------------------------------------------------------------------
00096
00097 """
00098 return _quanta.quanta_convertfreq(self, *args, **kwargs)
00099
00100 def convertdop(self, *args, **kwargs):
00101 """
00102 convertdop(self, v=initialize_variant("0.0"), outunit=string("km/s")) -> record *
00103
00104 Summary
00105 convert a doppler velocity quantity to another unit
00106
00107 Input Parameters:
00108 v quantity to convert 0.0
00109 outunit unit to convert to km/s
00110
00111 --------------------------------------------------------------------------------
00112
00113 """
00114 return _quanta.quanta_convertdop(self, *args, **kwargs)
00115
00116 def quantity(self, *args, **kwargs):
00117 """
00118 quantity(self, v, unitname=string("")) -> record *
00119
00120 Summary
00121 make a quantity from a string or from a numeric value
00122 and a unit string
00123
00124 Input Parameters:
00125 v quantity or numeric or string to convert to quantity
00126 unitname unit string if v numeric
00127
00128 --------------------------------------------------------------------------------
00129
00130 """
00131 return _quanta.quanta_quantity(self, *args, **kwargs)
00132
00133 def getvalue(self, *args, **kwargs):
00134 """
00135 getvalue(self, v) -> std::vector< double >
00136
00137 Summary
00138 get the internal value of a quantity
00139
00140 Input Parameters:
00141 v quantity
00142
00143 --------------------------------------------------------------------------------
00144
00145 """
00146 return _quanta.quanta_getvalue(self, *args, **kwargs)
00147
00148 def getunit(self, *args, **kwargs):
00149 """
00150 getunit(self, v) -> string
00151
00152 Summary
00153 get the internal unit of a quantity
00154
00155 Input Parameters:
00156 v quantity
00157
00158 --------------------------------------------------------------------------------
00159
00160 """
00161 return _quanta.quanta_getunit(self, *args, **kwargs)
00162
00163 def canonical(self, *args, **kwargs):
00164 """
00165 canonical(self, v=initialize_variant("1.0")) -> record *
00166
00167 Summary
00168 get canonical value of quantity
00169
00170 Input Parameters:
00171 v value to convert 1.0
00172
00173 --------------------------------------------------------------------------------
00174
00175 """
00176 return _quanta.quanta_canonical(self, *args, **kwargs)
00177
00178 def canon(self, *args, **kwargs):
00179 """
00180 canon(self, v) -> record *
00181
00182 Summary
00183 get canonical value of quantity
00184
00185 Input Parameters:
00186 v value to convert
00187
00188 --------------------------------------------------------------------------------
00189
00190 """
00191 return _quanta.quanta_canon(self, *args, **kwargs)
00192
00193 def convert(self, *args, **kwargs):
00194 """
00195 convert(self, v, outunit) -> record *
00196
00197 Summary
00198 convert a quantity to another unit
00199
00200 Input Parameters:
00201 v quantity to convert
00202 outunit unit to convert to
00203
00204 --------------------------------------------------------------------------------
00205
00206 """
00207 return _quanta.quanta_convert(self, *args, **kwargs)
00208
00209 def define(self, *args, **kwargs):
00210 """
00211 define(self, name, v=initialize_variant("1")) -> bool
00212
00213 Summary
00214 define a new unit name
00215
00216 Input Parameters:
00217 name name of unit to define
00218 v quantity value of new unit 1
00219
00220 --------------------------------------------------------------------------------
00221
00222 """
00223 return _quanta.quanta_define(self, *args, **kwargs)
00224
00225 def map(self, *args, **kwargs):
00226 """
00227 map(self, v=string("all")) -> string
00228
00229 Summary
00230 list known unit names and constants
00231
00232 Input Parameters:
00233 v type of information to list - coded string all
00234
00235 --------------------------------------------------------------------------------
00236
00237 """
00238 return _quanta.quanta_map(self, *args, **kwargs)
00239
00240 def maprec(self, *args, **kwargs):
00241 """
00242 maprec(self, v=string("all")) -> record *
00243
00244 Summary
00245 create record containing list of known unit names and
00246 constants
00247
00248 Input Parameters:
00249 v type of information to list - coded string all
00250
00251 --------------------------------------------------------------------------------
00252
00253 """
00254 return _quanta.quanta_maprec(self, *args, **kwargs)
00255
00256 def fits(self):
00257 """
00258 fits(self) -> bool
00259
00260 Summary
00261 define some FITS units
00262 --------------------------------------------------------------------------------
00263
00264 """
00265 return _quanta.quanta_fits(self)
00266
00267 def angle(self, *args, **kwargs):
00268 """
00269 angle(self, v, prec=0, form=std::vector< string >(1, ""), showform=False) -> std::vector< std::string >
00270
00271 Summary
00272 show an angle as a formatted string
00273
00274 Input Parameters:
00275 v angle quantity value to output
00276 prec number of digits shown 0
00277 form formatting information in coded string array
00278 showform show square brackets and separating , false
00279
00280 --------------------------------------------------------------------------------
00281
00282 """
00283 return _quanta.quanta_angle(self, *args, **kwargs)
00284
00285 def time(self, *args, **kwargs):
00286 """
00287 time(self, v, prec=0, form=std::vector< string >(1, ""), showform=False) -> std::vector< std::string >
00288
00289 Summary
00290 show a time (or date) as a formatted string
00291
00292 Input Parameters:
00293 v time quantity value to output
00294 prec number of digits shown 0
00295 form formatting information in coded string array
00296 showform show square brackets and separating , false
00297
00298 --------------------------------------------------------------------------------
00299
00300 """
00301 return _quanta.quanta_time(self, *args, **kwargs)
00302
00303 def add(self, *args, **kwargs):
00304 """
00305 add(self, v, a=initialize_variant("0")) -> record *
00306
00307 Summary
00308 add quantities
00309
00310 Input Parameters:
00311 v value
00312 a value 0
00313
00314 --------------------------------------------------------------------------------
00315
00316 """
00317 return _quanta.quanta_add(self, *args, **kwargs)
00318
00319 def sub(self, *args, **kwargs):
00320 """
00321 sub(self, v, a=initialize_variant("0")) -> record *
00322
00323 Summary
00324 subtract quantities
00325
00326 Input Parameters:
00327 v value
00328 a value 0
00329
00330 --------------------------------------------------------------------------------
00331
00332 """
00333 return _quanta.quanta_sub(self, *args, **kwargs)
00334
00335 def mul(self, *args, **kwargs):
00336 """
00337 mul(self, v, a=initialize_variant("1")) -> record *
00338
00339 Summary
00340 multiply quantities
00341
00342 Input Parameters:
00343 v value
00344 a value 1
00345
00346 --------------------------------------------------------------------------------
00347
00348 """
00349 return _quanta.quanta_mul(self, *args, **kwargs)
00350
00351 def div(self, *args, **kwargs):
00352 """
00353 div(self, v, a=initialize_variant("1")) -> record *
00354
00355 Summary
00356 divides quantities
00357
00358 Input Parameters:
00359 v value
00360 a value 1
00361
00362 --------------------------------------------------------------------------------
00363
00364 """
00365 return _quanta.quanta_div(self, *args, **kwargs)
00366
00367 def neg(self, *args, **kwargs):
00368 """
00369 neg(self, v=initialize_variant("1")) -> record *
00370
00371 Summary
00372 negate quantities
00373
00374 Input Parameters:
00375 v value 1
00376
00377 --------------------------------------------------------------------------------
00378
00379 """
00380 return _quanta.quanta_neg(self, *args, **kwargs)
00381
00382 def norm(self, *args, **kwargs):
00383 """
00384 norm(self, v, a=-0.5) -> record *
00385
00386 Summary
00387 normalise angle
00388
00389 Input Parameters:
00390 v angle quantity
00391 a lower interval boundary -0.5
00392
00393 --------------------------------------------------------------------------------
00394
00395 """
00396 return _quanta.quanta_norm(self, *args, **kwargs)
00397
00398 def le(self, *args, **kwargs):
00399 """
00400 le(self, v, a=initialize_variant("0")) -> bool
00401
00402 Summary
00403 compare quantities
00404
00405 Input Parameters:
00406 v value
00407 a value 0
00408
00409 --------------------------------------------------------------------------------
00410
00411 """
00412 return _quanta.quanta_le(self, *args, **kwargs)
00413
00414 def lt(self, *args, **kwargs):
00415 """
00416 lt(self, v, a=initialize_variant("0")) -> bool
00417
00418 Summary
00419 compare quantities
00420
00421 Input Parameters:
00422 v value
00423 a value 0
00424
00425 --------------------------------------------------------------------------------
00426
00427 """
00428 return _quanta.quanta_lt(self, *args, **kwargs)
00429
00430 def eq(self, *args, **kwargs):
00431 """
00432 eq(self, v, a=initialize_variant("0")) -> bool
00433
00434 Summary
00435 compare quantities
00436
00437 Input Parameters:
00438 v value
00439 a value 0
00440
00441 --------------------------------------------------------------------------------
00442
00443 """
00444 return _quanta.quanta_eq(self, *args, **kwargs)
00445
00446 def ne(self, *args, **kwargs):
00447 """
00448 ne(self, v, a=initialize_variant("0")) -> bool
00449
00450 Summary
00451 compare quantities
00452
00453 Input Parameters:
00454 v value
00455 a value 0
00456
00457 --------------------------------------------------------------------------------
00458
00459 """
00460 return _quanta.quanta_ne(self, *args, **kwargs)
00461
00462 def gt(self, *args, **kwargs):
00463 """
00464 gt(self, v, a=initialize_variant("0")) -> bool
00465
00466 Summary
00467 compare quantities
00468
00469 Input Parameters:
00470 v value
00471 a value 0
00472
00473 --------------------------------------------------------------------------------
00474
00475 """
00476 return _quanta.quanta_gt(self, *args, **kwargs)
00477
00478 def ge(self, *args, **kwargs):
00479 """
00480 ge(self, v, a=initialize_variant("0")) -> bool
00481
00482 Summary
00483 compare quantities
00484
00485 Input Parameters:
00486 v value
00487 a value 0
00488
00489 --------------------------------------------------------------------------------
00490
00491 """
00492 return _quanta.quanta_ge(self, *args, **kwargs)
00493
00494 def sin(self, *args, **kwargs):
00495 """
00496 sin(self, v) -> record *
00497
00498 Summary
00499 sine of quantity
00500
00501 Input Parameters:
00502 v angle quantity
00503
00504 --------------------------------------------------------------------------------
00505
00506 """
00507 return _quanta.quanta_sin(self, *args, **kwargs)
00508
00509 def cos(self, *args, **kwargs):
00510 """
00511 cos(self, v) -> record *
00512
00513 Summary
00514 cosine of quantity
00515
00516 Input Parameters:
00517 v angle quantity
00518
00519 --------------------------------------------------------------------------------
00520
00521 """
00522 return _quanta.quanta_cos(self, *args, **kwargs)
00523
00524 def tan(self, *args, **kwargs):
00525 """
00526 tan(self, v) -> record *
00527
00528 Summary
00529 tangent of quantity
00530
00531 Input Parameters:
00532 v angle quantity
00533
00534 --------------------------------------------------------------------------------
00535
00536 """
00537 return _quanta.quanta_tan(self, *args, **kwargs)
00538
00539 def asin(self, *args, **kwargs):
00540 """
00541 asin(self, v) -> record *
00542
00543 Summary
00544 arcsine of quantity
00545
00546 Input Parameters:
00547 v non-dimensioned quantity
00548
00549 --------------------------------------------------------------------------------
00550
00551 """
00552 return _quanta.quanta_asin(self, *args, **kwargs)
00553
00554 def acos(self, *args, **kwargs):
00555 """
00556 acos(self, v) -> record *
00557
00558 Summary
00559 arccosine of quantity
00560
00561 Input Parameters:
00562 v non-dimensioned quantity
00563
00564 --------------------------------------------------------------------------------
00565
00566 """
00567 return _quanta.quanta_acos(self, *args, **kwargs)
00568
00569 def atan(self, *args, **kwargs):
00570 """
00571 atan(self, v) -> record *
00572
00573 Summary
00574 arctangent of quantity
00575
00576 Input Parameters:
00577 v non-dimensioned quantity
00578
00579 --------------------------------------------------------------------------------
00580
00581 """
00582 return _quanta.quanta_atan(self, *args, **kwargs)
00583
00584 def atan2(self, *args, **kwargs):
00585 """
00586 atan2(self, v, a) -> record *
00587
00588 Summary
00589 arctangent of two quantity
00590
00591 Input Parameters:
00592 v non-dimensioned quantity
00593 a non-dimensioned quantity
00594
00595 --------------------------------------------------------------------------------
00596
00597 """
00598 return _quanta.quanta_atan2(self, *args, **kwargs)
00599
00600 def abs(self, *args, **kwargs):
00601 """
00602 abs(self, v) -> record *
00603
00604 Summary
00605 absolute value of quantity
00606
00607 Input Parameters:
00608 v value
00609
00610 --------------------------------------------------------------------------------
00611
00612 """
00613 return _quanta.quanta_abs(self, *args, **kwargs)
00614
00615 def ceil(self, *args, **kwargs):
00616 """
00617 ceil(self, v) -> record *
00618
00619 Summary
00620 ceil value of quantity
00621
00622 Input Parameters:
00623 v value
00624
00625 --------------------------------------------------------------------------------
00626
00627 """
00628 return _quanta.quanta_ceil(self, *args, **kwargs)
00629
00630 def floor(self, *args, **kwargs):
00631 """
00632 floor(self, v) -> record *
00633
00634 Summary
00635 floor value of quantity
00636
00637 Input Parameters:
00638 v value
00639
00640 --------------------------------------------------------------------------------
00641
00642 """
00643 return _quanta.quanta_floor(self, *args, **kwargs)
00644
00645 def log(self, *args, **kwargs):
00646 """
00647 log(self, v) -> record *
00648
00649 Summary
00650 logarithm of quantity
00651
00652 Input Parameters:
00653 v dimensionless quantity
00654
00655 --------------------------------------------------------------------------------
00656
00657 """
00658 return _quanta.quanta_log(self, *args, **kwargs)
00659
00660 def log10(self, *args, **kwargs):
00661 """
00662 log10(self, v) -> record *
00663
00664 Summary
00665 logarithm of quantity
00666
00667 Input Parameters:
00668 v dimensionless quantity
00669
00670 --------------------------------------------------------------------------------
00671
00672 """
00673 return _quanta.quanta_log10(self, *args, **kwargs)
00674
00675 def exp(self, *args, **kwargs):
00676 """
00677 exp(self, v) -> record *
00678
00679 Summary
00680 exponential of quantity
00681
00682 Input Parameters:
00683 v dimensionless quantity
00684
00685 --------------------------------------------------------------------------------
00686
00687 """
00688 return _quanta.quanta_exp(self, *args, **kwargs)
00689
00690 def sqrt(self, *args, **kwargs):
00691 """
00692 sqrt(self, v) -> record *
00693
00694 Summary
00695 square root of quantity
00696
00697 Input Parameters:
00698 v dimensionless quantity
00699
00700 --------------------------------------------------------------------------------
00701
00702 """
00703 return _quanta.quanta_sqrt(self, *args, **kwargs)
00704
00705 def compare(self, *args, **kwargs):
00706 """
00707 compare(self, v, a) -> bool
00708
00709 Summary
00710 compare dimensionality of units
00711
00712 Input Parameters:
00713 v value
00714 a value
00715
00716 --------------------------------------------------------------------------------
00717
00718 """
00719 return _quanta.quanta_compare(self, *args, **kwargs)
00720
00721 def check(self, *args, **kwargs):
00722 """
00723 check(self, v) -> bool
00724
00725 Summary
00726 check for proper unit string
00727
00728 Input Parameters:
00729 v value
00730
00731 --------------------------------------------------------------------------------
00732
00733 """
00734 return _quanta.quanta_check(self, *args, **kwargs)
00735
00736 def checkfreq(self, *args, **kwargs):
00737 """
00738 checkfreq(self, cm) -> bool
00739
00740 Summary
00741 check for proper frequency unit
00742
00743 Input Parameters:
00744 cm value
00745
00746 --------------------------------------------------------------------------------
00747
00748 """
00749 return _quanta.quanta_checkfreq(self, *args, **kwargs)
00750
00751 def pow(self, *args, **kwargs):
00752 """
00753 pow(self, v, a=1) -> record *
00754
00755 Summary
00756 raise quantity to power
00757
00758 Input Parameters:
00759 v value
00760 a power 1
00761
00762 --------------------------------------------------------------------------------
00763
00764 """
00765 return _quanta.quanta_pow(self, *args, **kwargs)
00766
00767 def constants(self, *args, **kwargs):
00768 """
00769 constants(self, v=string("pi")) -> record *
00770
00771 Summary
00772 get a constant
00773
00774 Input Parameters:
00775 v name pi
00776
00777 --------------------------------------------------------------------------------
00778
00779 """
00780 return _quanta.quanta_constants(self, *args, **kwargs)
00781
00782 def isangle(self, *args, **kwargs):
00783 """
00784 isangle(self, v) -> bool
00785
00786 Summary
00787 check if valid angle or time quantity
00788
00789 Input Parameters:
00790 v angle/time quantity
00791
00792 --------------------------------------------------------------------------------
00793
00794 """
00795 return _quanta.quanta_isangle(self, *args, **kwargs)
00796
00797 def totime(self, *args, **kwargs):
00798 """
00799 totime(self, v) -> record *
00800
00801 Summary
00802 convert an angle (or a time) to a time
00803
00804 Input Parameters:
00805 v angle/time quantity
00806
00807 --------------------------------------------------------------------------------
00808
00809 """
00810 return _quanta.quanta_totime(self, *args, **kwargs)
00811
00812 def toangle(self, *args, **kwargs):
00813 """
00814 toangle(self, v) -> record *
00815
00816 Summary
00817 convert a time (or an angle) to an angle
00818
00819 Input Parameters:
00820 v angle/time quantity
00821
00822 --------------------------------------------------------------------------------
00823
00824 """
00825 return _quanta.quanta_toangle(self, *args, **kwargs)
00826
00827 def splitdate(self, *args, **kwargs):
00828 """
00829 splitdate(self, v) -> record *
00830
00831 Summary
00832 split a date/time into a record
00833
00834 Input Parameters:
00835 v angle/time quantity
00836
00837 --------------------------------------------------------------------------------
00838
00839 """
00840 return _quanta.quanta_splitdate(self, *args, **kwargs)
00841
00842 def tos(self, *args, **kwargs):
00843 """
00844 tos(self, v, prec=9) -> string
00845
00846 Summary
00847 convert quantity to string
00848
00849 Input Parameters:
00850 v value
00851 prec convert precision of value 9
00852
00853 --------------------------------------------------------------------------------
00854
00855 """
00856 return _quanta.quanta_tos(self, *args, **kwargs)
00857
00858 def type(self):
00859 """
00860 type(self) -> string
00861
00862 Summary
00863 type of tool
00864 --------------------------------------------------------------------------------
00865
00866 """
00867 return _quanta.quanta_type(self)
00868
00869 def done(self, kill=False):
00870 """
00871 done(self, kill=False) -> bool
00872
00873 Summary
00874 Free resources used by tool. Current implementation
00875 ignores input parameter, does nothing and returns true
00876
00877 Input Parameters:
00878 kill force kill of the default tool (ignored) false
00879
00880 --------------------------------------------------------------------------------
00881
00882 """
00883 return _quanta.quanta_done(self, kill)
00884
00885 def unit(self, *args, **kwargs):
00886 """
00887 unit(self, v, unitname=string("")) -> record *
00888
00889 Summary
00890 quantity from value v and unit string
00891
00892 Input Parameters:
00893 v
00894 unitname
00895
00896 --------------------------------------------------------------------------------
00897
00898 """
00899 return _quanta.quanta_unit(self, *args, **kwargs)
00900
00901 def isquantity(self, *args, **kwargs):
00902 """
00903 isquantity(self, v) -> bool
00904
00905 Summary
00906 Check if quantity
00907
00908 Input Parameters:
00909 v value to be tested
00910
00911 --------------------------------------------------------------------------------
00912
00913 """
00914 return _quanta.quanta_isquantity(self, *args, **kwargs)
00915
00916 def setformat(self, *args, **kwargs):
00917 """
00918 setformat(self, t=string(""), v=string("F")) -> bool
00919
00920 Summary
00921 set format for output of numbers.
00922 (NOT IMPLEMENTED YET!)
00923
00924 Input Parameters:
00925 t type -coded string indicating which format parameter to set
00926 v format parameter value - numeric or coded string, depending on format type to be set F
00927
00928 --------------------------------------------------------------------------------
00929
00930 """
00931 return _quanta.quanta_setformat(self, *args, **kwargs)
00932
00933 def getformat(self, *args, **kwargs):
00934 """
00935 getformat(self, t=string("")) -> string
00936
00937 Summary
00938 get current output format
00939 (NOT IMPLEMENTED YET!)
00940
00941 Input Parameters:
00942 t type - coded string
00943
00944 --------------------------------------------------------------------------------
00945
00946 """
00947 return _quanta.quanta_getformat(self, *args, **kwargs)
00948
00949 def formxxx(self, *args, **kwargs):
00950 """
00951 formxxx(self, v, format=string("dms"), prec=2) -> string
00952
00953 Summary
00954 Format a quantity using given format, allowed are hms, dms, deg, rad, +deg.
00955
00956
00957 Input Parameters:
00958 v value to be converted
00959 format xxx can be hms, dms, deg, rad or +deg dms
00960 prec # digits in fractional part of output string for dms,hms 2
00961
00962 --------------------------------------------------------------------------------
00963
00964 """
00965 return _quanta.quanta_formxxx(self, *args, **kwargs)
00966
00967 quanta_swigregister = _quanta.quanta_swigregister
00968 quanta_swigregister(quanta)
00969
00970
00971
00972