org.jscience.physics.nuclear.kinematics.math.analysis
Class Parameter

java.lang.Object
  org.jscience.physics.nuclear.kinematics.math.analysis.Parameter

public class Parameter
extends java.lang.Object

Parameters used to fit.

INT

integer, such as Number of Peaks, or Minimum Channel

DOUBLE

standard variable fit parameter, includes a "fix value" checkbox

TEXT

field showing fit function and/or brief instructions

BOOLEAN

true/false option, such as Include Background, or Display Output (how this would be implemented, I'm not sure)

Options. You can use as many options as you want.

(NO_)OUTPUT

is calculated and has no associated error bars (e.g. Chi-Squared)

(NO_)MOUSE

value can be obtained with mouse from screen

(NO_)ESTIMATE

can be estimated

(NO_)FIX

value is fixed..do not vary during fit

Field Summary

static int	BOOLEAN Parameter is a boolean value...displayed as a checkbox.
static int	DOUBLE Parameter is a floating point number.
static int	ERROR DOCUMENT ME!
protected boolean	estimate Whether or not this parameter should be estimated automatically before doing fit.
static int	ESTIMATE DOCUMENT ME!
protected boolean	fix Whether or not the parameter is currently fixed.
static int	FIX DOCUMENT ME!
static int	INT Parameter is an integer number, e.g., a histogram channel number.
static int	KNOWN DOCUMENT ME!
static int	MOUSE DOCUMENT ME!
static int	NO_ERROR DOCUMENT ME!
static int	NO_ESTIMATE DOCUMENT ME!
static int	NO_FIX DOCUMENT ME!
static int	NO_KNOWN DOCUMENT ME!
static int	NO_MOUSE DOCUMENT ME!
static int	NO_OUTPUT DOCUMENT ME!
static int	OUTPUT DOCUMENT ME!
static int	TEXT Parameter is simply a text box.
static int	TYPE DOCUMENT ME!

Constructor Summary

Parameter(java.lang.String name, int options)
Creates a new Parameter object.

Parameter(java.lang.String name, int option1, int option2)
Creates a new Parameter object.

Parameter(java.lang.String name, int option1, int option2, int option3)
Creates a new Parameter object.

Parameter(java.lang.String name, int option1, int option2, int option3, int option4)
Creates a new Parameter object.

Parameter(java.lang.String name, int option1, int option2, int option3, int option4, int option5)
Creates a new Parameter object.

Parameter(java.lang.String name, int option1, int option2, int option3, int option4, int option5, int option6)
Creates a new Parameter object.

Method Summary

boolean	getBooleanValue() DOCUMENT ME!
double	getDoubleError() DOCUMENT ME!
double	getDoubleValue() DOCUMENT ME!
int	getIntValue() DOCUMENT ME!
double	getKnown() DOCUMENT ME!
java.lang.String	getName() DOCUMENT ME!
int	getOptions() DOCUMENT ME!
int	getType() DOCUMENT ME!
boolean	isBoolean() DOCUMENT ME!
boolean	isEstimate() DOCUMENT ME!
boolean	isFix() Tells whether the parameter is currently fixed.
boolean	isNumberField() DOCUMENT ME!
boolean	isTextField() Returns true if the parameter is represented by a text field in the dialog box.
void	setError(double err) DOCUMENT ME!
void	setEstimate(boolean state) DOCUMENT ME!
void	setFix(boolean state) DOCUMENT ME!
void	setKnown(double inKnown) DOCUMENT ME!
void	setValue(boolean flag) DOCUMENT ME!
void	setValue(double value) Set the floating point value.
void	setValue(double value, double error) DOCUMENT ME!
void	setValue(int value) DOCUMENT ME!
void	setValue(java.lang.String text) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final int TYPE

DOCUMENT ME!

See Also:

Constant Field Values

INT

public static final int INT

Parameter is an integer number, e.g., a histogram channel number.

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

Parameter is a floating point number.

See Also:

Constant Field Values

BOOLEAN

public static final int BOOLEAN

Parameter is a boolean value...displayed as a checkbox.

See Also:

Constant Field Values

TEXT

public static final int TEXT

Parameter is simply a text box.

See Also:

Constant Field Values

ERROR

public static final int ERROR

DOCUMENT ME!

See Also:

Constant Field Values

NO_ERROR

public static final int NO_ERROR

DOCUMENT ME!

See Also:

Constant Field Values

FIX

public static final int FIX

DOCUMENT ME!

See Also:

Constant Field Values

NO_FIX

public static final int NO_FIX

DOCUMENT ME!

See Also:

Constant Field Values

ESTIMATE

public static final int ESTIMATE

DOCUMENT ME!

See Also:

Constant Field Values

NO_ESTIMATE

public static final int NO_ESTIMATE

DOCUMENT ME!

See Also:

Constant Field Values

MOUSE

public static final int MOUSE

DOCUMENT ME!

See Also:

Constant Field Values

NO_MOUSE

public static final int NO_MOUSE

DOCUMENT ME!

See Also:

Constant Field Values

OUTPUT

public static final int OUTPUT

DOCUMENT ME!

See Also:

Constant Field Values

NO_OUTPUT

public static final int NO_OUTPUT

DOCUMENT ME!

See Also:

Constant Field Values

KNOWN

public static final int KNOWN

DOCUMENT ME!

See Also:

Constant Field Values

NO_KNOWN

public static final int NO_KNOWN

DOCUMENT ME!

See Also:

Constant Field Values

fix

protected boolean fix

Whether or not the parameter is currently fixed.

estimate

protected boolean estimate

Whether or not this parameter should be estimated automatically before doing fit.

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 int options)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

options - DOCUMENT ME!

Parameter

public Parameter(java.lang.String name,
                 int option1,
                 int option2)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

option1 - DOCUMENT ME!

option2 - DOCUMENT ME!

Parameter

public Parameter(java.lang.String name,
                 int option1,
                 int option2,
                 int option3)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

option1 - DOCUMENT ME!

option2 - DOCUMENT ME!

option3 - DOCUMENT ME!

Parameter

public Parameter(java.lang.String name,
                 int option1,
                 int option2,
                 int option3,
                 int option4)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

option1 - DOCUMENT ME!

option2 - DOCUMENT ME!

option3 - DOCUMENT ME!

option4 - DOCUMENT ME!

Parameter

public Parameter(java.lang.String name,
                 int option1,
                 int option2,
                 int option3,
                 int option4,
                 int option5)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

option1 - DOCUMENT ME!

option2 - DOCUMENT ME!

option3 - DOCUMENT ME!

option4 - DOCUMENT ME!

option5 - DOCUMENT ME!

Parameter

public Parameter(java.lang.String name,
                 int option1,
                 int option2,
                 int option3,
                 int option4,
                 int option5,
                 int option6)

Creates a new Parameter object.

Parameters:

name - DOCUMENT ME!

option1 - DOCUMENT ME!

option2 - DOCUMENT ME!

option3 - DOCUMENT ME!

option4 - DOCUMENT ME!

option5 - DOCUMENT ME!

option6 - DOCUMENT ME!

Method Detail

getName

public java.lang.String getName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getType

public int getType()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getOptions

public int getOptions()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setFix

public void setFix(boolean state)

DOCUMENT ME!

Parameters:

state - DOCUMENT ME!

isFix

public boolean isFix()

Tells whether the parameter is currently fixed.

Returns:

DOCUMENT ME!

setEstimate

public void setEstimate(boolean state)

DOCUMENT ME!

Parameters:

state - DOCUMENT ME!

isEstimate

public boolean isEstimate()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setValue

public void setValue(double value)
              throws FitException

Set the floating point value.

Parameters:

value - DOCUMENT ME!

Throws:

FitException - thrown if unrecoverable error occurs

setValue

public void setValue(double value,
                     double error)

DOCUMENT ME!

Parameters:

value - DOCUMENT ME!

error - DOCUMENT ME!

setValue

public void setValue(int value)

DOCUMENT ME!

Parameters:

value - DOCUMENT ME!

setValue

public void setValue(java.lang.String text)

DOCUMENT ME!

Parameters:

text - DOCUMENT ME!

setValue

public void setValue(boolean flag)

DOCUMENT ME!

Parameters:

flag - DOCUMENT ME!

setError

public void setError(double err)

DOCUMENT ME!

Parameters:

err - DOCUMENT ME!

setKnown

public void setKnown(double inKnown)

DOCUMENT ME!

Parameters:

inKnown - DOCUMENT ME!

getDoubleValue

public double getDoubleValue()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getIntValue

public int getIntValue()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getBooleanValue

public boolean getBooleanValue()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getDoubleError

public double getDoubleError()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getKnown

public double getKnown()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isBoolean

public boolean isBoolean()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isNumberField

public boolean isNumberField()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isTextField

public boolean isTextField()

Returns true if the parameter is represented by a text field in the dialog box.

Returns:

DOCUMENT ME!