diff options
author | Max Kellermeier <max.kellermeier@hotmail.de> | 2020-08-20 11:59:52 +0200 |
---|---|---|
committer | Max Kellermeier <max.kellermeier@hotmail.de> | 2020-08-20 11:59:52 +0200 |
commit | 11ae4340173c644768368755bba93ced112b4505 (patch) | |
tree | 4fad48ef6e6ed0647d8020b62b6085854cd89186 /doc | |
parent | de7aa73c56d8128e3fa5cca1e99ff352fffdf0c5 (diff) | |
download | numpy-11ae4340173c644768368755bba93ced112b4505.tar.gz |
Renamed new argument for unwraping. Extended release note
Diffstat (limited to 'doc')
-rw-r--r-- | doc/release/upcoming_changes/16987.improvement.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/release/upcoming_changes/16987.improvement.rst b/doc/release/upcoming_changes/16987.improvement.rst index 9ff81380a..e85fbda91 100644 --- a/doc/release/upcoming_changes/16987.improvement.rst +++ b/doc/release/upcoming_changes/16987.improvement.rst @@ -1,4 +1,4 @@ -Arbitrary `interval_size` option for ``numpy.unwrap`` +Arbitrary `period` option for ``numpy.unwrap`` ----------------------------------------------------- The size of the interval, over which phases are unwraped, is not restricted to `2 * pi` anymore. This is especially useful for unwrapping degrees but can also be used for other @@ -7,7 +7,12 @@ intervals. .. code:: python >>> phase_deg = np.mod(np.linspace(0,720,19), 360) - 180 - >>> unwrap(phase_deg, interval_size=360) + >>> phase_deg + array([-180., -140., -100., -60., -20., 20., 60., 100., 140., + -180., -140., -100., -60., -20., 20., 60., 100., 140., + -180.]) + + >>> unwrap(phase_deg, period=360) array([-180., -140., -100., -60., -20., 20., 60., 100., 140., 180., 220., 260., 300., 340., 380., 420., 460., 500., 540.]) |