Skip to content

Commit 4e85b0a

Browse files
edit error message
1 parent 1b0fa19 commit 4e85b0a

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

src/diffpy/utils/scattering_objects/diffraction_objects.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -783,9 +783,7 @@ def q_to_tth(self):
783783
wavelength = float(self.wavelength)
784784
pre_factor = wavelength / (4 * np.pi)
785785
if np.any(np.abs(q * pre_factor) > 1):
786-
raise ValueError(
787-
"Invalid input for arcsin: some values exceed the range [-1, 1]. Check wavelength or q values."
788-
)
786+
raise ValueError("Please check if you entered an incorrect wavelength or q value.")
789787
return np.rad2deg(2.0 * np.arcsin(q * pre_factor))
790788

791789
def tth_to_q(self):
@@ -822,7 +820,10 @@ def tth_to_q(self):
822820
"""
823821
two_theta = np.asarray(np.deg2rad(self.on_tth[0]))
824822
if np.any(two_theta > np.pi):
825-
raise ValueError("Two theta exceeds 180 degrees.")
823+
raise ValueError(
824+
"Two theta exceeds 180 degrees. Please check if invalid values were entered "
825+
"or if degrees were incorrectly specified as radians."
826+
)
826827
wavelength = float(self.wavelength)
827828
pre_factor = (4 * np.pi) / wavelength
828829
return pre_factor * np.sin(two_theta / 2)

tests/diffpy/utils/scattering_objects/test_diffraction_objects.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ def test_diffraction_objects_equality(inputs1, inputs2, expected):
232232

233233

234234
def test_q_to_tth():
235-
# valid q values including edge cases when q=0 or 1
235+
# valid q values including edge cases when q=0 or tth=180 after converting
236236
# expected tth values are 2*arcsin(q)
237237
actual = DiffractionObject(wavelength=4 * np.pi)
238238
setattr(actual, "on_q", [[0, 0.2, 0.4, 0.6, 0.8, 1], [1, 2, 3, 4, 5, 6]])
@@ -242,7 +242,7 @@ def test_q_to_tth():
242242

243243

244244
def test_q_to_tth_bad():
245-
# invalid q values when arcsin value is not in the range of [-1, 1]
245+
# invalid wavelength or q values when arcsin value is not in the range of [-1, 1]
246246
actual = DiffractionObject(wavelength=4 * np.pi)
247247
setattr(actual, "on_q", [[0.6, 0.8, 1, 1.2], [1, 2, 3, 4]])
248248
with pytest.raises(ValueError):

0 commit comments

Comments
 (0)