diff options
Diffstat (limited to 'macros/unwrap2.sci')
| -rw-r--r-- | macros/unwrap2.sci | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/macros/unwrap2.sci b/macros/unwrap2.sci index 7844e38..16d12d2 100644 --- a/macros/unwrap2.sci +++ b/macros/unwrap2.sci @@ -1,21 +1,21 @@ -/*Description: - The unwrap function adjusts radian phases in the input array x by adding or subtracting multiples of - 2π as necessary to remove phase jumps that exceed the specified tolerance tol. If tol is not provided, it defaults to 𝜋 - Radian Phases: These are typically angles or phases expressed in radians, commonly encountered in signal processing and communication systems. - Tolerance (tol): Determines the maximum allowable discontinuity in the phases. - If the difference between consecutive phases exceeds tol, unwrap adjusts the phase by adding or subtracting 2π. - Dimension (dim): Specifies the dimension along which the unwrapping operation is applied. - By default, unwrap operates along the first non-singleton dimension of the input array x. -Calling Sequence: - b = unwrap(x) - b = unwrap(x, tol) - b = unwrap(x, tol, dim) -Parameters: - x: Input array containing radian phases to be unwrapped. - tol (optional): Tolerance parameter specifying the maximum jump allowed between consecutive phases before adding or subtracting 2π. Defaults to 𝜋 - dim (optional): Dimension along which to unwrap the phases. If unspecified, dim defaults to the first non-singleton dimension of the array x. -Dependencies : ipermute*/ function retval = unwrap2 (x, tol, dim) +// Description: +// The unwrap function adjusts radian phases in the input array x by adding or subtracting multiples of +// 2π as necessary to remove phase jumps that exceed the specified tolerance tol. If tol is not provided, it defaults to 𝜋 +// Radian Phases: These are typically angles or phases expressed in radians, commonly encountered in signal processing and communication systems. +// Tolerance (tol): Determines the maximum allowable discontinuity in the phases. +// If the difference between consecutive phases exceeds tol, unwrap adjusts the phase by adding or subtracting 2π. +// Dimension (dim): Specifies the dimension along which the unwrapping operation is applied. +// By default, unwrap operates along the first non-singleton dimension of the input array x. +// Calling Sequence: +// b = unwrap(x) +// b = unwrap(x, tol) +// b = unwrap(x, tol, dim) +// Parameters: +// x: Input array containing radian phases to be unwrapped. +// tol (optional): Tolerance parameter specifying the maximum jump allowed between consecutive phases before adding or subtracting 2π. Defaults to 𝜋 +// dim (optional): Dimension along which to unwrap the phases. If unspecified, dim defaults to the first non-singleton dimension of the array x. +// Dependencies : ipermute nargin = argn(2) if (nargin < 1) error("invalid number of inputs"); |