Package gavo :: Package stc :: Module sphermath :: Class SVConverter
[frames] | no frames]

Class SVConverter

source code

object --+
         |
        SVConverter

A container for the conversion from spherical coordinates to 6-Vectors.

You create one with an example of your data; these are values and units of STC objects, and everything may be None if it's not given.

The resulting object has methods to6 taking values like the one provided by you and returning a 6-vector, and from6 returning a pair of such values.

Further, the converter has the attributes distGiven, posdGiven, and distdGiven signifying whether these items are expected or valid on return. If posVals is None, no transforms can be computed.

The relativistic=True constructior argument requests that the transformation be Lorentz-invariant. Do not use that, though, since there are unsolved numerical issues.

The slaComp=True constructor argument requests that some operations exterior to the construction are done as slalib does them, rather than alternative approaches.

Instance Methods
 
__init__(self, posVals, posUnit, velVals=None, velSUnit=None, velTUnit=None, relativistic=False, slaComp=False)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getPlaceTransformer(self, sixTrafo)
returns a function that transforms 2- or 3-spherical coordinates using the 6-vector transformation sixTrafo.
source code
 
getVelocityTransformer(self, sixTrafo, basePos)
returns a function that transforms velocities using sixTrafos at basePos.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods
 
fromSTC(cls, stc, **kwargs)
returns a new 6-vector transform for coordinates in STC.
source code
Class Variables
  distdGiven = True
  posdGiven = True
  distGiven = True
  posGiven = True
  defaultDistance = 2.06264806247e+12
Properties

Inherited from object: __class__

Method Details

__init__(self, posVals, posUnit, velVals=None, velSUnit=None, velTUnit=None, relativistic=False, slaComp=False)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

getPlaceTransformer(self, sixTrafo)

source code 

returns a function that transforms 2- or 3-spherical coordinates using the 6-vector transformation sixTrafo.

Regardless of whether we expect distances, the returned function always returns vectors of the same dimensionality as were passed in.

This is used when transforming areas.

getVelocityTransformer(self, sixTrafo, basePos)

source code 

returns a function that transforms velocities using sixTrafos at basePos.

This is used when tranforming velocity intervals.