Enumerations

class ptychi.api.enums.AffineDegreesOfFreedom(*values)

Bases: StrEnum

ASYMMETRY = 'asymmetry'

ROTATION = 'rotation'

SCALE = 'scale'

SHEAR = 'shear'

TRANSLATION = 'translation'

class ptychi.api.enums.BatchingModes(*values)

Bases: StrEnum

COMPACT = 'compact'

RANDOM = 'random'

UNIFORM = 'uniform'

class ptychi.api.enums.DIPModels(*values)

Bases: StrEnum

AUTOENCODER = 'autoencoder'

UNET = 'unet'

class ptychi.api.enums.Devices(*values)

Bases: StrEnum

CPU = 'cpu'

GPU = 'gpu'

class ptychi.api.enums.Directions(*values)

Bases: StrEnum

X = 'x'

XY = 'xy'

Y = 'y'

class ptychi.api.enums.Dtypes(*values)

Bases: StrEnum

FLOAT16 = 'float16'

FLOAT32 = 'float32'

FLOAT64 = 'float64'

class ptychi.api.enums.ForwardModels(*values)

Bases: StrEnum

PLANAR_PTYCHOGRAPHY = 'planar_ptychography'

base = 'base'

class ptychi.api.enums.ImageGradientMethods(*values)

Bases: StrEnum

FOURIER_DIFFERENTIATION = 'fourier_differentiation'

FOURIER_SHIFT = 'fourier_shift'

GAUSSIAN = 'gaussian'

NEAREST = 'nearest'

class ptychi.api.enums.ImageIntegrationMethods(*values)

Bases: StrEnum

DECONVOLUTION = 'deconvolution'

DISCRETE = 'discrete'

FOURIER = 'fourier'

class ptychi.api.enums.LossFunctions(*values)

Bases: StrEnum

MSE = 'mse'

MSE_SQRT = 'mse_sqrt'

POISSON = 'poisson'

class ptychi.api.enums.MagPhaseComponents(*values)

Bases: StrEnum

BOTH = 'both'

MAGNITUDE = 'magnitude'

PHASE = 'phase'

class ptychi.api.enums.NoiseModels(*values)

Bases: StrEnum

GAUSSIAN = 'gaussian'

POISSON = 'poisson'

class ptychi.api.enums.OPRWeightSmoothingMethods(*values)

Bases: StrEnum

MEDIAN = 'median'

POLYNOMIAL = 'polynomial'

class ptychi.api.enums.ObjectPosOriginCoordsMethods(*values)

Bases: StrEnum

POSITIONS = 'positions'

SPECIFIED = 'specified'

SUPPORT = 'support'

class ptychi.api.enums.Optimizers(*values)

Bases: StrEnum

ADADELTA = 'adadelta'

ADAGRAD = 'adagrad'

ADAM = 'adam'

ADAMAX = 'adamax'

ADAMW = 'adamw'

ASGD = 'asgd'

LBFGS = 'lbfgs'

RADAM = 'radam'

RMSPROP = 'rmsprop'

SGD = 'sgd'

SPARSE_ADAM = 'sparse_adam'

class ptychi.api.enums.OrthogonalizationMethods(*values)

Bases: StrEnum

GS = 'gs'

SVD = 'svd'

class ptychi.api.enums.PatchInterpolationMethods(*values)

Bases: StrEnum

BILINEAR = 'bilinear'

FOURIER = 'fourier'

NEAREST = 'nearest'

class ptychi.api.enums.PositionCorrectionTypes(*values)

Bases: StrEnum

CROSS_CORRELATION = 'cross_correlation'

GRADIENT = 'gradient'

class ptychi.api.enums.ProbeSupportMethods(*values)

Bases: StrEnum

ELLIPSE = 'ellipse'

NONE = 'none'

RECTANGLE = 'rectangle'

class ptychi.api.enums.Reconstructors(*values)

Bases: StrEnum

AD_GENERAL = 'ad_general'

AD_PTYCHO = 'ad_ptycho'

BH = 'bh'

DM = 'dm'

EPIE = 'epie'

LSQML = 'lsqml'

PIE = 'pie'

RPIE = 'rpie'

base = 'base'