API Reference

This page documents the package API automatically.

DST

PolyHarmonicTrigTransforms.DST.dstFunction
dst(x; dims=1)

Compute the Type-I Discrete Sine Transform (DST) of x along dims.

Arguments

  • x: an AbstractArray (vector or matrix).
  • dims: dimension to transform (default 1).

Returns

  • transformed array of the same shape as x.

Example

y = dst([1.0,2.0,3.0])
source
PolyHarmonicTrigTransforms.DST.dst!Function
dst!(x; dims=1)

In-place DST that overwrites x with its transform when possible. Falls back to a safe out-of-place compute and copy if the in-place routine is not available on the current platform.

source

IDST

PolyHarmonicTrigTransforms.IDST.idstFunction

idst(y; dims=1)

Inverse Type-I Discrete Sine Transform (IDST) of y along dims.

Arguments

  • y: an AbstractArray of DST coefficients.
  • dims: dimension to transform (default 1).

Returns

  • reconstructed array in the original domain.
source
PolyHarmonicTrigTransforms.IDST.idst!Function

idst!(y; dims=1)

In-place inverse DST: overwrite y with the reconstructed data when possible. Falls back to computing out-of-place and copying the result. Uses an FFTW r2r plan for the in-place computation when available. The result is scaled by 1/(N+1) to account for the normalization of the DST. Note that the input y should contain the DST coefficients, and after this function, it will contain the reconstructed data in the original domain.

source

LLST

ILLST

LLST2

PolyHarmonicTrigTransforms.LLST2.llst2Function

llst2(data, ll; inverse=false)

Perform the LLST block-based transform using level-list ll on data.

  • data: input 2D array.
  • ll: level-list describing the quadtree partition.
  • inverse: when true performs the inverse transform.

Returns the transformed array.

source

LLSTAPPROX2

PHLCT

PolyHarmonicTrigTransforms.PHLCT.phlct_backwardFunction

phlct_backward(input, N)

Reconstruct an image from block-based PHLCT DCT coefficients.

Arguments

  • input: m×n array of DCT coefficients (block-based, m and n multiples of N).
  • N: block size (integer).

Returns

  • reconstructed m×n image (real array).
source
PolyHarmonicTrigTransforms.PHLCT.phlct_forwardFunction

phlct_forward(input, N)

Compute block-based PHLCT forward transform (returns DCT coefficients).

Arguments

  • input: m×n image array (m and n must be multiples of N).
  • N: block size.

Returns

  • m×n array of DCT coefficients for the PHLCT representation.
source

PHLCT2D

PolyHarmonicTrigTransforms.PHLCT2D.phlct2dFunction

phlct2d(F, N)

Compute the 2D PHLCT coefficients for block-DCT coefficient matrix F.

  • F: m×n block-based DCT coefficient matrix (m,n multiples of N).
  • N: block size.

Returns the PHLCT coefficients V = F - U.

source

QTLLST2DL1

SOLVELAPLACE

PolyHarmonicTrigTransforms.SOLVELAPLACE.solvelaplaceFunction

solvelaplace(image)

Solve the Laplace (Poisson) equation on the interior of image using DST/IDST.

Arguments

  • image: m×n array with boundary values; the routine solves for the interior (returns array sized m×n with boundary preserved).

Returns

  • array with the computed solution where interior values have been solved and boundaries are unchanged.
source