cupyx.scipy.fft.dst#

cupyx.scipy.fft.dst(x, type=2, n=None, axis=-1, norm=None, overwrite_x=False)[source]#

Return the Discrete Sine Transform of an array, x.

Parameters:

  • x (cupy.ndarray) – The input array.

  • type ({1, 2, 3, 4}, optional) – Type of the DST (see Notes). Default type is 2.

  • n (int, optional) – Length of the transform. If n < x.shape[axis], x is truncated. If n > x.shape[axis], x is zero-padded. The default results in n = x.shape[axis].

  • axis (int, optional) – Axis along which the dst is computed; the default is over the last axis (i.e., axis=-1).

  • norm ({"backward", "ortho", "forward"}, optional) – Normalization mode (see Notes). Default is “backward”.

  • overwrite_x (bool, optional) – If True, the contents of x can be destroyed; the default is False.

Returns:

dst – The transformed input array.

Return type:

cupy.ndarray of real

See also

scipy.fft.dst()

Notes

For norm="ortho" both the dst and idst are scaled by the same overall factor in both directions. By default, the transform is also orthogonalized which for types 2 and 3 means the transform definition is modified to give orthogonality of the DST matrix (see below).

For norm="backward", there is no scaling on the dst and the idst is scaled by 1/N where N is the “logical” size of the DST.

See the scipy.fft.dst() documentation for a full description of each type. CuPy currently only supports DST types 2 and 3.