Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.btMeasures
Class BTMutualInformation.BTMutualInformationParameterSet

    java.lang.Object
      de.jstacs.parameters.ParameterSet
          de.jstacs.parameters.InstanceParameterSet
              de.jstacs.scoringFunctions.directedGraphicalModels.structureLearning.measures.btMeasures.BTMutualInformation.BTMutualInformationParameterSet

All Implemented Interfaces:
  RangeIterator, Storable, Cloneable

Enclosing class:
  BTMutualInformation

    public static class BTMutualInformation.BTMutualInformationParameterSet

extends InstanceParameterSet

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, ranged`

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 ess set to `ess`.
`BTMutualInformation.BTMutualInformationParameterSet(StringBuffer representation)` Creates a new `BTMutualInformation.BTMutualInformationParameterSet` from its XML-representation as defined by the `Storable` interface.

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 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`.
`protected void` | `loadParameters()` Loads the parameters for this `ParameterSet`.

Methods inherited from class de.jstacs.parameters.InstanceParameterSet
`fromXML, getInstance, getInstanceClass, toXML`

Methods inherited from class de.jstacs.parameters.ParameterSet
`clone, getErrorMessage, getId, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, valuesToString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### BTMutualInformation.BTMutualInformationParameterSet

    public BTMutualInformation.BTMutualInformationParameterSet()

  Creates a new `BTMutualInformation.BTMutualInformationParameterSet` with empty parameter values.

### 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 ess set to `ess`.

  Parameters:
    `clazz` - the source of the data to compute the mutual information
    `ess` - the equivalent sample size 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` - is thrown if the parameters could not be created or set

### BTMutualInformation.BTMutualInformationParameterSet

    public BTMutualInformation.BTMutualInformationParameterSet(StringBuffer representation)
                                                        throws NonParsableException

  Creates a new `BTMutualInformation.BTMutualInformationParameterSet` from its XML-representation as defined by the `Storable` interface.

  Parameters:
    `representation` - the XML-code
  Throws:
    `NonParsableException` - is thrown if the XML-representation could not be parsed

Method Detail

### getEss

    public double[] getEss()

  Returns the 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`
  Returns:
    the comment

### 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`
  Returns:
    the name

### loadParameters

    protected void loadParameters()
                           throws Exception

  Description copied from class: `ParameterSet`
  Loads the parameters for this `ParameterSet`. This is in most cases done by calling `ParameterSet.initParameterList()` or `ParameterSet.initParameterList(int)` to initialize `ParameterSet.parameters` and afterwards filling `ParameterSet.parameters` with instances of subclasses of `Parameter`.

  Specified by:
    `loadParameters` in class `ParameterSet`
  Throws:
    `Exception` - an `Exception` is thrown if the parameters could not be loaded
  See Also:
    `ParameterSet.parameters`, `Parameter`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD