def DM(I, iters, **args):
"""
Find the phases of 'I' given O using the Error Reduction Algorithm.
Parameters
----------
I : numpy.ndarray, (N, M, K)
Merged diffraction patterns to be phased.
N : the number of pixels along slowest scan axis of the detector
M : the number of pixels along slow scan axis of the detector
K : the number of pixels along fast scan axis of the detector
O : numpy.ndarray, (N, M, K)
The real-space scattering density of the object such that:
I = |F[O]|^2
where F[.] is the 3D Fourier transform of '.'.
iters : int
The number of ERA iterations to perform.
support : numpy.ndarray or None, (N, M, K)
Real-space region where the object function is known to be zero.
mask : numpy.ndarray, (N, M, K), optional, default (1)
The valid detector pixels. Mask[i, j, k] = 1 (or True) when the detector pixel
i, j, k is valid, Mask[i, j, k] = 0 (or False) otherwise.
method : (None, 1, 2, 3, 4), optional, default (None)
method = None :
Automattically choose method 1, 2 based on the contents of 'background'.
if 'background' == None then method = 1
elif 'background' != None then method = 2
method = 1 :
Just update 'O'
method = 2 :
Update 'O' and 'background'
hardware : ('cpu', 'gpu'), optional, default ('cpu')
Choose to run the reconstruction on a single cpu core ('cpu') or a single gpu
('gpu'). The numerical results should be identical.
alpha : float, optional, default (1.0e-10)
A floating point number to regularise array division (prevents 1/0 errors).
dtype : (None, 'single' or 'double'), optional, default ('single')
Determines the numerical precision of the calculation. If dtype==None, then
it is determined from the datatype of I.
full_output : bool, optional, default (True)
If true then return a bunch of diagnostics (see info) as a python dictionary
(a list of key : value pairs).
Returns
-------
O : numpy.ndarray, (U, V, K)
The real-space object function after 'iters' iterations of the ERA algorithm.
info : dict, optional
contains diagnostics:
'I' : the diffraction pattern corresponding to object above
'eMod' : the modulus error for each iteration:
eMod_i = sqrt( sum(| O_i - Pmod(O_i) |^2) / I )
'eCon' : the convergence error for each iteration:
eCon_i = sqrt( sum(| O_i - O_i-1 |^2) / sum(| O_i |^2) )
Notes
-----
The Difference Map algorithm [1] applies the modulus and consistency constraints
in wierd and wonderful ways. Unlike the ERA, no iterate of DM ever fully satisfies
either constraint. Instead it tries to find the solution by avoiding stagnation
points (a typical problem with ERA). It is recommended to combine DM and ERA when
phasing. The modulus and consistency constraints are:
modulus constraint : after propagation to the detector the exit surface waves
must have the same modulus (square root of the intensity)
as the detected diffraction patterns (the I's).
support constraint : the exit surface waves (W) must be separable into some object
and probe functions so that W_n = O_n x P.
The 'projection' operation onto one of these constraints makes the smallest change to the
set of exit surface waves (in the Euclidean sense) that is required to satisfy said
constraint.
DM applies the following recursion on the state vector:
f_i+1 = f_i + b (Ps Rm f_i - Pm Rs f_i)
where
Rs f = ((1 + gm)Ps - gm)f
Rm f = ((1 + gs)Pm - gs)f
and f_i is the i'th iterate of DM (in our case the exit surface waves). 'gs', 'gm' and
'b' are real scalar parameters. gs and gm are the degree of relaxation for the consistency
and modulus constraint respectively. While |b| < 1 can be thought of as relating to
step-size of the algorithm. Once DM has reached a fixed point, so that f_i+1 = f_i,
the solution (f*) is obtained from either of:
f* = Ps Rm f_i = PM Rs f_i
One choice for gs and gm is to set gs = -1/b, gm = 1/b and b=1 leading to:
Rs f = 2 Ps f - f
Rm f = f
f_i+1 = f_i + Ps f_i - Pm (2 Ps f_i - f_i)
and
f* = Ps f_i = PM (2 Ps f_i - f_i)
Examples
--------
References
----------
[1] Veit Elser, "Phase retrieval by iterated projections," J. Opt. Soc. Am. A
20, 40-55 (2003)
"""
"""
if hardware == 'gpu':
from dm_gpu import DM_gpu
return DM_gpu(I, R, P, O, iters, OP_iters, mask, background, method, hardware, alpha, dtype, full_output)
"""
# set the real and complex data precision
# ---------------------------------------
if "dtype" not in args.keys():
dtype = I.dtype
c_dtype = (I[0, 0, 0] + 1j * I[0, 0, 0]).dtype
elif args["dtype"] == "single":
dtype = np.float32
c_dtype = np.complex64
elif args["dtype"] == "double":
dtype = np.float64
c_dtype = np.complex128
args["dtype"] = dtype
args["c_dtype"] = c_dtype
if isValid("Mapper", args):
print "using user defined mapper"
Mapper = args["Mapper"]
elif isValid("hardware", args) and args["hardware"] == "gpu":
print "using gpu mapper"
from mappers_gpu import Mapper
else:
print "using default cpu mapper"
from mappers import Mapper
eMods = []
eCons = []
mapper = Mapper(I, **args)
modes = mapper.modes
modes_sup = mapper.Psup(modes)
if iters > 0 and rank == 0:
print "\n\nalgrithm progress iteration convergence modulus error"
for i in range(iters):
# reference
modes0 = modes.copy()
# update
# -------
modes += mapper.Pmod(modes_sup * 2 - modes) - modes_sup
# metrics
# --------
modes0 -= modes
eCon = mapper.l2norm(modes0, modes)
# f* = Ps f_i = PM (2 Ps f_i - f_i)
modes_sup = mapper.Psup(modes)
eMod = mapper.Emod(modes_sup)
if rank == 0:
era.update_progress(i / max(1.0, float(iters - 1)), "DM", i, eCon, eMod)
eMods.append(eMod)
eCons.append(eCon)
info = {}
info["eMod"] = eMods
info["eCon"] = eCons
O = mapper.object(modes_sup)
info.update(mapper.finish(modes_sup))
return O, info
def DM(I, iters, **args):
"""
Find the phases of 'I' given O using the Error Reduction Algorithm.
Parameters
----------
I : numpy.ndarray, (N, M, K)
Merged diffraction patterns to be phased.
N : the number of pixels along slowest scan axis of the detector
M : the number of pixels along slow scan axis of the detector
K : the number of pixels along fast scan axis of the detector
O : numpy.ndarray, (N, M, K)
The real-space scattering density of the object such that:
I = |F[O]|^2
where F[.] is the 3D Fourier transform of '.'.
iters : int
The number of ERA iterations to perform.
support : numpy.ndarray or None, (N, M, K)
Real-space region where the object function is known to be zero.
mask : numpy.ndarray, (N, M, K), optional, default (1)
The valid detector pixels. Mask[i, j, k] = 1 (or True) when the detector pixel
i, j, k is valid, Mask[i, j, k] = 0 (or False) otherwise.
method : (None, 1, 2, 3, 4), optional, default (None)
method = None :
Automattically choose method 1, 2 based on the contents of 'background'.
if 'background' == None then method = 1
elif 'background' != None then method = 2
method = 1 :
Just update 'O'
method = 2 :
Update 'O' and 'background'
hardware : ('cpu', 'gpu'), optional, default ('cpu')
Choose to run the reconstruction on a single cpu core ('cpu') or a single gpu
('gpu'). The numerical results should be identical.
alpha : float, optional, default (1.0e-10)
A floating point number to regularise array division (prevents 1/0 errors).
dtype : (None, 'single' or 'double'), optional, default ('single')
Determines the numerical precision of the calculation. If dtype==None, then
it is determined from the datatype of I.
full_output : bool, optional, default (True)
If true then return a bunch of diagnostics (see info) as a python dictionary
(a list of key : value pairs).
Returns
-------
O : numpy.ndarray, (U, V, K)
The real-space object function after 'iters' iterations of the ERA algorithm.
info : dict, optional
contains diagnostics:
'I' : the diffraction pattern corresponding to object above
'eMod' : the modulus error for each iteration:
eMod_i = sqrt( sum(| O_i - Pmod(O_i) |^2) / I )
'eCon' : the convergence error for each iteration:
eCon_i = sqrt( sum(| O_i - O_i-1 |^2) / sum(| O_i |^2) )
Notes
-----
The Difference Map algorithm [1] applies the modulus and consistency constraints
in wierd and wonderful ways. Unlike the ERA, no iterate of DM ever fully satisfies
either constraint. Instead it tries to find the solution by avoiding stagnation
points (a typical problem with ERA). It is recommended to combine DM and ERA when
phasing. The modulus and consistency constraints are:
modulus constraint : after propagation to the detector the exit surface waves
must have the same modulus (square root of the intensity)
as the detected diffraction patterns (the I's).
support constraint : the exit surface waves (W) must be separable into some object
and probe functions so that W_n = O_n x P.
The 'projection' operation onto one of these constraints makes the smallest change to the
set of exit surface waves (in the Euclidean sense) that is required to satisfy said
constraint.
DM applies the following recursion on the state vector:
f_i+1 = f_i + b (Ps Rm f_i - Pm Rs f_i)
where
Rs f = ((1 + gm)Ps - gm)f
Rm f = ((1 + gs)Pm - gs)f
and f_i is the i'th iterate of DM (in our case the exit surface waves). 'gs', 'gm' and
'b' are real scalar parameters. gs and gm are the degree of relaxation for the consistency
and modulus constraint respectively. While |b| < 1 can be thought of as relating to
step-size of the algorithm. Once DM has reached a fixed point, so that f_i+1 = f_i,
the solution (f*) is obtained from either of:
f* = Ps Rm f_i = PM Rs f_i
One choice for gs and gm is to set gs = -1/b, gm = 1/b and b=1 leading to:
Rs f = 2 Ps f - f
Rm f = f
f_i+1 = f_i + Ps f_i - Pm (2 Ps f_i - f_i)
and
f* = Ps f_i = PM (2 Ps f_i - f_i)
Examples
--------
References
----------
[1] Veit Elser, "Phase retrieval by iterated projections," J. Opt. Soc. Am. A
20, 40-55 (2003)
"""
"""
if hardware == 'gpu':
from dm_gpu import DM_gpu
return DM_gpu(I, R, P, O, iters, OP_iters, mask, background, method, hardware, alpha, dtype, full_output)
"""
# set the real and complex data precision
# ---------------------------------------
if 'dtype' not in args.keys():
dtype = I.dtype
c_dtype = (I[0, 0, 0] + 1J * I[0, 0, 0]).dtype
elif args['dtype'] == 'single':
dtype = np.float32
c_dtype = np.complex64
elif args['dtype'] == 'double':
dtype = np.float64
c_dtype = np.complex128
args['dtype'] = dtype
args['c_dtype'] = c_dtype
if isValid('Mapper', args):
print 'using user defined mapper'
Mapper = args['Mapper']
elif isValid('hardware', args) and args['hardware'] == 'gpu':
print 'using gpu mapper'
from mappers_gpu import Mapper
eMods = []
eCons = []
mapper = Mapper(I, **args)
modes = mapper.modes
modes_sup = mapper.Psup(modes)
if iters > 0 and rank == 0:
print '\n\nalgrithm progress iteration convergence modulus error'
for i in range(iters):
# reference
modes0 = modes.copy()
# update
#-------
modes += mapper.Pmod(modes_sup * 2 - modes) - modes_sup
# metrics
#--------
modes0 -= modes
eCon = mapper.l2norm(modes0, modes)
# f* = Ps f_i = PM (2 Ps f_i - f_i)
modes_sup = mapper.Psup(modes)
eMod = mapper.Emod(modes_sup)
if rank == 0:
era.update_progress(i / max(1.0, float(iters - 1)), 'DM', i, eCon,
eMod)
eMods.append(eMod)
eCons.append(eCon)
info = {}
info['eMod'] = eMods
info['eCon'] = eCons
O = mapper.object(modes_sup)
info.update(mapper.finish(modes_sup))
return O, info
def ERA(I, iters, **args):
"""
Find the phases of 'I' given O using the Error Reduction Algorithm.
Parameters
----------
I : numpy.ndarray, (N, M, K)
Merged diffraction patterns to be phased.
N : the number of pixels along slowest scan axis of the detector
M : the number of pixels along slow scan axis of the detector
K : the number of pixels along fast scan axis of the detector
iters : int
The number of ERA iterations to perform.
O : numpy.ndarray, (N, M, K)
The real-space scattering density of the object such that:
I = |F[O]|^2
where F[.] is the 3D Fourier transform of '.'.
support : (numpy.ndarray, None or int), (N, M, K)
Real-space region where the object function is known to be zero.
If support is an integer then the N most intense pixels will be kept at
each iteration.
mask : numpy.ndarray, (N, M, K), optional, default (1)
The valid detector pixels. Mask[i, j, k] = 1 (or True) when the detector pixel
i, j, k is valid, Mask[i, j, k] = 0 (or False) otherwise.
hardware : ('cpu', 'gpu'), optional, default ('cpu')
Choose to run the reconstruction on a single cpu core ('cpu') or a single gpu
('gpu'). The numerical results should be identical.
alpha : float, optional, default (1.0e-10)
A floating point number to regularise array division (prevents 1/0 errors).
dtype : (None, 'single' or 'double'), optional, default ('single')
Determines the numerical precision of the calculation. If dtype==None, then
it is determined from the datatype of I.
Mapper : class, optional, default None
A mapping class that provides the methods supplied by:
phasing_3d.src.mappers.Mapper
Returns
-------
O : numpy.ndarray, (U, V, K)
The real-space object function after 'iters' iterations of the ERA algorithm.
info : dict
contains diagnostics:
'I' : the diffraction pattern corresponding to object above
'eMod' : the modulus error for each iteration:
eMod_i = sqrt( sum(| O_i - Pmod(O_i) |^2) / I )
'eCon' : the convergence error for each iteration:
eCon_i = sqrt( sum(| O_i - O_i-1 |^2) / sum(| O_i |^2) )
Notes
-----
The ERA is the simplest iterative projection algorithm. It proceeds by
progressive projections of the exit surface waves onto the set of function that
satisfy the:
modulus constraint : after propagation to the detector the exit surface waves
must have the same modulus (square root of the intensity)
as the detected diffraction patterns (the I's).
support constraint : the exit surface waves (W) must be separable into some object
and probe functions so that W_n = O_n x P.
The 'projection' operation onto one of these constraints makes the smallest change to the set
of exit surface waves (in the Euclidean sense) that is required to satisfy said constraint.
Examples
--------
"""
# set the real and complex data precision
# ---------------------------------------
if 'dtype' not in args.keys() :
dtype = I.dtype
c_dtype = (I[0,0,0] + 1J * I[0, 0, 0]).dtype
elif args['dtype'] == 'single':
dtype = np.float32
c_dtype = np.complex64
elif args['dtype'] == 'double':
dtype = np.float64
c_dtype = np.complex128
args['dtype'] = dtype
args['c_dtype'] = c_dtype
if isValid('Mapper', args) :
Mapper = args['Mapper']
elif isValid('hardware', args) and args['hardware'] == 'gpu':
from mappers_gpu import Mapper
else :
print 'using default cpu mapper'
from mappers import Mapper
eMods = []
eCons = []
# Set the Mapper for the single mode (default)
# ---------------------------------------
# this guy is responsible for doing:
# I = mapper.Imap(modes) # mapping the modes to the intensity
# modes = mapper.Pmod(modes) # applying the data projection to the modes
# modes = mapper.Psup(modes) # applying the support projection to the modes
# O = mapper.object(modes) # the main object of interest
# dict = mapper.finish(modes) # add any additional output to the info dict
# ---------------------------------------
mapper = Mapper(I, **args)
modes = mapper.modes
if iters > 0 and rank == 0 :
print '\n\nalgrithm progress iteration convergence modulus error'
for i in range(iters) :
modes0 = modes.copy()
# modulus projection
# ------------------
modes = mapper.Pmod(modes)
modes1 = modes.copy()
# support projection
# ------------------
modes = mapper.Psup(modes)
# metrics
#modes1 -= modes0
#eMod = mapper.l2norm(modes1, modes0)
eMod = mapper.Emod(modes)
modes0 -= modes
eCon = mapper.l2norm(modes0, modes)
if rank == 0 : update_progress(i / max(1.0, float(iters-1)), 'ERA', i, eCon, eMod )
eMods.append(eMod)
eCons.append(eCon)
info = {}
info['eMod'] = eMods
info['eCon'] = eCons
info.update(mapper.finish(modes))
O = mapper.object(modes)
return O, info
def ERA(I, iters, **args):
"""
Find the phases of 'I' given O using the Error Reduction Algorithm.
Parameters
----------
I : numpy.ndarray, (N, M, K)
Merged diffraction patterns to be phased.
N : the number of pixels along slowest scan axis of the detector
M : the number of pixels along slow scan axis of the detector
K : the number of pixels along fast scan axis of the detector
iters : int
The number of ERA iterations to perform.
O : numpy.ndarray, (N, M, K)
The real-space scattering density of the object such that:
I = |F[O]|^2
where F[.] is the 3D Fourier transform of '.'.
support : (numpy.ndarray, None or int), (N, M, K)
Real-space region where the object function is known to be zero.
If support is an integer then the N most intense pixels will be kept at
each iteration.
mask : numpy.ndarray, (N, M, K), optional, default (1)
The valid detector pixels. Mask[i, j, k] = 1 (or True) when the detector pixel
i, j, k is valid, Mask[i, j, k] = 0 (or False) otherwise.
hardware : ('cpu', 'gpu'), optional, default ('cpu')
Choose to run the reconstruction on a single cpu core ('cpu') or a single gpu
('gpu'). The numerical results should be identical.
alpha : float, optional, default (1.0e-10)
A floating point number to regularise array division (prevents 1/0 errors).
dtype : (None, 'single' or 'double'), optional, default ('single')
Determines the numerical precision of the calculation. If dtype==None, then
it is determined from the datatype of I.
Mapper : class, optional, default None
A mapping class that provides the methods supplied by:
phasing_3d.src.mappers.Mapper
Returns
-------
O : numpy.ndarray, (U, V, K)
The real-space object function after 'iters' iterations of the ERA algorithm.
info : dict
contains diagnostics:
'I' : the diffraction pattern corresponding to object above
'eMod' : the modulus error for each iteration:
eMod_i = sqrt( sum(| O_i - Pmod(O_i) |^2) / I )
'eCon' : the convergence error for each iteration:
eCon_i = sqrt( sum(| O_i - O_i-1 |^2) / sum(| O_i |^2) )
Notes
-----
The ERA is the simplest iterative projection algorithm. It proceeds by
progressive projections of the exit surface waves onto the set of function that
satisfy the:
modulus constraint : after propagation to the detector the exit surface waves
must have the same modulus (square root of the intensity)
as the detected diffraction patterns (the I's).
support constraint : the exit surface waves (W) must be separable into some object
and probe functions so that W_n = O_n x P.
The 'projection' operation onto one of these constraints makes the smallest change to the set
of exit surface waves (in the Euclidean sense) that is required to satisfy said constraint.
Examples
--------
"""
# set the real and complex data precision
# ---------------------------------------
if 'dtype' not in args.keys():
dtype = I.dtype
c_dtype = (I[0, 0, 0] + 1J * I[0, 0, 0]).dtype
elif args['dtype'] == 'single':
dtype = np.float32
c_dtype = np.complex64
elif args['dtype'] == 'double':
dtype = np.float64
c_dtype = np.complex128
args['dtype'] = dtype
args['c_dtype'] = c_dtype
if isValid('Mapper', args):
Mapper = args['Mapper']
elif isValid('hardware', args) and args['hardware'] == 'gpu':
from mappers_gpu import Mapper
else:
print 'using default cpu mapper'
from mappers import Mapper
eMods = []
eCons = []
# Set the Mapper for the single mode (default)
# ---------------------------------------
# this guy is responsible for doing:
# I = mapper.Imap(modes) # mapping the modes to the intensity
# modes = mapper.Pmod(modes) # applying the data projection to the modes
# modes = mapper.Psup(modes) # applying the support projection to the modes
# O = mapper.object(modes) # the main object of interest
# dict = mapper.finish(modes) # add any additional output to the info dict
# ---------------------------------------
mapper = Mapper(I, **args)
modes = mapper.modes
if iters > 0 and rank == 0:
print '\n\nalgrithm progress iteration convergence modulus error'
for i in range(iters):
modes0 = modes.copy()
# modulus projection
# ------------------
modes = mapper.Pmod(modes)
modes1 = modes.copy()
# support projection
# ------------------
modes = mapper.Psup(modes)
# metrics
#modes1 -= modes0
#eMod = mapper.l2norm(modes1, modes0)
eMod = mapper.Emod(modes)
modes0 -= modes
eCon = mapper.l2norm(modes0, modes)
if rank == 0:
update_progress(i / max(1.0, float(iters - 1)), 'ERA', i, eCon,
eMod)
eMods.append(eMod)
eCons.append(eCon)
info = {}
info['eMod'] = eMods
info['eCon'] = eCons
info.update(mapper.finish(modes))
O = mapper.object(modes)
return O, info
