Module simpa.core

Package simpa.core.api

Class Evaluator

java.lang.Object

simpa.core.api.Evaluator

public class Evaluator
extends Object

Factory for field map evaluators.

Constructor Summary

Constructors

Constructor	Description
Evaluator()

Method Summary

Modifier and Type	Method	Description
static PotentialProvider	createFieldMapEvaluator(String binaryFile, double scaling)	Creates a PotentialProvider of type SHFieldEvaluator for evaluating field maps.
double[][][]	evaluateAtTargets(List<? extends PointSource> sources, List<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> targets)	Evaluator using the fast multipole method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Evaluator

public Evaluator()

Method Details

createFieldMapEvaluator

public static PotentialProvider createFieldMapEvaluator(String binaryFile,
 double scaling)
                                                 throws IOException

Creates a PotentialProvider of type SHFieldEvaluator for evaluating field maps. The returned PotentialProvider is suitable for tracking.

Parameters:

binaryFile - input file

scaling - scaling of the input

Returns:

a PotentialProvider for evaluation of field maps

Throws:

IOException

evaluateAtTargets

public double[][][] evaluateAtTargets(List<? extends PointSource> sources,
 List<org.apache.commons.math3.geometry.euclidean.threed.Vector3D> targets)

Evaluator using the fast multipole method. This is for evaluate the field of many point sources on many target points, but not suitable for tracking.

Parameters:

sources - List of point sources.

targets - List of points to be evaluated at.

Returns:

An 3D array of potential (Three vector potential and one scalar potential) and derivatives. The layout of the array is the following: [targetIndex][potentialIndex][derivativeIndex]