-
Notifications
You must be signed in to change notification settings - Fork 95
/
actionAngleInverse.py
124 lines (106 loc) · 3.66 KB
/
actionAngleInverse.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
###############################################################################
# actionAngleInverse.py: top-level class with common routines for inverse
# actionAngle methods
###############################################################################
from ..util.conversion import (
actionAngleInverse_physical_input,
physical_conversion_actionAngleInverse,
)
from .actionAngle import actionAngle
class actionAngleInverse(actionAngle):
"""actionAngleInverse; top-level class with common routines for inverse actionAngle methods"""
def __init__(self, *args, **kwargs):
actionAngle.__init__(self, ro=kwargs.get("ro", None), vo=kwargs.get("vo", None))
@actionAngleInverse_physical_input
@physical_conversion_actionAngleInverse("__call__", pop=True)
def __call__(self, *args, **kwargs):
"""
Evaluate the phase-space coordinates (x,v) for a number of angles on a single torus.
Parameters
----------
jr : float
Radial action.
jphi : float
Azimuthal action.
jz : float
Vertical action.
angler : numpy.ndarray
Radial angle.
anglephi : numpy.ndarray
Azimuthal angle.
anglez : numpy.ndarray
Vertical angle.
Returns
-------
numpy.ndarray
[R,vR,vT,z,vz,phi]
Notes
-----
- 2017-11-14 - Written - Bovy (UofT)
"""
try:
return self._evaluate(*args, **kwargs)
except AttributeError: # pragma: no cover
raise NotImplementedError(
"'__call__' method not implemented for this actionAngle module"
)
@actionAngleInverse_physical_input
@physical_conversion_actionAngleInverse("xvFreqs", pop=True)
def xvFreqs(self, *args, **kwargs):
"""
Evaluate the phase-space coordinates (x,v) for a number of angles on a single torus as well as the frequencies
Parameters
----------
jr : float
Radial action.
jphi : float
Azimuthal action.
jz : float
Vertical action.
angler : numpy.ndarray
Radial angle.
anglephi : numpy.ndarray
Azimuthal angle.
anglez : numpy.ndarray
Vertical angle.
Returns
-------
tuple
A tuple containing the phase-space coordinates (R,vR,vT,z,vz,phi) and the frequencies (OmegaR,Omegaphi,Omegaz).
Notes
-----
- 2017-11-15 - Written - Bovy (UofT)
"""
try:
return self._xvFreqs(*args, **kwargs)
except AttributeError: # pragma: no cover
raise NotImplementedError(
"'xvFreqs' method not implemented for this actionAngle module"
)
@actionAngleInverse_physical_input
@physical_conversion_actionAngleInverse("Freqs", pop=True)
def Freqs(self, *args, **kwargs):
"""
Return the frequencies corresponding to a torus
Parameters
----------
jr : float
Radial action.
jphi : float
Azimuthal action.
jz : float
Vertical action.
Returns
-------
tuple
A tuple of three floats representing the frequencies (OmegaR, Omegaphi, Omegaz).
Notes
-----
- 2017-11-15 - Written - Bovy (UofT)
"""
try:
return self._Freqs(*args, **kwargs)
except AttributeError: # pragma: no cover
raise NotImplementedError(
"'Freqs' method not implemented for this actionAngle module"
)