ptypy.engines.base.Base3dBraggEngine#

class ptypy.engines.base.Base3dBraggEngine(ptycho, pars=None)#

3d Bragg engines need a slightly different prepare() method, because a 2d probe support makes no sense (at least not yet…)

Defaults:

[probe_support] default = None

__init__(ptycho, pars=None)#: Base reconstruction engine. :param ptycho: The parent Ptycho object. :type ptycho: Ptycho :param pars: Initialization parameters :type pars: Param or dict

Methods

`__init__`(ptycho[, pars])	Base reconstruction engine.
`engine_finalize`()	Engine-specific finalization.
`engine_initialize`()	Engine-specific initialization.
`engine_iterate`(num)	Engine single-step iteration.
`engine_prepare`()	Engine-specific preparation.
`finalize`()	Clean up after iterations are done.
`initialize`()	Prepare for reconstruction.
`iterate`([num])	Compute one or several iterations.
`prepare`()	Last-minute preparation before iterating.
`support_constraint`([storage])	Enforces 2D support contraint on probe.

Attributes

COMPATIBLE_MODELS

engine_finalize()#: Engine-specific finalization. Used to wrap-up engine-specific stuff. Called at the end of self.finalize()

engine_initialize()#: Engine-specific initialization. Called at the end of self.initialize().

engine_iterate(num)#: Engine single-step iteration. All book-keeping is done in self.iterate(), so this routine only needs to implement the “core” actions.

engine_prepare()#: Engine-specific preparation. Last-minute initialization providing up-to-date information for reconstruction. Called at the end of self.prepare()

iterate(num=None)#

Compute one or several iterations.

numNone, int number of iterations.: If None or num<1, a single iteration is performed.

support_constraint(storage=None)#: Enforces 2D support contraint on probe.