public static class PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet extends Measure.MeasureParameterSet
PMMExplainingAwayResidual
structure
Measure
.ParameterSet.ParameterList
errorMessage, parameters, parent
Constructor and Description |
---|
PMMExplainingAwayResidualParameterSet()
Creates a new
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet with
empty parameter values. |
PMMExplainingAwayResidualParameterSet(byte order,
double[] ess)
Creates a new
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet with the
parameter for the order set to order and the parameter
for the equivalent sample sizes (ess) set to ess . |
PMMExplainingAwayResidualParameterSet(StringBuffer representation)
Creates a new
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet from its
XML representation as defined by the Storable
interface. |
Modifier and Type | Method and Description |
---|---|
double[] |
getEss()
Returns the equivalent sample sizes (ess) defined by this set of
parameters.
|
String |
getInstanceComment()
Returns a comment (a textual description) of the class that can be
constructed using this
ParameterSet . |
String |
getInstanceName()
Returns the name of an instance of the class that can be constructed
using this
ParameterSet . |
byte |
getOrder()
Returns the order defined by this set of parameters.
|
fromXML, getInstance, getInstanceClass, toXML
clone, fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy
public PMMExplainingAwayResidualParameterSet() throws SimpleParameter.DatatypeNotValidException
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet
with
empty parameter values.SimpleParameter.DatatypeNotValidException
- if the parameters could not be createdpublic PMMExplainingAwayResidualParameterSet(byte order, double[] ess) throws Exception
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet
with the
parameter for the order set to order
and the parameter
for the equivalent sample sizes (ess) set to ess
.order
- the orderess
- the equivalent sample sizes for the foreground class and
the background, i.e. the background class or (in case of
more than two classes) all non-foreground classesException
- if the parameters could not be created or setpublic PMMExplainingAwayResidualParameterSet(StringBuffer representation) throws NonParsableException
PMMExplainingAwayResidual.PMMExplainingAwayResidualParameterSet
from its
XML representation as defined by the Storable
interface.representation
- the XML code as StringBuffer
NonParsableException
- if the XML representation could not be parsedpublic double[] getEss()
public byte getOrder()
public String getInstanceComment()
InstanceParameterSet
ParameterSet
.getInstanceComment
in class InstanceParameterSet<Measure>
public String getInstanceName()
InstanceParameterSet
ParameterSet
.getInstanceName
in class InstanceParameterSet<Measure>