rmap: Utilities for phase unwrapping

View source: R/puwalgs.r

rmapR Documentation

Utilities for phase unwrapping

Description

Utility functions for use in 2D phase unwrapping.

Usage

rmap(phase, dx = NULL, dy = NULL, plot = FALSE, ...)
wrap(phase)

Arguments

phase

Matrix of wrapped phase values

dx

Matrix of x differences

dy

Matrix of y differences

plot

Boolean: plot residue positions?

...

additional arguments for image

Details

dx and dy must have the same dimension as phase.

Value

In rmap if plot == TRUE

nr

the number of residues identified in the map

otherwise

phase

wrapped phase returned by wrap

residues

Matrix the same size as phase with residues marked as + or - 1.

Note

These are primarily intended for internal use but can be used interactively. Calling rmap(phase, plot=TRUE) will plot the positions of residues and return nothing. If (plot==FALSE) in the call to rmap a matrix the same size as phase is returned with residues identified with values of +1 or -1.

Author(s)

M.L. Peck mpeck1@ix.netcom.com. Steve Koehler is responsible for the efficient implementation of the wrap function.

References

Ghiglia, D.C., and Pritt, M.D., 1998, Two-Dimensional Phase Unwrapping, New York: Wiley & Sons, Inc., ISBN 0-471-24935-1.

See Also

Called by brcutpuw.


mlpeck/zernike documentation built on April 19, 2024, 3:16 p.m.