Skip to content

Commit

Permalink
add comments on assuming modes in coprecessing frame
Browse files Browse the repository at this point in the history
  • Loading branch information
md-arif-shaikh committed Oct 12, 2024
1 parent fe63962 commit 181b593
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions gw_eccentricity/eccDefinition.py
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,12 @@ def get_amp_phase_omega_gw(self, data_dict):
data_dict["phaselm"][(2, 2)],
data_dict["omegalm"][(2, 2)])
else:
# TODO: Currently, we assume that the input `dataDict` is already provided in the
# coprecessing frame. In the future, this assumption could be
# relaxed. If the user's `dataDict` is in the inertial frame, we can
# internally compute the corresponding modes in the coprecessing frame by
# applying the appropriate rotational transformation.

# check whether (2, -2) mode is provided.
for k in ["amplm", "phaselm"]:
if (2, -2) not in data_dict[k]:
Expand Down

0 comments on commit 181b593

Please sign in to comment.