vampire

Submodules

vampire.classic_algorithms_vampire module

class vampire.classic_algorithms_vampire.LSGPA(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, **kwargs)[source]

Bases: LSGPABASE, RetrievePulsesVAMPIRE

The Least-Squares Generalized Projection Algorithm. Only available for delay based non-interferometric methods.

  1. Gagnon et al., Appl. Phys. B 92, 25-32, 10.1007/s00340-008-3063-x (2008)

class vampire.classic_algorithms_vampire.CPCGPA(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, constraints=False, svd=False, antialias=False, **kwargs)[source]

Bases: CPCGPABASE, RetrievePulsesVAMPIRE

The Constrained-PCGP-Algorithm. Only available for delay based non-interferometric methods. Transforms population to time domain during initialization.

    1. Kane and A. B. Vakhtin, Prog. Quantum Electron. 81 (100364), 10.1016/j.pquantelec.2021.100364 (2022)

constraints

if true the operator based constraints are used.

Type:

bool

svd

if true a full SVD is performed instead of a single iteration of the power method

Type:

bool

antialias

if true anti-aliasing is applied to the outer-product-matrix-form

Type:

bool

calculate_gate(gate_pulse, measurement_info)[source]
class vampire.classic_algorithms_vampire.GeneralizedProjection(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, **kwargs)[source]

Bases: GeneralizedProjectionBASE, RetrievePulsesVAMPIRE

Implements the Generalized Projection Algorithm.

    1. DeLong et al., Opt. Lett. 19, 2152-2154 (1994)

no_steps_descent

the numer of descent steps per iteration

Type:

int

optimize_spectral_phase_directly
Type:

bool

calculate_Z_gradient_individual(signal_t, signal_t_new, tau_arr, measurement_info, pulse_or_gate)[source]

Calculates the Z-error gradient for an individual.

calculate_Z_newton_direction(grad, signal_t_new, signal_t, tau_arr, descent_state, measurement_info, descent_info, full_or_diagonal, pulse_or_gate)[source]

Calculates the Z-error newton direction for a population.

class vampire.classic_algorithms_vampire.PtychographicIterativeEngine(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, **kwargs)[source]

Bases: PtychographicIterativeEngineBASE, RetrievePulsesVAMPIRE

Implements a version of the Ptychographic Iterative Engine (PIE).

A. Maiden et al., Optica 4, 736-745 (2017) T. Schweizer, “Time-Domain Ptychography and its Applications in Ultrafast Science”, PhD Thesis, Bern (2021)

alpha

a regularization parameter

Type:

float

pie_method

specifies the PIE variant. Can be one of None, PIE, ePIE, rPIE. Where None indicates that the pure gradient is used.

Type:

None, str

optimize_spectral_phase_directly
Type:

bool

calculate_PIE_descent_direction_m(signal_t, signal_t_new, tau, pie_method, measurement_info, descent_info, pulse_or_gate)[source]

Calculates the PIE direction for a given shift.

calculate_PIE_newton_direction(grad, signal_t, tau_arr, measured_trace, local_or_global_state, measurement_info, descent_info, pulse_or_gate, local_or_global)[source]

Calculates the PIE newton direction for a population.

class vampire.classic_algorithms_vampire.COPRA(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, **kwargs)[source]

Bases: COPRABASE, RetrievePulsesVAMPIRE

Implements a version of the Common Pulse Retrieval Algorithm (COPRA).

    1. Geib et al., Optica 6, 495-505 (2019)

get_Z_gradient_individual(signal_t, signal_t_new, tau_arr, measurement_info, pulse_or_gate)[source]

Calculates the Z-error gradient for an individual.

get_Z_newton_direction(grad, signal_t, signal_t_new, tau_arr, local_or_global_state, measurement_info, descent_info, full_or_diagonal, pulse_or_gate)[source]

Calculates the Z-error newton direction for a population.

class vampire.classic_algorithms_vampire.LSF(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, **kwargs)[source]

Bases: LSFBASE, RetrievePulsesVAMPIRE

Implements a version of the Linesearch FROG Algorithm (LSF). Despite its name the algorithm is NOT restricted to FROG.

    1. Krook and V. Pasiskevicius, Opt. Express 33, 33258-33269 (2025)

no_sections

number of sections to split the search line into

Type:

int

number_of_disection_iterations

as the name says

Type:

int

direction_mode

can be random or continuous

Type:

str

ratio_points_for_continuous

smaller value means more randomness/eratic

Type:

int

only_allow_improvements

if true, only steps that decrease the error will be accepted

Type:

bool

vampire.general_algorithms_vampire module

class vampire.general_algorithms_vampire.DifferentialEvolution(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, strategy='best1_bin', selection_mechanism='greedy', mutation_rate=0.5, crossover_rate=0.7, **kwargs)[source]

Bases: DifferentialEvolutionBASE, RetrievePulsesVAMPIRE

Implements a Differential-Evolution Algorithm. Based on Qiang, J., Mitchell, C., A Unified Differential Evolution Algorithm for Global Optimization, 2014, https://www.osti.gov/servlets/purl/1163659

strategy

the mutation and selection strategy, analogous to scipy’s differential evolution.

Type:

str

mutation_rate

the mutation rate

Type:

float

crossover_rate

the crossover rate

Type:

float

selection_mechanism

the selection mechanism, can be greedy or global, defined in select_population().

Type:

str

temperature

a temperature value for the global selection mechanism

Type:

float

class vampire.general_algorithms_vampire.Evosax(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, solver=None, **kwargs)[source]

Bases: EvosaxBASE, RetrievePulsesVAMPIRE

Employs the evosax package to perform the optimization.

Robert Tjarko Lange, evosax: JAX-based Evolution Strategies, arXiv preprint arXiv:2212.04180 (2022)

solver

any evosax-solver should work

Type:

evosax-solver

solver_params

user defined parameters for the evosax-solver, if None the default params set in evosax are used

Type:

any

solver_kwargs

some evosax-solver require additional input arguments. These can be supplied via this aattribute.

Type:

dict

class vampire.general_algorithms_vampire.AutoDiff(delay, frequency, measured_trace, nonlinear_method, tau_interferometer=0, material_thickness=0, refractive_index=<refractiveindex.refractiveindex.RefractiveIndexMaterial object>, cross_correlation=False, solver=None, **kwargs)[source]

Bases: AutoDiffBASE, RetrievePulsesVAMPIRE

Employs the optimistix package to perform the optimization via Automatic-Differentiation.

J. Rader, T. Lyons and P.Kidger, Optimistix: modular optimisation in JAX and Equinox, arXiv:2402.09983 (2024) DeepMind et al., The DeepMind JAX Ecosystem, http://github.com/google-deepmind (2020)

solver

solvers need to be initialized

Type:

optimistix-solver, optax-solver

alternating_optimization

if true, the optimizer alternates between amplitude and phase

Type:

bool

optimize_group_delay

if true, the group delay will be optimized instead of the spectral phase

Type:

bool

Module contents