org.freehep.math.minuit

Class MnScan

java.lang.Object

org.freehep.math.minuit.MnApplication

org.freehep.math.minuit.MnScan

public class MnScan
extends MnApplication

MnScan scans the value of the user function by varying one parameter. It is sometimes useful for debugging the user function or finding a reasonable starting point.

Constructor Summary

Constructors

Constructor and Description
MnScan(FCNBase fcn, double[] par, double[] err) construct from FCNBase + double[] for parameters and errors with default strategy
MnScan(FCNBase fcn, double[] par, double[] err, int stra) construct from FCNBase + double[] for parameters and errors
MnScan(FCNBase fcn, double[] par, MnUserCovariance cov) construct from FCNBase + double[] for parameters and MnUserCovariance with default strategy
MnScan(FCNBase fcn, double[] par, MnUserCovariance cov, int stra) construct from FCNBase + double[] for parameters and MnUserCovariance
MnScan(FCNBase fcn, MnUserParameters par) construct from FCNBase + MnUserParameters with default strategy
MnScan(FCNBase fcn, MnUserParameters par, int stra) construct from FCNBase + MnUserParameters
MnScan(FCNBase fcn, MnUserParameters par, MnUserCovariance cov) construct from FCNBase + MnUserParameters + MnUserCovariance with default strategy
MnScan(FCNBase fcn, MnUserParameters par, MnUserCovariance cov, int stra) construct from FCNBase + MnUserParameters + MnUserCovariance
MnScan(FCNBase fcn, MnUserParameterState par, MnStrategy str) construct from FCNBase + MnUserParameterState + MnStrategy

Method Summary

Modifier and Type	Method and Description
java.util.List<Point>	scan(int par)
java.util.List<Point>	scan(int par, int maxsteps)
java.util.List<Point>	scan(int par, int maxsteps, double low, double high) Scans the value of the user function by varying parameter number par, leaving all other parameters fixed at the current value.

Methods inherited from class org.freehep.math.minuit.MnApplication

add, add, add, checkAnalyticalDerivatives, covariance, error, error, errorDef, errors, fcnbase, fix, fix, index, minimize, minimize, minimize, name, numOfCalls, parameters, params, precision, release, release, removeLimits, removeLimits, setCheckAnalyticalDerivatives, setError, setError, setErrorDef, setLimits, setLimits, setPrecision, setUseAnalyticalDerivatives, setValue, setValue, state, strategy, useAnalyticalDerivaties, value, value, variableParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

MnScan

public MnScan(FCNBase fcn,
              double[] par,
              double[] err)

construct from FCNBase + double[] for parameters and errors with default strategy

MnScan

public MnScan(FCNBase fcn,
              double[] par,
              double[] err,
              int stra)

construct from FCNBase + double[] for parameters and errors

MnScan

public MnScan(FCNBase fcn,
              double[] par,
              MnUserCovariance cov)

construct from FCNBase + double[] for parameters and MnUserCovariance with default strategy

MnScan

public MnScan(FCNBase fcn,
              double[] par,
              MnUserCovariance cov,
              int stra)

construct from FCNBase + double[] for parameters and MnUserCovariance

MnScan

public MnScan(FCNBase fcn,
              MnUserParameters par)

construct from FCNBase + MnUserParameters with default strategy

MnScan

public MnScan(FCNBase fcn,
              MnUserParameters par,
              int stra)

construct from FCNBase + MnUserParameters

MnScan

public MnScan(FCNBase fcn,
              MnUserParameters par,
              MnUserCovariance cov)

construct from FCNBase + MnUserParameters + MnUserCovariance with default strategy

MnScan

public MnScan(FCNBase fcn,
              MnUserParameters par,
              MnUserCovariance cov,
              int stra)

construct from FCNBase + MnUserParameters + MnUserCovariance

MnScan

public MnScan(FCNBase fcn,
              MnUserParameterState par,
              MnStrategy str)

construct from FCNBase + MnUserParameterState + MnStrategy

Method Detail

scan

public java.util.List<Point> scan(int par)

scan

public java.util.List<Point> scan(int par,
                                  int maxsteps)

scan

public java.util.List<Point> scan(int par,
                                  int maxsteps,
                                  double low,
                                  double high)

Scans the value of the user function by varying parameter number par, leaving all other parameters fixed at the current value. If par is not specified, all variable parameters are scanned in sequence. The number of points npoints in the scan is 40 by default, and cannot exceed 100. The range of the scan is by default 2 standard deviations on each side of the current best value, but can be specified as from low to high. After each scan, if a new minimum is found, the best parameter values are retained as start values for future scans or minimizations. The curve resulting from each scan can be plotted on the output terminal using MnPlot in order to show the approximate behaviour of the function.