Bsoft function

img_phase_shift

Source:

src/img/img_complex.c

Description:

Phase shifts a set of reflections.

Algorithm: 

	A real space translation with wrapping is equivalent to phase shifting

	in reciprocal space. The shift vector for each sub-image must be

	given in fractional coordinates. If the shift vector is not given

	(i.e. NULL), the shift is taken from the sub-image origins.

Arguments:

Bimage* pcomplex image.
Vector3* shiftthree-value real space shift vector for each sub-image.

Returns:

int error code.

Prototype:

int img_phase_shift(Bimage* p, Vector3* shift)

Functions used:

balloc

Other objects included:

struct Bimage
struct Bmarker
class Complex
constant M_PI

Generated by bdoc.pl on Mon Jun 15 11:47:44 2009

Back to the Bsoft home