de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures.btMeasures
Class BTMutualInformation.BTMutualInformationParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.parameters.InstanceParameterSet<Measure>
          de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures.Measure.MeasureParameterSet
              de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures.btMeasures.BTMutualInformation.BTMutualInformationParameterSet

All Implemented Interfaces:

GalaxyConvertible, Storable, Cloneable

Enclosing class:

BTMutualInformation

public static class BTMutualInformation.BTMutualInformationParameterSet
extends Measure.MeasureParameterSet

Class for the parameters of a BTMutualInformation structure Measure.

Author:

Jan Grau

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

BTMutualInformation.BTMutualInformationParameterSet()
Creates a new BTMutualInformation.BTMutualInformationParameterSet with empty parameter values.

BTMutualInformation.BTMutualInformationParameterSet(BTMutualInformation.DataSource clazz, double[] ess)
Creates a new BTMutualInformation.BTMutualInformationParameterSet with the parameter for the BTMutualInformation.DataSource set to clazz and the parameter for the equivalent sample sizes (ess) set to ess.

BTMutualInformation.BTMutualInformationParameterSet(StringBuffer representation)
The standard constructor for the interface Storable .

Method Summary

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.

Methods inherited from class de.jstacs.parameters.InstanceParameterSet

fromXML, getInstance, getInstanceClass, toXML

Methods inherited from class de.jstacs.parameters.ParameterSet

clone, fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy

Methods inherited from class java.lang.Object

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

Constructor Detail

BTMutualInformation.BTMutualInformationParameterSet

public BTMutualInformation.BTMutualInformationParameterSet()
                                                    throws ParameterException

Creates a new BTMutualInformation.BTMutualInformationParameterSet with empty parameter values.

Throws:

ParameterException - if the parameters could not be created

BTMutualInformation.BTMutualInformationParameterSet

public BTMutualInformation.BTMutualInformationParameterSet(BTMutualInformation.DataSource clazz,
                                                           double[] ess)
                                                    throws Exception

Creates a new BTMutualInformation.BTMutualInformationParameterSet with the parameter for the BTMutualInformation.DataSource set to clazz and the parameter for the equivalent sample sizes (ess) set to ess.

Parameters:

clazz - the source of the data to compute the mutual information

ess - 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 classes

Throws:

Exception - if the parameters could not be created or set

BTMutualInformation.BTMutualInformationParameterSet

public BTMutualInformation.BTMutualInformationParameterSet(StringBuffer representation)
                                                    throws NonParsableException

The standard constructor for the interface Storable . Creates a new BTMutualInformation.BTMutualInformationParameterSet from its XML representation as defined by the Storable interface.

Parameters:

representation - the XML code as StringBuffer

Throws:

NonParsableException - if the XML representation could not be parsed

Method Detail

getEss

public double[] getEss()

Returns the equivalent sample sizes (ess) defined by this set of parameters.

Returns:

the ess

getClazz

public BTMutualInformation.DataSource getClazz()

Returns the source of the data to compute the mutual information as defined by this set of parameters.

Returns:

the source of the data

getInstanceComment

public String getInstanceComment()

Description copied from class: InstanceParameterSet

Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.

Specified by:

getInstanceComment in class InstanceParameterSet<Measure>

Returns:

the comment of the class

getInstanceName

public String getInstanceName()

Description copied from class: InstanceParameterSet

Returns the name of an instance of the class that can be constructed using this ParameterSet.

Specified by:

getInstanceName in class InstanceParameterSet<Measure>

Returns:

the name of the class