finesse.solutions.array.ArraySolution.update

ArraySolution.update(self, int index, bool mask) → int

Calling this will compute all detector outputs and add an entry to the outputs stored. Calling it multiple times without re-running the simulation will result in duplicate entries.

enable_update must be called to setup which detectors will be written to this solution object.

Parameters

index(int, …)

Index to calculate the outputs for, use tuples of N-size for N-dimensional outputs

maskboolean

Sets the index of all outputs to np.nan if true. This should be used when a recoverable invalidity has occurred at some point in the scan of a parameter of a simulation - e.g. invalid beam tracing due to instabilities.

Returns

numint

Number of entries updated so far.