Package qupath.lib.plugins.parameters

Class DoubleParameter

java.lang.Object

qupath.lib.plugins.parameters.NumericParameter<Double>

qupath.lib.plugins.parameters.DoubleParameter

All Implemented Interfaces:

Serializable, Parameter<Double>

public class DoubleParameter
extends NumericParameter<Double>

Parameter to represent a floating point numeric value.

May be bounded.

Author:

Pete Bankhead

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Double	lastValue

Method Summary

Modifier and Type	Method	Description
Parameter<Double>	duplicate()	Create a new Parameter with the same text and value.
Double	getDefaultValue()	Get a default value to use if the Parameter has not been otherwise set.
String	getHelpText()	Get a description of the meaning of the Parameter; may be displayed e.g.
String	getPrompt()	Get some prompt text that may be displayed to a user.
Double	getValue()	Get the current set value (may be null).
Double	getValueOrDefault()	Get the current set value, or any default if no value has been set.
boolean	hasHelpText()	Query whether getHelpText() returns a meaningful String (as opposed to null).
boolean	isHidden()	Test is the 'hidden' flag is set for the parameter.
void	resetValue()	Set last value to null (so default can be used).
boolean	setDoubleLastValue(double val)	A class for setting the numeric value as a double (subclasses should convert this as needed).
void	setHidden(boolean hidden)	Mark that a parameter should not be displayed to a user.
boolean	setValue(Double lastValue)	Set the last value; this will apply a range check using clipping.
boolean	setValueWithBoundsCheck(Double lastValue)	Set the value of this parameter, constraining it to be within any lower and upper bounds if necessary.
String	toString()

Methods inherited from class qupath.lib.plugins.parameters.NumericParameter

getLowerBound, getUnit, getUpperBound, hasLowerAndUpperBounds, hasLowerBound, hasUpperBound, isUnbounded, isValidInput, setRange, setStringLastValue

Methods inherited from class java.lang.Object

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

Field Details

lastValue

protected Double lastValue

Method Details

setValue

public boolean setValue(Double lastValue)

Set the last value; this will apply a range check using clipping.

Specified by:

setValue in interface Parameter<Double>

Parameters:

lastValue -

Returns:

setValueWithBoundsCheck

public boolean setValueWithBoundsCheck(Double lastValue)

Description copied from class: NumericParameter

Set the value of this parameter, constraining it to be within any lower and upper bounds if necessary.

Specified by:

setValueWithBoundsCheck in class NumericParameter<Double>

Parameters:

lastValue -

Returns:

setDoubleLastValue

public boolean setDoubleLastValue(double val)

Description copied from class: NumericParameter

A class for setting the numeric value as a double (subclasses should convert this as needed).

Specified by:

setDoubleLastValue in class NumericParameter<Double>

Parameters:

val -

Returns:

duplicate

public Parameter<Double> duplicate()

Description copied from interface: Parameter

Create a new Parameter with the same text and value.

Returns:

setHidden

public void setHidden(boolean hidden)

Description copied from interface: Parameter

Mark that a parameter should not be displayed to a user. This is useful, for example, if a parameter list changes the parameters to be displayed depending upon the image available or current settings, e.g. using different parameters when the pixel size is known in microns.

Specified by:

setHidden in interface Parameter<S>

Parameters:

hidden -

isHidden

public boolean isHidden()

Description copied from interface: Parameter

Test is the 'hidden' flag is set for the parameter.

Specified by:

isHidden in interface Parameter<S>

Returns:

getDefaultValue

public Double getDefaultValue()

Description copied from interface: Parameter

Get a default value to use if the Parameter has not been otherwise set.

Specified by:

getDefaultValue in interface Parameter<S>

Returns:

getValue

public Double getValue()

Description copied from interface: Parameter

Get the current set value (may be null).

Specified by:

getValue in interface Parameter<S>

Returns:

See Also:

• Parameter.setValue(S)
• Parameter.getValueOrDefault()

resetValue

public void resetValue()

Description copied from interface: Parameter

Set last value to null (so default can be used).

Specified by:

resetValue in interface Parameter<S>

getValueOrDefault

public Double getValueOrDefault()

Description copied from interface: Parameter

Get the current set value, or any default if no value has been set.

Specified by:

getValueOrDefault in interface Parameter<S>

Returns:

See Also:

• Parameter.setValue(S)
• Parameter.getValue()

getPrompt

public String getPrompt()

Description copied from interface: Parameter

Get some prompt text that may be displayed to a user.

Specified by:

getPrompt in interface Parameter<S>

Returns:

toString

public String toString()

Overrides:

toString in class Object

hasHelpText

public boolean hasHelpText()

Description copied from interface: Parameter

Query whether getHelpText() returns a meaningful String (as opposed to null).

Specified by:

hasHelpText in interface Parameter<S>

Returns:

getHelpText

public String getHelpText()

Description copied from interface: Parameter

Get a description of the meaning of the Parameter; may be displayed e.g. as a tooltip.

Specified by:

getHelpText in interface Parameter<S>

Returns: