From 181b59387193039746cd675dd191390732b32288 Mon Sep 17 00:00:00 2001 From: md-arif-shaikh Date: Sat, 12 Oct 2024 16:00:37 +0900 Subject: [PATCH] add comments on assuming modes in coprecessing frame --- gw_eccentricity/eccDefinition.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/gw_eccentricity/eccDefinition.py b/gw_eccentricity/eccDefinition.py index c7e7687..9c654c6 100644 --- a/gw_eccentricity/eccDefinition.py +++ b/gw_eccentricity/eccDefinition.py @@ -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]: