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.classifier.assessment
Class ClassifierAssessmentAssessParameterSet

    java.lang.Object
      de.jstacs.parameters.ParameterSet
          de.jstacs.classifier.assessment.ClassifierAssessmentAssessParameterSet

All Implemented Interfaces:
  RangeIterator, Storable, Cloneable

Direct Known Subclasses:
  KFoldCVAssessParameterSet, RepeatedHoldOutAssessParameterSet, RepeatedSubSamplingAssessParameterSet, Sampled_RepeatedHoldOutAssessParameterSet

    public class ClassifierAssessmentAssessParameterSet

extends ParameterSet

This class is the superclass used by all `ClassifierAssessmentAssessParameterSet`s. It is a container of user specified parameters that are necessary to define a run of an `assess( ... )`-method in a `ClassifierAssessment` instance.
It is recommended to extend this class for each subclass of `ClassifierAssessment`.

Author:
  Andre Gohr (bioinf (nospam:.) ag (nospam:@) googlemail (nospam:.) com)
See Also:
  `ClassifierAssessment.assess(de.jstacs.classifier.MeasureParameters, ClassifierAssessmentAssessParameterSet, de.jstacs.data.Sample...)`, `ClassifierAssessment.assess(de.jstacs.classifier.MeasureParameters, ClassifierAssessmentAssessParameterSet, de.jstacs.utils.ProgressUpdater, de.jstacs.data.Sample...)`, `ClassifierAssessment.assess(de.jstacs.classifier.MeasureParameters, ClassifierAssessmentAssessParameterSet, de.jstacs.utils.ProgressUpdater, de.jstacs.data.Sample...)`

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
`ClassifierAssessmentAssessParameterSet()` Constructs a new `ClassifierAssessmentAssessParameterSet` with empty parameter values.
`ClassifierAssessmentAssessParameterSet(int elementLength, boolean exceptionIfMPNotComputable)` Constructs a new `ClassifierAssessmentAssessParameterSet` with given parameter values.
`ClassifierAssessmentAssessParameterSet(StringBuffer representation)` The standard constructor for the interface `Storable`.

Method Summary
`Collection<Result>` | `getAnnotation()` Returns a `Collection` of parameters containing informations about this `ClassifierAssessmentAssessParameterSet`.
`int` | `getElementLength()` Returns the length of elements (sequences) defined by this `ClassifierAssessmentAssessParameterSet`.
`boolean` | `getExceptionIfMPNotComputable()` Returns the flag defined by this `ClassifierAssessmentAssessParameterSet`.
`protected void` | `initializeMyParametersArrayList()` Initializes the list of `Parameter`s in this `ClassifierAssessmentAssessParameterSet`.
`protected void` | `loadParameters()` Loads the parameters for this `ParameterSet`.

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

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

Constructor Detail

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet()
                                           throws UnsupportedOperationException

  Constructs a new `ClassifierAssessmentAssessParameterSet` with empty parameter values.

  Throws:
    `UnsupportedOperationException` - if the `ClassifierAssessmentAssessParameterSet` could not be constructed or the parameters could not be loaded
  See Also:
    `ParameterSet.ParameterSet()`

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet(StringBuffer representation)
                                           throws NonParsableException

  The standard constructor for the interface `Storable`. Constructs a `ClassifierAssessmentAssessParameterSet` out of its XML representation.

  Parameters:
    `representation` - the XML representation as `StringBuffer`
  Throws:
    `NonParsableException` - if the `ClassifierAssessmentAssessParameterSet` could not be reconstructed out of the XML representation (the `StringBuffer` `representation` could not be parsed)
  See Also:
    `ParameterSet.ParameterSet(StringBuffer)`, `Storable`

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet(int elementLength,
                                                  boolean exceptionIfMPNotComputable)
                                           throws SimpleParameter.IllegalValueException

  Constructs a new `ClassifierAssessmentAssessParameterSet` with given parameter values.

  Parameters:
    `elementLength` - defines the length of elements (sequences) the classifiers to be assessed are able to classify
    `exceptionIfMPNotComputable` - A `ClassifierAssessmentAssessParameterSet` is used in combination with a `MeasureParameters`-object to call `assess( ... )`-methods of `ClassifierAssessment`s. If `exceptionIfMPNotComputable==true` an `Exception` is thrown if a user selected measure parameters that could not be computed.
  Throws:
    `SimpleParameter.IllegalValueException` - is thrown in case of out-of-range or invalid given parameters
  See Also:
    `ParameterSet.ParameterSet()`

Method Detail

### initializeMyParametersArrayList

    protected void initializeMyParametersArrayList()

  Initializes the list of `Parameter`s in this `ClassifierAssessmentAssessParameterSet`.

  See Also:
    `ParameterSet.initParameterList(int initCapacity)`

### 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` - if the parameters could not be loaded
  See Also:
    `Parameter`, `ParameterSet.parameters`, `ParameterSet.initParameterList()`, `ParameterSet.initParameterList(int)`

### getElementLength

    public int getElementLength()

  Returns the length of elements (sequences) defined by this `ClassifierAssessmentAssessParameterSet`.

  Returns:
    the element length defined by this `ClassifierAssessmentAssessParameterSet`

### getExceptionIfMPNotComputable

    public boolean getExceptionIfMPNotComputable()

  Returns the flag defined by this `ClassifierAssessmentAssessParameterSet`.

  Returns:
    the flag defined by this `ClassifierAssessmentAssessParameterSet` (`true` : an exception is thrown if a user selected measure parameters that could not be computed, `false`: no exception is thrown)

### getAnnotation

    public Collection<Result> getAnnotation()

  Returns a `Collection` of parameters containing informations about this `ClassifierAssessmentAssessParameterSet`.

  Returns:
    a `Collection` of parameters containing informations about this `ClassifierAssessmentAssessParameterSet`

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