public static class PMMMutualInformation.PMMMutualInformationParameterSet extends Measure.MeasureParameterSet
PMMMutualInformation
structure
Measure
.ParameterSet.ParameterList
errorMessage, parameters, parent
Constructor and Description |
---|
PMMMutualInformationParameterSet()
Creates a new
PMMMutualInformation.PMMMutualInformationParameterSet with empty
parameter values. |
PMMMutualInformationParameterSet(byte order,
BTMutualInformation.DataSource clazz,
double[] ess)
Creates a new
PMMMutualInformation.PMMMutualInformationParameterSet with the
parameter for the order set to order , the parameter for
the BTMutualInformation.DataSource set to clazz and the parameter
for the equivalent sample sizes (ess) set to ess . |
PMMMutualInformationParameterSet(StringBuffer representation)
Creates a new
PMMMutualInformation.PMMMutualInformationParameterSet from its
XML representation as defined by the Storable
interface. |
Modifier and Type | Method and Description |
---|---|
BTMutualInformation.DataSource |
getClazz()
Returns the source of the data to compute the mutual information as
defined by this set of parameters.
|
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 PMMMutualInformationParameterSet() throws ParameterException
PMMMutualInformation.PMMMutualInformationParameterSet
with empty
parameter values.ParameterException
- if the parameters could not be createdpublic PMMMutualInformationParameterSet(byte order, BTMutualInformation.DataSource clazz, double[] ess) throws Exception
PMMMutualInformation.PMMMutualInformationParameterSet
with the
parameter for the order set to order
, the parameter for
the BTMutualInformation.DataSource
set to clazz
and the parameter
for the equivalent sample sizes (ess) set to ess
.order
- the orderclazz
- the source of the data to compute the mutual informationess
- 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 PMMMutualInformationParameterSet(StringBuffer representation) throws NonParsableException
PMMMutualInformation.PMMMutualInformationParameterSet
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 BTMutualInformation.DataSource getClazz()
public byte getOrder()
public String getInstanceComment()
InstanceParameterSet
ParameterSet
.getInstanceComment
in class InstanceParameterSet<Measure>
public String getInstanceName()
InstanceParameterSet
ParameterSet
.getInstanceName
in class InstanceParameterSet<Measure>