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('_coordsys', [dirname(__file__)])
00017 except ImportError:
00018 import _coordsys
00019 return _coordsys
00020 if fp is not None:
00021 try:
00022 _mod = imp.load_module('_coordsys', fp, pathname, description)
00023 finally:
00024 fp.close()
00025 return _mod
00026 _coordsys = swig_import_helper()
00027 del swig_import_helper
00028 else:
00029 import _coordsys
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 coordsys(_object):
00071 """Proxy of C++ casac::coordsys class"""
00072 __swig_setmethods__ = {}
00073 __setattr__ = lambda self, name, value: _swig_setattr(self, coordsys, name, value)
00074 __swig_getmethods__ = {}
00075 __getattr__ = lambda self, name: _swig_getattr(self, coordsys, name)
00076 __repr__ = _swig_repr
00077 __swig_setmethods__["_coordinate_findaxis"] = _coordsys.coordsys__coordinate_findaxis_set
00078 __swig_getmethods__["_coordinate_findaxis"] = _coordsys.coordsys__coordinate_findaxis_get
00079 if _newclass:_coordinate_findaxis = _swig_property(_coordsys.coordsys__coordinate_findaxis_get, _coordsys.coordsys__coordinate_findaxis_set)
00080 __swig_setmethods__["_axisincoordinate_findaxis"] = _coordsys.coordsys__axisincoordinate_findaxis_set
00081 __swig_getmethods__["_axisincoordinate_findaxis"] = _coordsys.coordsys__axisincoordinate_findaxis_get
00082 if _newclass:_axisincoordinate_findaxis = _swig_property(_coordsys.coordsys__axisincoordinate_findaxis_get, _coordsys.coordsys__axisincoordinate_findaxis_set)
00083 __swig_setmethods__["_pixel_findcoordinate"] = _coordsys.coordsys__pixel_findcoordinate_set
00084 __swig_getmethods__["_pixel_findcoordinate"] = _coordsys.coordsys__pixel_findcoordinate_get
00085 if _newclass:_pixel_findcoordinate = _swig_property(_coordsys.coordsys__pixel_findcoordinate_get, _coordsys.coordsys__pixel_findcoordinate_set)
00086 __swig_setmethods__["_world_findcoordinate"] = _coordsys.coordsys__world_findcoordinate_set
00087 __swig_getmethods__["_world_findcoordinate"] = _coordsys.coordsys__world_findcoordinate_get
00088 if _newclass:_world_findcoordinate = _swig_property(_coordsys.coordsys__world_findcoordinate_get, _coordsys.coordsys__world_findcoordinate_set)
00089 def __init__(self):
00090 """__init__(self) -> coordsys"""
00091 this = _coordsys.new_coordsys()
00092 try: self.this.append(this)
00093 except: self.this = this
00094 __swig_destroy__ = _coordsys.delete_coordsys
00095 __del__ = lambda self : None;
00096 def newcoordsys(self, *args, **kwargs):
00097 """
00098 newcoordsys(self, direction=False, spectral=False, stokes=std::vector< string >(1, ""), linear=0, tabular=False) -> coordsys
00099
00100 Summary
00101 Create a non-default coordsys tool
00102
00103 Input Parameters:
00104 direction Make a direction coordinate ? false
00105 spectral Make a spectral coordinate ? false
00106 stokes Make a Stokes coordinate with these Stokes I Q U V XX YY XY YX RR LL RL LR
00107 linear Make a linear coordinate with this many axes 0
00108 tabular Make a tabular coordinate false
00109
00110 --------------------------------------------------------------------------------
00111
00112 """
00113 return _coordsys.coordsys_newcoordsys(self, *args, **kwargs)
00114
00115 def addcoordinate(self, *args, **kwargs):
00116 """
00117 addcoordinate(self, direction=False, spectral=False, stokes=std::vector< string >(1, ""), linear=0, tabular=False) -> bool
00118
00119 Summary
00120 Add default coordinates. (For assay testing only.)
00121
00122 Input Parameters:
00123 direction Add a direction coordinate ? false
00124 spectral Add a spectral coordinate ? false
00125 stokes Add a Stokes coordinate with these Stokes I Q U V XX YY XY YX RR LL RL LR
00126 linear Add a linear coordinate with this many axes 0
00127 tabular Add a tabular coordinate false
00128
00129 --------------------------------------------------------------------------------
00130
00131 """
00132 return _coordsys.coordsys_addcoordinate(self, *args, **kwargs)
00133
00134 def axesmap(self, toworld=True):
00135 """
00136 axesmap(self, toworld=True) -> std::vector< int >
00137
00138 Summary
00139 Find mapping between world and pixel axes
00140
00141 Input Parameters:
00142 toworld Map from pixel to world ? true
00143
00144 --------------------------------------------------------------------------------
00145
00146 """
00147 return _coordsys.coordsys_axesmap(self, toworld)
00148
00149 def axiscoordinatetypes(self, world=True):
00150 """
00151 axiscoordinatetypes(self, world=True) -> std::vector< std::string >
00152
00153 Summary
00154 Return types of coordinates for each axis
00155
00156 Input Parameters:
00157 world World or pixel axes ? true
00158
00159 --------------------------------------------------------------------------------
00160
00161 """
00162 return _coordsys.coordsys_axiscoordinatetypes(self, world)
00163
00164 def conversiontype(self, *args, **kwargs):
00165 """
00166 conversiontype(self, type=string("direction")) -> string
00167
00168 Summary
00169 Get extra reference conversion layer
00170
00171 Input Parameters:
00172 type Coordinate type, direction, spectral direction
00173
00174 --------------------------------------------------------------------------------
00175
00176 """
00177 return _coordsys.coordsys_conversiontype(self, *args, **kwargs)
00178
00179 def convert(self, *args, **kwargs):
00180 """
00181 convert(self, coordin, absin=initialize_vector(1, (bool)true), dopplerin=string("radio"), unitsin=std::vector< string >(1, ""),
00182 absout=initialize_vector(1, (bool)true), dopplerout=string("radio"),
00183 unitsout=std::vector< string >(1, ""), shape=initialize_vector(1, (int)-1)) -> std::vector< double >
00184
00185 Summary
00186 Convert a numeric mixed coordinate
00187
00188 Input Parameters:
00189 coordin Input coordinate, as a numeric vector
00190 absin Are input coordinate elements absolute ? true
00191 dopplerin Input doppler type for velocities radio
00192 unitsin Input units, string vector Native
00193 absout Are output coordinate elements absolute ? true
00194 dopplerout Output doppler type for velocities radio
00195 unitsout Output units Native
00196 shape Image shape, integer vector -1
00197
00198 --------------------------------------------------------------------------------
00199
00200 """
00201 return _coordsys.coordsys_convert(self, *args, **kwargs)
00202
00203 def convertmany(self, *args, **kwargs):
00204 """
00205 convertmany(self, coordin, absin=initialize_vector(1, (bool)true), dopplerin=string("radio"), unitsin=std::vector< string >(1, ""),
00206 absout=initialize_vector(1, (bool)true), dopplerout=string("radio"),
00207 unitsout=std::vector< string >(1, ""), shape=initialize_vector(1, (int)-1)) -> variant *
00208
00209 Summary
00210 Convert many numeric mixed coordinates
00211
00212 Input Parameters:
00213 coordin Input coordinate, numeric matrix
00214 absin Are input coordinate elements absolute ? true
00215 dopplerin Input doppler type for velocities radio
00216 unitsin Input units, string vector Native
00217 absout Are output coordinate elements absolute ? true
00218 dopplerout Output doppler type for velocities radio
00219 unitsout Output units Native
00220 shape Image shape, integer array -1
00221
00222 --------------------------------------------------------------------------------
00223
00224 """
00225 return _coordsys.coordsys_convertmany(self, *args, **kwargs)
00226
00227 def coordinatetype(self, *args, **kwargs):
00228 """
00229 coordinatetype(self, which=-1) -> std::vector< std::string >
00230
00231 Summary
00232 Return type of specified coordinate
00233
00234 Input Parameters:
00235 which Which coordinate ? (0-rel) -1
00236
00237 --------------------------------------------------------------------------------
00238
00239 """
00240 return _coordsys.coordsys_coordinatetype(self, *args, **kwargs)
00241
00242 def copy(self):
00243 """
00244 copy(self) -> coordsys
00245
00246 Summary
00247 Copy this Coordsys tool
00248 --------------------------------------------------------------------------------
00249
00250 """
00251 return _coordsys.coordsys_copy(self)
00252
00253 def done(self):
00254 """
00255 done(self) -> bool
00256
00257 Summary
00258 Destroy this Coordsys tool, restore default tool
00259 --------------------------------------------------------------------------------
00260
00261 """
00262 return _coordsys.coordsys_done(self)
00263
00264 def epoch(self):
00265 """
00266 epoch(self) -> record *
00267
00268 Summary
00269 Return the epoch
00270 --------------------------------------------------------------------------------
00271
00272 """
00273 return _coordsys.coordsys_epoch(self)
00274
00275 def findaxis(self, *args, **kwargs):
00276 """
00277 findaxis(self, world=True, axis=0, _coordinate=_coordinate_findaxis, _axisincoordinate=_axisincoordinate_findaxis) -> bool
00278
00279 Summary
00280 Find specified axis in coordinate system
00281
00282 Input Parameters:
00283 world is axis a world or pixel axis ? true
00284 axis Axis in coordinate system 0
00285
00286
00287 Output Parameters:
00288 _coordinate Coordinate number
00289 _axisincoordinate Axis in the coordinate
00290
00291 --------------------------------------------------------------------------------
00292
00293 """
00294 return _coordsys.coordsys_findaxis(self, *args, **kwargs)
00295
00296 def findcoordinate(self, *args, **kwargs):
00297 """
00298 findcoordinate(self, type=string("direction"), which=0, _pixel=_pixel_findcoordinate, _world=_world_findcoordinate) -> bool
00299
00300 Summary
00301 Find axes of specified coordinate
00302
00303 Input Parameters:
00304 type Type of coordinate to find: direction, stokes, spectral, linear, or tabular direction
00305 which Which coordinate if more than one 0
00306
00307
00308 Output Parameters:
00309 _pixel Pixel axes
00310 _world World axes
00311
00312 --------------------------------------------------------------------------------
00313
00314 """
00315 return _coordsys.coordsys_findcoordinate(self, *args, **kwargs)
00316
00317 def frequencytofrequency(self, *args, **kwargs):
00318 """
00319 frequencytofrequency(self, value, frequnit=string(""), velocity=initialize_variant(""), doppler=string("radio")) -> std::vector< double >
00320
00321 Summary
00322 Convert frequency to frequency with an offset
00323
00324 Input Parameters:
00325 value Frequency to convert
00326 frequnit Unit of input frequencies. Default is unit of the spectral coordinate.
00327 velocity Velocity offset
00328 doppler Velocity doppler definition radio
00329
00330 --------------------------------------------------------------------------------
00331
00332 """
00333 return _coordsys.coordsys_frequencytofrequency(self, *args, **kwargs)
00334
00335 def frequencytovelocity(self, *args, **kwargs):
00336 """
00337 frequencytovelocity(self, value, frequnit=string(""), doppler=string("radio"), velunit=string("km/s")) -> std::vector< double >
00338
00339 Summary
00340 Convert frequency to velocity
00341
00342 Input Parameters:
00343 value Frequency to convert
00344 frequnit Unit of input frequencies. Default is unit of the spectral coordinate.
00345 doppler Velocity doppler definition radio
00346 velunit Unit of output velocities km/s
00347
00348 --------------------------------------------------------------------------------
00349
00350 """
00351 return _coordsys.coordsys_frequencytovelocity(self, *args, **kwargs)
00352
00353 def fromrecord(self, *args, **kwargs):
00354 """
00355 fromrecord(self, record) -> bool
00356
00357 Summary
00358 Fill Coordinate System from a record
00359
00360 Input Parameters:
00361 record Record containing Coordinate System
00362
00363 --------------------------------------------------------------------------------
00364
00365 """
00366 return _coordsys.coordsys_fromrecord(self, *args, **kwargs)
00367
00368 def increment(self, *args, **kwargs):
00369 """
00370 increment(self, format=string("n"), type=string("")) -> record *
00371
00372 Summary
00373 Recover the increments
00374
00375 Input Parameters:
00376 format Format string from combination of 'n', 'q', 's', 'm' n
00377 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00378
00379 --------------------------------------------------------------------------------
00380
00381 """
00382 return _coordsys.coordsys_increment(self, *args, **kwargs)
00383
00384 def lineartransform(self, *args, **kwargs):
00385 """
00386 lineartransform(self, type) -> variant *
00387
00388 Summary
00389 Recover the linear transform matrix
00390
00391 Input Parameters:
00392 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'
00393
00394 --------------------------------------------------------------------------------
00395
00396 """
00397 return _coordsys.coordsys_lineartransform(self, *args, **kwargs)
00398
00399 def names(self, *args, **kwargs):
00400 """
00401 names(self, type=string("")) -> std::vector< std::string >
00402
00403 Summary
00404 Recover the names for each axis
00405
00406 Input Parameters:
00407 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00408
00409 --------------------------------------------------------------------------------
00410
00411 """
00412 return _coordsys.coordsys_names(self, *args, **kwargs)
00413
00414 def naxes(self, world=True):
00415 """
00416 naxes(self, world=True) -> int
00417
00418 Summary
00419 Recover the number of axes
00420
00421 Input Parameters:
00422 world Find number of world or pixel axes ? true
00423
00424 --------------------------------------------------------------------------------
00425
00426 """
00427 return _coordsys.coordsys_naxes(self, world)
00428
00429 def ncoordinates(self):
00430 """
00431 ncoordinates(self) -> int
00432
00433 Summary
00434 Recover the number of coordinates in the Coordinate System
00435 --------------------------------------------------------------------------------
00436
00437 """
00438 return _coordsys.coordsys_ncoordinates(self)
00439
00440 def observer(self):
00441 """
00442 observer(self) -> string
00443
00444 Summary
00445 Return the name of the observer
00446 --------------------------------------------------------------------------------
00447
00448 """
00449 return _coordsys.coordsys_observer(self)
00450
00451 def projection(self, *args, **kwargs):
00452 """
00453 projection(self, type=string("")) -> record *
00454
00455 Summary
00456 Recover the direction coordinate projection
00457
00458 Input Parameters:
00459 type Type of projection. Defaults to current projection.
00460
00461 --------------------------------------------------------------------------------
00462
00463 """
00464 return _coordsys.coordsys_projection(self, *args, **kwargs)
00465
00466 def referencecode(self, *args, **kwargs):
00467 """
00468 referencecode(self, type=string(""), list=False) -> std::vector< std::string >
00469
00470 Summary
00471 Return specified reference code
00472
00473 Input Parameters:
00474 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00475 list List all possibilities? false
00476
00477 --------------------------------------------------------------------------------
00478
00479 """
00480 return _coordsys.coordsys_referencecode(self, *args, **kwargs)
00481
00482 def referencepixel(self, *args, **kwargs):
00483 """
00484 referencepixel(self, type=string("")) -> record *
00485
00486 Summary
00487 Recover the reference pixel
00488
00489 Input Parameters:
00490 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00491
00492 --------------------------------------------------------------------------------
00493
00494 """
00495 return _coordsys.coordsys_referencepixel(self, *args, **kwargs)
00496
00497 def referencevalue(self, *args, **kwargs):
00498 """
00499 referencevalue(self, format=string("n"), type=string("")) -> record *
00500
00501 Summary
00502 Recover the reference value
00503
00504 Input Parameters:
00505 format Format string. Combination of 'n', 'q', 's', 'm' n
00506 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00507
00508 --------------------------------------------------------------------------------
00509
00510 """
00511 return _coordsys.coordsys_referencevalue(self, *args, **kwargs)
00512
00513 def reorder(self, *args, **kwargs):
00514 """
00515 reorder(self, order) -> bool
00516
00517 Summary
00518 Reorder the coordinates
00519
00520 Input Parameters:
00521 order New coordinate order
00522
00523 --------------------------------------------------------------------------------
00524
00525 """
00526 return _coordsys.coordsys_reorder(self, *args, **kwargs)
00527
00528 def replace(self, *args, **kwargs):
00529 """
00530 replace(self, csys, whichin, whichout) -> bool
00531
00532 Summary
00533 Replace a coordinate
00534
00535 Input Parameters:
00536 csys Coordinate System to replace from. Use coordsys' torecord() to generate required record.
00537 whichin Index of input coordinate (0-rel)
00538 whichout Index of output coordinate
00539
00540 --------------------------------------------------------------------------------
00541
00542 """
00543 return _coordsys.coordsys_replace(self, *args, **kwargs)
00544
00545 def restfrequency(self):
00546 """
00547 restfrequency(self) -> record *
00548
00549 Summary
00550 Recover the rest frequency
00551 --------------------------------------------------------------------------------
00552
00553 """
00554 return _coordsys.coordsys_restfrequency(self)
00555
00556 def setconversiontype(self, *args, **kwargs):
00557 """
00558 setconversiontype(self, direction=string(""), spectral=string("")) -> bool
00559
00560 Summary
00561 Set extra reference conversion layer
00562
00563 Input Parameters:
00564 direction Reference code
00565 spectral Reference code
00566
00567 --------------------------------------------------------------------------------
00568
00569 """
00570 return _coordsys.coordsys_setconversiontype(self, *args, **kwargs)
00571
00572 def getconversiontype(self, *args, **kwargs):
00573 """
00574 getconversiontype(self, type=string(""), showconversion=True) -> string
00575
00576 Summary
00577 Get extra reference conversion layer
00578 (aka conversiontype).
00579
00580 Input Parameters:
00581 type Conversion type
00582 showconversion Show the conversion layer true
00583
00584 --------------------------------------------------------------------------------
00585
00586 """
00587 return _coordsys.coordsys_getconversiontype(self, *args, **kwargs)
00588
00589 def setdirection(self, *args, **kwargs):
00590 """
00591 setdirection(self, refcode=string(""), proj=string(""), projpar=initialize_vector(1, (double)-1), refpix=initialize_vector(1, (double)-1),
00592 refval=initialize_variant(""), incr=initialize_variant(""),
00593 xform=initialize_variant(""), poles=initialize_variant("")) -> bool
00594
00595 Summary
00596 Set direction coordinate values
00597
00598 Input Parameters:
00599 refcode Reference code. Default is no change.
00600 proj Projection type. Default is no change.
00601 projpar Projection parameters. Default is no change. -1
00602 refpix Reference pixel. Default is no change. -1
00603 refval Reference value. Default is no change.
00604 incr Increment. Default is no change.
00605 xform Linear transform. Default is no change.
00606 poles Native poles. Default is no change.
00607
00608 --------------------------------------------------------------------------------
00609
00610 """
00611 return _coordsys.coordsys_setdirection(self, *args, **kwargs)
00612
00613 def setepoch(self, *args, **kwargs):
00614 """
00615 setepoch(self, value) -> bool
00616
00617 Summary
00618 Set a new epoch
00619
00620 Input Parameters:
00621 value New epoch measure
00622
00623 --------------------------------------------------------------------------------
00624
00625 """
00626 return _coordsys.coordsys_setepoch(self, *args, **kwargs)
00627
00628 def setincrement(self, *args, **kwargs):
00629 """
00630 setincrement(self, value=initialize_variant(""), type=string("")) -> bool
00631
00632 Summary
00633 Set the increment
00634
00635 Input Parameters:
00636 value Increments
00637 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all
00638
00639 --------------------------------------------------------------------------------
00640
00641 """
00642 return _coordsys.coordsys_setincrement(self, *args, **kwargs)
00643
00644 def setlineartransform(self, *args, **kwargs):
00645 """
00646 setlineartransform(self, type=string(""), value=initialize_variant("")) -> bool
00647
00648 Summary
00649 Set the linear transform
00650
00651 Input Parameters:
00652 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all.
00653 value Linear transform
00654
00655 --------------------------------------------------------------------------------
00656
00657 """
00658 return _coordsys.coordsys_setlineartransform(self, *args, **kwargs)
00659
00660 def setnames(self, *args, **kwargs):
00661 """
00662 setnames(self, value, type=string("")) -> bool
00663
00664 Summary
00665 Set the axis names
00666
00667 Input Parameters:
00668 value Names
00669 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave empty for all
00670
00671 --------------------------------------------------------------------------------
00672
00673 """
00674 return _coordsys.coordsys_setnames(self, *args, **kwargs)
00675
00676 def setobserver(self, *args, **kwargs):
00677 """
00678 setobserver(self, value) -> bool
00679
00680 Summary
00681 Set a new observer
00682
00683 Input Parameters:
00684 value New observer
00685
00686 --------------------------------------------------------------------------------
00687
00688 """
00689 return _coordsys.coordsys_setobserver(self, *args, **kwargs)
00690
00691 def setprojection(self, *args, **kwargs):
00692 """
00693 setprojection(self, type, parameters=initialize_vector(1, (double)-1)) -> bool
00694
00695 Summary
00696 Set the direction coordinate projection
00697
00698 Input Parameters:
00699 type Type of projection
00700 parameters Projection parameters -1
00701
00702 --------------------------------------------------------------------------------
00703
00704 """
00705 return _coordsys.coordsys_setprojection(self, *args, **kwargs)
00706
00707 def setreferencecode(self, *args, **kwargs):
00708 """
00709 setreferencecode(self, value, type=string("direction"), adjust=True) -> bool
00710
00711 Summary
00712 Set new reference code
00713
00714 Input Parameters:
00715 value Reference code
00716 type Coordinate type: direction or spectral direction
00717 adjust Adjust reference value ? true
00718
00719 --------------------------------------------------------------------------------
00720
00721 """
00722 return _coordsys.coordsys_setreferencecode(self, *args, **kwargs)
00723
00724 def setreferencelocation(self, *args, **kwargs):
00725 """
00726 setreferencelocation(self, pixel=initialize_vector(1, (int)-1), world=initialize_variant("-1"), mask=initialize_vector(1, (bool)false)) -> bool
00727
00728 Summary
00729 Set reference pixel and value
00730
00731 Input Parameters:
00732 pixel New reference pixel. Defaults to old reference pixel. -1
00733 world New reference value. Defaults to old reference value. -1
00734 mask Indicates which axes to center. Defaults to all. false
00735
00736 --------------------------------------------------------------------------------
00737
00738 """
00739 return _coordsys.coordsys_setreferencelocation(self, *args, **kwargs)
00740
00741 def setreferencepixel(self, *args, **kwargs):
00742 """
00743 setreferencepixel(self, value, type=string("")) -> bool
00744
00745 Summary
00746 Set the reference pixel
00747
00748 Input Parameters:
00749 value Reference pixel
00750 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave unset for all
00751
00752 --------------------------------------------------------------------------------
00753
00754 """
00755 return _coordsys.coordsys_setreferencepixel(self, *args, **kwargs)
00756
00757 def setreferencevalue(self, *args, **kwargs):
00758 """
00759 setreferencevalue(self, value, type=string("")) -> bool
00760
00761 Summary
00762 Set the reference value
00763
00764 Input Parameters:
00765 value Reference value
00766 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave empty for all.
00767
00768 --------------------------------------------------------------------------------
00769
00770 """
00771 return _coordsys.coordsys_setreferencevalue(self, *args, **kwargs)
00772
00773 def setrestfrequency(self, *args, **kwargs):
00774 """
00775 setrestfrequency(self, value, which=0, append=False) -> bool
00776
00777 Summary
00778 Set the rest frequency
00779
00780 Input Parameters:
00781 value New rest frequencies
00782 which Which is the active rest frequency 0
00783 append Append this list or overwrite ? false
00784
00785 --------------------------------------------------------------------------------
00786
00787 """
00788 return _coordsys.coordsys_setrestfrequency(self, *args, **kwargs)
00789
00790 def setspectral(self, *args, **kwargs):
00791 """
00792 setspectral(self, refcode=string(""), restfreq=initialize_variant(""), frequencies=initialize_variant("1GHz"),
00793 doppler=string(""), velocities=initialize_variant("1km/s")) -> bool
00794
00795 Summary
00796 Set tabular values for the spectral coordinate
00797
00798 Input Parameters:
00799 refcode Reference code. Leave unset for no change.
00800 restfreq Rest frequency. Leave unset for no change.
00801 frequencies Vector of frequencies. Leave unset for no change. 1GHz
00802 doppler Doppler type. Leave unset for no change.
00803 velocities Vector of velocities types. Leave unset for no change. 1km/s
00804
00805 --------------------------------------------------------------------------------
00806
00807 """
00808 return _coordsys.coordsys_setspectral(self, *args, **kwargs)
00809
00810 def setstokes(self, *args, **kwargs):
00811 """
00812 setstokes(self, stokes) -> bool
00813
00814 Summary
00815 Set the Stokes types
00816
00817 Input Parameters:
00818 stokes Stokes types
00819
00820 --------------------------------------------------------------------------------
00821
00822 """
00823 return _coordsys.coordsys_setstokes(self, *args, **kwargs)
00824
00825 def settabular(self, *args, **kwargs):
00826 """
00827 settabular(self, pixel=initialize_vector(1, (double)-1), world=initialize_vector(1, (double)-1), which=0) -> bool
00828
00829 Summary
00830 Set tabular values for the tabular coordinate
00831
00832 Input Parameters:
00833 pixel Vector of (0-rel) pixel values. Default is no change. -1
00834 world Vector of world values. Default is no change. -1
00835 which Which Tabular coordinate 0
00836
00837 --------------------------------------------------------------------------------
00838
00839 """
00840 return _coordsys.coordsys_settabular(self, *args, **kwargs)
00841
00842 def settelescope(self, *args, **kwargs):
00843 """
00844 settelescope(self, value) -> bool
00845
00846 Summary
00847 Set a new telescope
00848
00849 Input Parameters:
00850 value New telescope
00851
00852 --------------------------------------------------------------------------------
00853
00854 """
00855 return _coordsys.coordsys_settelescope(self, *args, **kwargs)
00856
00857 def setunits(self, *args, **kwargs):
00858 """
00859 setunits(self, value, type=string(""), overwrite=False, which=-10) -> bool
00860
00861 Summary
00862 Set the axis units
00863
00864 Input Parameters:
00865 value Units
00866 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabules' or leave unset for all.
00867 overwrite Overwrite linear or tabular coordinate units? false
00868 which Which coordinate if more than one of same type. Default is first. -10
00869
00870 --------------------------------------------------------------------------------
00871
00872 """
00873 return _coordsys.coordsys_setunits(self, *args, **kwargs)
00874
00875 def stokes(self):
00876 """
00877 stokes(self) -> std::vector< std::string >
00878
00879 Summary
00880 Recover the Stokes types
00881 --------------------------------------------------------------------------------
00882
00883 """
00884 return _coordsys.coordsys_stokes(self)
00885
00886 def summary(self, *args, **kwargs):
00887 """
00888 summary(self, doppler=string("RADIO"), list=True) -> std::vector< std::string >
00889
00890 Summary
00891 Summarize basic information about the Coordinate System
00892
00893 Input Parameters:
00894 doppler List velocity information with this doppler definition RADIO
00895 list List to global logger true
00896
00897 --------------------------------------------------------------------------------
00898
00899 """
00900 return _coordsys.coordsys_summary(self, *args, **kwargs)
00901
00902 def telescope(self):
00903 """
00904 telescope(self) -> string
00905
00906 Summary
00907 Return the telescope
00908 --------------------------------------------------------------------------------
00909
00910 """
00911 return _coordsys.coordsys_telescope(self)
00912
00913 def toabs(self, *args, **kwargs):
00914 """
00915 toabs(self, value, isworld=-1) -> record *
00916
00917 Summary
00918 Convert relative coordinate to absolute
00919
00920 Input Parameters:
00921 value Relative coordinate
00922 isworld Is coordinate world or pixel? Default is unset. -1
00923
00924 --------------------------------------------------------------------------------
00925
00926 """
00927 return _coordsys.coordsys_toabs(self, *args, **kwargs)
00928
00929 def toabsmany(self, *args, **kwargs):
00930 """
00931 toabsmany(self, value, isworld=-1) -> record *
00932
00933 Summary
00934 Convert many numeric relative coordinates to absolute
00935
00936 Input Parameters:
00937 value Relative coordinates
00938 isworld Is coordinate world or pixel? Default is unset. -1
00939
00940 --------------------------------------------------------------------------------
00941
00942 """
00943 return _coordsys.coordsys_toabsmany(self, *args, **kwargs)
00944
00945 def topixel(self, *args, **kwargs):
00946 """
00947 topixel(self, value) -> record *
00948
00949 Summary
00950 Convert from absolute world to pixel coordinate
00951
00952 Input Parameters:
00953 value Absolute world coordinate
00954
00955 --------------------------------------------------------------------------------
00956
00957 """
00958 return _coordsys.coordsys_topixel(self, *args, **kwargs)
00959
00960 def topixelmany(self, *args, **kwargs):
00961 """
00962 topixelmany(self, value) -> record *
00963
00964 Summary
00965 Convert many absolute numeric world coordinates to pixel
00966
00967 Input Parameters:
00968 value Absolute world coordinates
00969
00970 --------------------------------------------------------------------------------
00971
00972 """
00973 return _coordsys.coordsys_topixelmany(self, *args, **kwargs)
00974
00975 def torecord(self):
00976 """
00977 torecord(self) -> record *
00978
00979 Summary
00980 Convert Coordinate System to a record
00981 --------------------------------------------------------------------------------
00982
00983 """
00984 return _coordsys.coordsys_torecord(self)
00985
00986 def subimage(self, *args, **kwargs):
00987 """
00988 subimage(self, originshft, newshape=std::vector< int >()) -> record *
00989
00990 Summary
00991 delivers a coordinate origin re-referenced for a subimage
00992
00993 Input Parameters:
00994 originshft The shift value from original reference (vector of values in pixels)
00995 newshape The new shape of the image it will applicable to (pixel shape)
00996
00997 --------------------------------------------------------------------------------
00998
00999 """
01000 return _coordsys.coordsys_subimage(self, *args, **kwargs)
01001
01002 def torel(self, *args, **kwargs):
01003 """
01004 torel(self, value, isworld=-1) -> record *
01005
01006 Summary
01007 Convert absolute coordinate to relative
01008
01009 Input Parameters:
01010 value Absolute coordinate
01011 isworld Is coordinate world or pixel? Default is unset. -1
01012
01013 --------------------------------------------------------------------------------
01014
01015 """
01016 return _coordsys.coordsys_torel(self, *args, **kwargs)
01017
01018 def torelmany(self, *args, **kwargs):
01019 """
01020 torelmany(self, value, isworld=-1) -> record *
01021
01022 Summary
01023 Convert many numeric absolute coordinates to relative
01024
01025 Input Parameters:
01026 value Absolute coordinates
01027 isworld Is coordinate world or pixel? Default is unset. -1
01028
01029 --------------------------------------------------------------------------------
01030
01031 """
01032 return _coordsys.coordsys_torelmany(self, *args, **kwargs)
01033
01034 def toworld(self, *args, **kwargs):
01035 """
01036 toworld(self, value=initialize_variant(""), format=string("n")) -> record *
01037
01038 Summary
01039 Convert from absolute pixel coordinate to world
01040
01041 Input Parameters:
01042 value Absolute pixel coordinate. Default is reference pixel.
01043 format Format string: combination of 'n', 'q', 's', 'm' n
01044
01045 --------------------------------------------------------------------------------
01046
01047 """
01048 return _coordsys.coordsys_toworld(self, *args, **kwargs)
01049
01050 def toworldmany(self, *args, **kwargs):
01051 """
01052 toworldmany(self, value) -> record *
01053
01054 Summary
01055 Convert many absolute pixel coordinates to numeric world
01056
01057 Input Parameters:
01058 value Absolute pixel coordinates
01059
01060 --------------------------------------------------------------------------------
01061
01062 """
01063 return _coordsys.coordsys_toworldmany(self, *args, **kwargs)
01064
01065 def type(self):
01066 """
01067 type(self) -> string
01068
01069 Summary
01070 Return the type of this tool
01071 --------------------------------------------------------------------------------
01072
01073 """
01074 return _coordsys.coordsys_type(self)
01075
01076 def units(self, *args, **kwargs):
01077 """
01078 units(self, type=string("")) -> std::vector< std::string >
01079
01080 Summary
01081 Recover the units for each axis
01082
01083 Input Parameters:
01084 type Coordinate type: 'direction', 'stokes', 'spectral', 'linear' or leave unset for all
01085
01086 --------------------------------------------------------------------------------
01087
01088 """
01089 return _coordsys.coordsys_units(self, *args, **kwargs)
01090
01091 def velocitytofrequency(self, *args, **kwargs):
01092 """
01093 velocitytofrequency(self, value, frequnit=string(""), doppler=string("radio"), velunit=string("km/s")) -> std::vector< double >
01094
01095 Summary
01096 Convert velocity to frequency
01097
01098 Input Parameters:
01099 value Velocity to convert
01100 frequnit Unit of output frequencies. Default is intrinisic units.
01101 doppler Velocity doppler definition radio
01102 velunit Unit of input velocities km/s
01103
01104 --------------------------------------------------------------------------------
01105
01106 """
01107 return _coordsys.coordsys_velocitytofrequency(self, *args, **kwargs)
01108
01109 def parentname(self):
01110 """
01111 parentname(self) -> string
01112
01113 Summary
01114 Get parent image name.
01115 --------------------------------------------------------------------------------
01116
01117 """
01118 return _coordsys.coordsys_parentname(self)
01119
01120 def setparentname(self, *args, **kwargs):
01121 """
01122 setparentname(self, imagename) -> bool
01123
01124 Summary
01125 Set the parent image name (normally not needed by end-users)
01126
01127 Input Parameters:
01128 imagename String named parent image
01129
01130 --------------------------------------------------------------------------------
01131
01132 """
01133 return _coordsys.coordsys_setparentname(self, *args, **kwargs)
01134
01135 coordsys_swigregister = _coordsys.coordsys_swigregister
01136 coordsys_swigregister(coordsys)
01137 cvar = _coordsys.cvar
01138
01139
01140
01141