casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | Static Private Attributes
__casac__.coordsys.coordsys Class Reference
Inheritance diagram for __casac__.coordsys.coordsys:
__casac__.coordsys._object

List of all members.

Public Member Functions

def __init__
def newcoordsys
def addcoordinate
def axesmap
def axiscoordinatetypes
def conversiontype
def convert
def convertmany
def coordinatetype
def copy
def done
def epoch
def findaxis
def findcoordinate
def frequencytofrequency
def frequencytovelocity
def fromrecord
def increment
def lineartransform
def names
def naxes
def ncoordinates
def observer
def projection
def referencecode
def referencepixel
def referencevalue
def reorder
def replace
def restfrequency
def setconversiontype
def getconversiontype
def setdirection
def setepoch
def setincrement
def setlineartransform
def setnames
def setobserver
def setprojection
def setreferencecode
def setreferencelocation
def setreferencepixel
def setreferencevalue
def setrestfrequency
def setspectral
def setstokes
def settabular
def settelescope
def setunits
def stokes
def summary
def telescope
def toabs
def toabsmany
def topixel
def topixelmany
def torecord
def subimage
def torel
def torelmany
def toworld
def toworldmany
def type
def units
def velocitytofrequency
def parentname
def setparentname

Public Attributes

 this

Static Private Attributes

dictionary __swig_setmethods__
tuple __setattr__
dictionary __swig_getmethods__
tuple __getattr__
 __repr__
 __swig_destroy__
 __del__

Detailed Description

Proxy of C++ casac::coordsys class

Definition at line 70 of file coordsys.py.


Constructor & Destructor Documentation

__init__(self) -> coordsys

Definition at line 89 of file coordsys.py.


Member Function Documentation

def __casac__.coordsys.coordsys.addcoordinate (   self,
  args,
  kwargs 
)
addcoordinate(self, direction=False, spectral=False, stokes=std::vector< string >(1, ""), linear=0, tabular=False) -> bool

Summary
Add default coordinates.  (For assay testing only.)

Input Parameters:
direction        Add a direction coordinate ? false 
spectral         Add a spectral coordinate ? false 
stokes           Add a Stokes coordinate with these Stokes I Q U V XX YY XY YX RR LL RL LR 
linear           Add a linear coordinate with this many axes 0 
tabular          Add a tabular coordinate false 

--------------------------------------------------------------------------------

Definition at line 115 of file coordsys.py.

def __casac__.coordsys.coordsys.axesmap (   self,
  toworld = True 
)
axesmap(self, toworld=True) -> std::vector< int >

Summary
Find mapping between world and pixel axes

Input Parameters:
toworld          Map from pixel to world ? true 

--------------------------------------------------------------------------------

Definition at line 134 of file coordsys.py.

def __casac__.coordsys.coordsys.axiscoordinatetypes (   self,
  world = True 
)
axiscoordinatetypes(self, world=True) -> std::vector< std::string >

Summary
Return types of coordinates for each axis

Input Parameters:
world            World or pixel axes ? true 

--------------------------------------------------------------------------------

Definition at line 149 of file coordsys.py.

def __casac__.coordsys.coordsys.conversiontype (   self,
  args,
  kwargs 
)
conversiontype(self, type=string("direction")) -> string

Summary
Get extra reference conversion layer

Input Parameters:
type             Coordinate type, direction, spectral direction 

--------------------------------------------------------------------------------

Definition at line 164 of file coordsys.py.

def __casac__.coordsys.coordsys.convert (   self,
  args,
  kwargs 
)
convert(self, coordin, absin=initialize_vector(1, (bool)true), dopplerin=string("radio"), unitsin=std::vector< string >(1, ""), 
    absout=initialize_vector(1, (bool)true), dopplerout=string("radio"), 
    unitsout=std::vector< string >(1, ""), shape=initialize_vector(1, (int)-1)) -> std::vector< double >

Summary
Convert a numeric mixed coordinate 

Input Parameters:
coordin          Input coordinate, as a numeric vector 
absin            Are input coordinate elements absolute ? true 
dopplerin        Input doppler type for velocities radio 
unitsin          Input units, string vector Native 
absout           Are output coordinate elements absolute ? true 
dopplerout       Output doppler type for velocities radio 
unitsout         Output units Native 
shape            Image shape, integer vector -1 

--------------------------------------------------------------------------------

Definition at line 179 of file coordsys.py.

def __casac__.coordsys.coordsys.convertmany (   self,
  args,
  kwargs 
)
convertmany(self, coordin, absin=initialize_vector(1, (bool)true), dopplerin=string("radio"), unitsin=std::vector< string >(1, ""), 
    absout=initialize_vector(1, (bool)true), dopplerout=string("radio"), 
    unitsout=std::vector< string >(1, ""), shape=initialize_vector(1, (int)-1)) -> variant *

Summary
Convert many numeric mixed coordinates

Input Parameters:
coordin          Input coordinate, numeric matrix 
absin            Are input coordinate elements absolute ? true 
dopplerin        Input doppler type for velocities radio 
unitsin          Input units, string vector Native 
absout           Are output coordinate elements absolute ? true 
dopplerout       Output doppler type for velocities radio 
unitsout         Output units Native 
shape            Image shape, integer array -1 

--------------------------------------------------------------------------------

Definition at line 203 of file coordsys.py.

def __casac__.coordsys.coordsys.coordinatetype (   self,
  args,
  kwargs 
)
coordinatetype(self, which=-1) -> std::vector< std::string >

Summary
Return type of specified coordinate

Input Parameters:
which            Which coordinate ? (0-rel) -1 

--------------------------------------------------------------------------------

Definition at line 227 of file coordsys.py.

done(self) -> bool

Summary
Destroy this Coordsys tool, restore default tool
--------------------------------------------------------------------------------

Definition at line 253 of file coordsys.py.

epoch(self) -> record *

Summary
Return the epoch
--------------------------------------------------------------------------------

Definition at line 264 of file coordsys.py.

def __casac__.coordsys.coordsys.findaxis (   self,
  args,
  kwargs 
)
findaxis(self, world=True, axis=0, _coordinate=_coordinate_findaxis, _axisincoordinate=_axisincoordinate_findaxis) -> bool

Summary
Find specified axis in coordinate system

Input Parameters:
world            is axis a world or pixel axis ? true 
axis             Axis in coordinate system 0 


Output Parameters:
_coordinate      Coordinate number 
_axisincoordinate        Axis in the coordinate 

--------------------------------------------------------------------------------

Definition at line 275 of file coordsys.py.

def __casac__.coordsys.coordsys.findcoordinate (   self,
  args,
  kwargs 
)
findcoordinate(self, type=string("direction"), which=0, _pixel=_pixel_findcoordinate, _world=_world_findcoordinate) -> bool

Summary
Find axes of specified coordinate

Input Parameters:
type             Type of coordinate to find: direction, stokes, spectral, linear, or tabular direction 
which            Which coordinate if more than one 0 


Output Parameters:
_pixel           Pixel axes 
_world           World axes 

--------------------------------------------------------------------------------

Definition at line 296 of file coordsys.py.

def __casac__.coordsys.coordsys.frequencytofrequency (   self,
  args,
  kwargs 
)
frequencytofrequency(self, value, frequnit=string(""), velocity=initialize_variant(""), doppler=string("radio")) -> std::vector< double >

Summary
Convert frequency to frequency with an offset

Input Parameters:
value            Frequency to convert 
frequnit         Unit of input frequencies. Default is unit of the spectral coordinate. 
velocity         Velocity offset 
doppler          Velocity doppler definition radio 

--------------------------------------------------------------------------------

Definition at line 317 of file coordsys.py.

def __casac__.coordsys.coordsys.frequencytovelocity (   self,
  args,
  kwargs 
)
frequencytovelocity(self, value, frequnit=string(""), doppler=string("radio"), velunit=string("km/s")) -> std::vector< double >

Summary
Convert frequency to velocity

Input Parameters:
value            Frequency to convert 
frequnit         Unit of input frequencies. Default is unit of the spectral coordinate. 
doppler          Velocity doppler definition radio 
velunit          Unit of output velocities km/s 

--------------------------------------------------------------------------------

Definition at line 335 of file coordsys.py.

def __casac__.coordsys.coordsys.fromrecord (   self,
  args,
  kwargs 
)
fromrecord(self, record) -> bool

Summary
Fill Coordinate System from a record

Input Parameters:
record           Record containing Coordinate System 

--------------------------------------------------------------------------------

Definition at line 353 of file coordsys.py.

def __casac__.coordsys.coordsys.getconversiontype (   self,
  args,
  kwargs 
)
getconversiontype(self, type=string(""), showconversion=True) -> string

Summary
Get extra reference conversion layer
   (aka conversiontype).  

Input Parameters:
type             Conversion type 
showconversion   Show the conversion layer true 

--------------------------------------------------------------------------------

Definition at line 572 of file coordsys.py.

def __casac__.coordsys.coordsys.increment (   self,
  args,
  kwargs 
)
increment(self, format=string("n"), type=string("")) -> record *

Summary
Recover the increments

Input Parameters:
format           Format string from combination of 'n', 'q', 's', 'm' n 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 

--------------------------------------------------------------------------------

Definition at line 368 of file coordsys.py.

def __casac__.coordsys.coordsys.lineartransform (   self,
  args,
  kwargs 
)
lineartransform(self, type) -> variant *

Summary
Recover the linear transform matrix

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' 

--------------------------------------------------------------------------------

Definition at line 384 of file coordsys.py.

def __casac__.coordsys.coordsys.names (   self,
  args,
  kwargs 
)
names(self, type=string("")) -> std::vector< std::string >

Summary
Recover the names for each axis

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 

--------------------------------------------------------------------------------

Definition at line 399 of file coordsys.py.

def __casac__.coordsys.coordsys.naxes (   self,
  world = True 
)
naxes(self, world=True) -> int

Summary
Recover the number of axes

Input Parameters:
world            Find number of world or pixel axes ? true 

--------------------------------------------------------------------------------

Definition at line 414 of file coordsys.py.

ncoordinates(self) -> int

Summary
Recover the number of coordinates in the Coordinate System
--------------------------------------------------------------------------------

Definition at line 429 of file coordsys.py.

def __casac__.coordsys.coordsys.newcoordsys (   self,
  args,
  kwargs 
)
newcoordsys(self, direction=False, spectral=False, stokes=std::vector< string >(1, ""), linear=0, tabular=False) -> coordsys

Summary
Create a non-default coordsys tool

Input Parameters:
direction        Make a direction coordinate ? false 
spectral         Make a spectral coordinate ? false 
stokes           Make a Stokes coordinate with these Stokes I Q U V XX YY XY YX RR LL RL LR 
linear           Make a linear coordinate with this many axes 0 
tabular          Make a tabular coordinate false 

--------------------------------------------------------------------------------

Definition at line 96 of file coordsys.py.

observer(self) -> string

Summary
Return the name of the observer
--------------------------------------------------------------------------------

Definition at line 440 of file coordsys.py.

parentname(self) -> string

Summary
Get parent image name.
--------------------------------------------------------------------------------

Definition at line 1109 of file coordsys.py.

def __casac__.coordsys.coordsys.projection (   self,
  args,
  kwargs 
)
projection(self, type=string("")) -> record *

Summary
Recover the direction coordinate projection

Input Parameters:
type             Type of projection. Defaults to current projection. 

--------------------------------------------------------------------------------

Definition at line 451 of file coordsys.py.

def __casac__.coordsys.coordsys.referencecode (   self,
  args,
  kwargs 
)
referencecode(self, type=string(""), list=False) -> std::vector< std::string >

Summary
Return specified reference code

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 
list             List all possibilities? false 

--------------------------------------------------------------------------------

Definition at line 466 of file coordsys.py.

def __casac__.coordsys.coordsys.referencepixel (   self,
  args,
  kwargs 
)
referencepixel(self, type=string("")) -> record *

Summary
Recover the reference pixel

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 

--------------------------------------------------------------------------------

Definition at line 482 of file coordsys.py.

def __casac__.coordsys.coordsys.referencevalue (   self,
  args,
  kwargs 
)
referencevalue(self, format=string("n"), type=string("")) -> record *

Summary
Recover the reference value

Input Parameters:
format           Format string. Combination of 'n', 'q', 's', 'm' n 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 

--------------------------------------------------------------------------------

Definition at line 497 of file coordsys.py.

def __casac__.coordsys.coordsys.reorder (   self,
  args,
  kwargs 
)
reorder(self, order) -> bool

Summary
Reorder the coordinates

Input Parameters:
order            New coordinate order 

--------------------------------------------------------------------------------

Definition at line 513 of file coordsys.py.

def __casac__.coordsys.coordsys.replace (   self,
  args,
  kwargs 
)
replace(self, csys, whichin, whichout) -> bool

Summary
Replace a coordinate

Input Parameters:
csys             Coordinate System to replace from. Use coordsys' torecord() to generate required record. 
whichin          Index of input coordinate (0-rel) 
whichout         Index of output coordinate 

--------------------------------------------------------------------------------

Definition at line 528 of file coordsys.py.

restfrequency(self) -> record *

Summary
Recover the rest frequency
--------------------------------------------------------------------------------

Definition at line 545 of file coordsys.py.

def __casac__.coordsys.coordsys.setconversiontype (   self,
  args,
  kwargs 
)
setconversiontype(self, direction=string(""), spectral=string("")) -> bool

Summary
Set extra reference conversion layer

Input Parameters:
direction        Reference code 
spectral         Reference code 

--------------------------------------------------------------------------------

Definition at line 556 of file coordsys.py.

def __casac__.coordsys.coordsys.setdirection (   self,
  args,
  kwargs 
)
setdirection(self, refcode=string(""), proj=string(""), projpar=initialize_vector(1, (double)-1), refpix=initialize_vector(1, (double)-1), 
    refval=initialize_variant(""), incr=initialize_variant(""), 
    xform=initialize_variant(""), poles=initialize_variant("")) -> bool

Summary
Set direction coordinate values

Input Parameters:
refcode          Reference code. Default is no change. 
proj             Projection type. Default is no change. 
projpar          Projection parameters. Default is no change. -1 
refpix           Reference pixel. Default is no change. -1 
refval           Reference value. Default is no change. 
incr             Increment. Default is no change. 
xform            Linear transform. Default is no change. 
poles            Native poles. Default is no change. 

--------------------------------------------------------------------------------

Definition at line 589 of file coordsys.py.

def __casac__.coordsys.coordsys.setepoch (   self,
  args,
  kwargs 
)
setepoch(self, value) -> bool

Summary
Set a new epoch

Input Parameters:
value            New epoch measure 

--------------------------------------------------------------------------------

Definition at line 613 of file coordsys.py.

def __casac__.coordsys.coordsys.setincrement (   self,
  args,
  kwargs 
)
setincrement(self, value=initialize_variant(""), type=string("")) -> bool

Summary
Set the increment

Input Parameters:
value            Increments 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all 

--------------------------------------------------------------------------------

Definition at line 628 of file coordsys.py.

def __casac__.coordsys.coordsys.setlineartransform (   self,
  args,
  kwargs 
)
setlineartransform(self, type=string(""), value=initialize_variant("")) -> bool

Summary
Set the linear transform

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular'. Leave empty for all. 
value            Linear transform 

--------------------------------------------------------------------------------

Definition at line 644 of file coordsys.py.

def __casac__.coordsys.coordsys.setnames (   self,
  args,
  kwargs 
)
setnames(self, value, type=string("")) -> bool

Summary
Set the axis names

Input Parameters:
value            Names 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave empty for all 

--------------------------------------------------------------------------------

Definition at line 660 of file coordsys.py.

def __casac__.coordsys.coordsys.setobserver (   self,
  args,
  kwargs 
)
setobserver(self, value) -> bool

Summary
Set a new observer

Input Parameters:
value            New observer 

--------------------------------------------------------------------------------

Definition at line 676 of file coordsys.py.

def __casac__.coordsys.coordsys.setparentname (   self,
  args,
  kwargs 
)
setparentname(self, imagename) -> bool

Summary
Set the parent image name (normally not needed by end-users)

Input Parameters:
imagename        String named parent image 

--------------------------------------------------------------------------------

Definition at line 1120 of file coordsys.py.

def __casac__.coordsys.coordsys.setprojection (   self,
  args,
  kwargs 
)
setprojection(self, type, parameters=initialize_vector(1, (double)-1)) -> bool

Summary
Set the direction coordinate projection

Input Parameters:
type             Type of projection 
parameters       Projection parameters -1 

--------------------------------------------------------------------------------

Definition at line 691 of file coordsys.py.

def __casac__.coordsys.coordsys.setreferencecode (   self,
  args,
  kwargs 
)
setreferencecode(self, value, type=string("direction"), adjust=True) -> bool

Summary
Set new reference code

Input Parameters:
value            Reference code 
type             Coordinate type: direction or spectral direction 
adjust           Adjust reference value ? true 

--------------------------------------------------------------------------------

Definition at line 707 of file coordsys.py.

def __casac__.coordsys.coordsys.setreferencelocation (   self,
  args,
  kwargs 
)
setreferencelocation(self, pixel=initialize_vector(1, (int)-1), world=initialize_variant("-1"), mask=initialize_vector(1, (bool)false)) -> bool

Summary
Set reference pixel and value

Input Parameters:
pixel            New reference pixel. Defaults to old reference pixel. -1 
world            New reference value. Defaults to old reference value. -1 
mask             Indicates which axes to center. Defaults to all. false 

--------------------------------------------------------------------------------

Definition at line 724 of file coordsys.py.

def __casac__.coordsys.coordsys.setreferencepixel (   self,
  args,
  kwargs 
)
setreferencepixel(self, value, type=string("")) -> bool

Summary
Set the reference pixel

Input Parameters:
value            Reference pixel 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave unset for all 

--------------------------------------------------------------------------------

Definition at line 741 of file coordsys.py.

def __casac__.coordsys.coordsys.setreferencevalue (   self,
  args,
  kwargs 
)
setreferencevalue(self, value, type=string("")) -> bool

Summary
Set the reference value

Input Parameters:
value            Reference value 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabular' or leave empty for all. 

--------------------------------------------------------------------------------

Definition at line 757 of file coordsys.py.

def __casac__.coordsys.coordsys.setrestfrequency (   self,
  args,
  kwargs 
)
setrestfrequency(self, value, which=0, append=False) -> bool

Summary
Set the rest frequency

Input Parameters:
value            New rest frequencies 
which            Which is the active rest frequency 0 
append           Append this list or overwrite ? false 

--------------------------------------------------------------------------------

Definition at line 773 of file coordsys.py.

def __casac__.coordsys.coordsys.setspectral (   self,
  args,
  kwargs 
)
setspectral(self, refcode=string(""), restfreq=initialize_variant(""), frequencies=initialize_variant("1GHz"), 
    doppler=string(""), velocities=initialize_variant("1km/s")) -> bool

Summary
Set tabular values for the spectral coordinate

Input Parameters:
refcode          Reference code. Leave unset for no change. 
restfreq         Rest frequency. Leave unset for no change. 
frequencies      Vector of frequencies. Leave unset for no change. 1GHz 
doppler          Doppler type. Leave unset for no change. 
velocities       Vector of velocities types. Leave unset for no change. 1km/s 

--------------------------------------------------------------------------------

Definition at line 790 of file coordsys.py.

def __casac__.coordsys.coordsys.setstokes (   self,
  args,
  kwargs 
)
setstokes(self, stokes) -> bool

Summary
Set the Stokes types

Input Parameters:
stokes           Stokes types 

--------------------------------------------------------------------------------

Definition at line 810 of file coordsys.py.

def __casac__.coordsys.coordsys.settabular (   self,
  args,
  kwargs 
)
settabular(self, pixel=initialize_vector(1, (double)-1), world=initialize_vector(1, (double)-1), which=0) -> bool

Summary
Set tabular values for the tabular coordinate

Input Parameters:
pixel            Vector of (0-rel) pixel values. Default is no change. -1 
world            Vector of world values. Default is no change. -1 
which            Which Tabular coordinate 0 

--------------------------------------------------------------------------------

Definition at line 825 of file coordsys.py.

def __casac__.coordsys.coordsys.settelescope (   self,
  args,
  kwargs 
)
settelescope(self, value) -> bool

Summary
Set a new telescope

Input Parameters:
value            New telescope 

--------------------------------------------------------------------------------

Definition at line 842 of file coordsys.py.

def __casac__.coordsys.coordsys.setunits (   self,
  args,
  kwargs 
)
setunits(self, value, type=string(""), overwrite=False, which=-10) -> bool

Summary
Set the axis units

Input Parameters:
value            Units 
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear', 'tabules' or leave unset for all. 
overwrite        Overwrite linear or tabular coordinate units? false 
which            Which coordinate if more than one of same type. Default is first. -10 

--------------------------------------------------------------------------------

Definition at line 857 of file coordsys.py.

stokes(self) -> std::vector< std::string >

Summary
Recover the Stokes types
--------------------------------------------------------------------------------

Definition at line 875 of file coordsys.py.

def __casac__.coordsys.coordsys.subimage (   self,
  args,
  kwargs 
)
subimage(self, originshft, newshape=std::vector< int >()) -> record *

Summary
delivers a coordinate origin re-referenced for a subimage

Input Parameters:
originshft       The shift value from original reference (vector of values in pixels) 
newshape         The new shape of the image it will applicable to (pixel shape) 

--------------------------------------------------------------------------------

Definition at line 986 of file coordsys.py.

def __casac__.coordsys.coordsys.summary (   self,
  args,
  kwargs 
)
summary(self, doppler=string("RADIO"), list=True) -> std::vector< std::string >

Summary
Summarize basic information about the Coordinate System

Input Parameters:
doppler          List velocity information with this doppler definition RADIO 
list             List to global logger true 

--------------------------------------------------------------------------------

Definition at line 886 of file coordsys.py.

telescope(self) -> string

Summary
Return the telescope
--------------------------------------------------------------------------------

Definition at line 902 of file coordsys.py.

def __casac__.coordsys.coordsys.toabs (   self,
  args,
  kwargs 
)
toabs(self, value, isworld=-1) -> record *

Summary
Convert relative coordinate to absolute

Input Parameters:
value            Relative coordinate 
isworld          Is coordinate world or pixel? Default is unset. -1 

--------------------------------------------------------------------------------

Definition at line 913 of file coordsys.py.

def __casac__.coordsys.coordsys.toabsmany (   self,
  args,
  kwargs 
)
toabsmany(self, value, isworld=-1) -> record *

Summary
Convert many numeric relative coordinates to absolute

Input Parameters:
value            Relative coordinates 
isworld          Is coordinate world or pixel? Default is unset. -1 

--------------------------------------------------------------------------------

Definition at line 929 of file coordsys.py.

def __casac__.coordsys.coordsys.topixel (   self,
  args,
  kwargs 
)
topixel(self, value) -> record *

Summary
Convert from absolute world to pixel coordinate

Input Parameters:
value            Absolute world coordinate 

--------------------------------------------------------------------------------

Definition at line 945 of file coordsys.py.

def __casac__.coordsys.coordsys.topixelmany (   self,
  args,
  kwargs 
)
topixelmany(self, value) -> record *

Summary
Convert many absolute numeric world coordinates to pixel

Input Parameters:
value            Absolute world coordinates 

--------------------------------------------------------------------------------

Definition at line 960 of file coordsys.py.

torecord(self) -> record *

Summary
Convert Coordinate System to a record
--------------------------------------------------------------------------------

Definition at line 975 of file coordsys.py.

def __casac__.coordsys.coordsys.torel (   self,
  args,
  kwargs 
)
torel(self, value, isworld=-1) -> record *

Summary
Convert absolute coordinate to relative

Input Parameters:
value            Absolute coordinate 
isworld          Is coordinate world or pixel? Default is unset. -1 

--------------------------------------------------------------------------------

Definition at line 1002 of file coordsys.py.

def __casac__.coordsys.coordsys.torelmany (   self,
  args,
  kwargs 
)
torelmany(self, value, isworld=-1) -> record *

Summary
Convert many numeric absolute coordinates to relative

Input Parameters:
value            Absolute coordinates 
isworld          Is coordinate world or pixel? Default is unset. -1 

--------------------------------------------------------------------------------

Definition at line 1018 of file coordsys.py.

def __casac__.coordsys.coordsys.toworld (   self,
  args,
  kwargs 
)
toworld(self, value=initialize_variant(""), format=string("n")) -> record *

Summary
Convert from absolute pixel coordinate to world

Input Parameters:
value            Absolute pixel coordinate. Default is reference pixel. 
format           Format string: combination of 'n', 'q', 's', 'm' n 

--------------------------------------------------------------------------------

Definition at line 1034 of file coordsys.py.

def __casac__.coordsys.coordsys.toworldmany (   self,
  args,
  kwargs 
)
toworldmany(self, value) -> record *

Summary
Convert many absolute pixel coordinates to numeric world

Input Parameters:
value            Absolute pixel coordinates 

--------------------------------------------------------------------------------

Definition at line 1050 of file coordsys.py.

type(self) -> string

Summary
Return the type of this tool
--------------------------------------------------------------------------------

Definition at line 1065 of file coordsys.py.

def __casac__.coordsys.coordsys.units (   self,
  args,
  kwargs 
)
units(self, type=string("")) -> std::vector< std::string >

Summary
Recover the units for each axis

Input Parameters:
type             Coordinate type: 'direction', 'stokes', 'spectral', 'linear' or leave unset for all 

--------------------------------------------------------------------------------

Definition at line 1076 of file coordsys.py.

def __casac__.coordsys.coordsys.velocitytofrequency (   self,
  args,
  kwargs 
)
velocitytofrequency(self, value, frequnit=string(""), doppler=string("radio"), velunit=string("km/s")) -> std::vector< double >

Summary
Convert velocity to frequency

Input Parameters:
value            Velocity to convert 
frequnit         Unit of output frequencies. Default is intrinisic units. 
doppler          Velocity doppler definition radio 
velunit          Unit of input velocities km/s 

--------------------------------------------------------------------------------

Definition at line 1091 of file coordsys.py.


Member Data Documentation

Definition at line 95 of file coordsys.py.

tuple __casac__.coordsys.coordsys.__getattr__ [static, private]

Definition at line 75 of file coordsys.py.

Definition at line 76 of file coordsys.py.

tuple __casac__.coordsys.coordsys.__setattr__ [static, private]

Definition at line 73 of file coordsys.py.

Definition at line 94 of file coordsys.py.

Definition at line 74 of file coordsys.py.

Definition at line 72 of file coordsys.py.

Definition at line 93 of file coordsys.py.


The documentation for this class was generated from the following file: