dwvisser.analysis
Class Parameter

java.lang.Object
  |
  +--dwvisser.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
protected boolean	estimate Whether or not this parameter should be estimated automatically before doing fit.
static int	ESTIMATE
protected boolean	fix Whether or not the parameter is currently fixed.
static int	FIX
static int	INT Parameter is an integer number, e.g., a histogram channel number.
static int	KNOWN
static int	MOUSE
static int	NO_ERROR
static int	NO_ESTIMATE
static int	NO_FIX
static int	NO_KNOWN
static int	NO_MOUSE
static int	NO_OUTPUT
static int	OUTPUT
static int	TEXT Parameter is simply a text box.
static int	TYPE

Constructor Summary

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

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

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

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

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

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

Method Summary

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

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

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

See Also:

Constant Field Values

NO_ERROR

public static final int NO_ERROR

See Also:

Constant Field Values

FIX

public static final int FIX

See Also:

Constant Field Values

NO_FIX

public static final int NO_FIX

See Also:

Constant Field Values

ESTIMATE

public static final int ESTIMATE

See Also:

Constant Field Values

NO_ESTIMATE

public static final int NO_ESTIMATE

See Also:

Constant Field Values

MOUSE

public static final int MOUSE

See Also:

Constant Field Values

NO_MOUSE

public static final int NO_MOUSE

See Also:

Constant Field Values

OUTPUT

public static final int OUTPUT

See Also:

Constant Field Values

NO_OUTPUT

public static final int NO_OUTPUT

See Also:

Constant Field Values

KNOWN

public static final int KNOWN

See Also:

Constant Field Values

NO_KNOWN

public static final int NO_KNOWN

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)

Parameter

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

Parameter

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

Parameter

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

Parameter

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

Parameter

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

Method Detail

getName

public java.lang.String getName()

getType

public int getType()

getOptions

public int getOptions()

setFix

public void setFix(boolean state)

isFix

public boolean isFix()

Tells whether the parameter is currently fixed.

setEstimate

public void setEstimate(boolean state)

isEstimate

public boolean isEstimate()

setValue

public void setValue(double value)
              throws FitException

Set the floating point value.

Throws:

FitException - thrown if unrecoverable error occurs

setValue

public void setValue(double value,
                     double error)

setValue

public void setValue(int value)

setValue

public void setValue(java.lang.String text)

setValue

public void setValue(boolean flag)

setError

public void setError(double err)

setKnown

public void setKnown(double inKnown)

getDoubleValue

public double getDoubleValue()

getIntValue

public int getIntValue()

getBooleanValue

public boolean getBooleanValue()

getDoubleError

public double getDoubleError()

getKnown

public double getKnown()

isBoolean

public boolean isBoolean()

isNumberField

public boolean isNumberField()

isTextField

public boolean isTextField()

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