PredictionQuality (bio.seq API)

java.lang.Object
- ua.kiev.icyb.bio.PredictionQuality

All Implemented Interfaces:

Serializable, Representable
```
public class PredictionQuality
extends Object
implements Serializable, Representable
```
Класс, представляющий различные критерии качества распознавания скрытых последовательностей. Большинство критериев взяты из теории обработки сигналов.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`PredictionQuality(PredictionQuality... samples)` Создает контейнер для метрик качества, усредняющий показатели качества для набора других контейнеров.
`PredictionQuality(SequenceSet reference)` Создает контейнер для метрик качества на основе набора прецедентов.
`PredictionQuality(SequenceSet reference, SequenceSet est)` Создает контейнер для метрик качества на основе набора прецедентов и результата работы алгоритма распознавания.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSequence(byte[] refSeq, byte[] estSeq)` Добавляет результат распознавания наблюдаемой последовательности.
`double`	`regionSens(int state)` Метрика качества — фрагментная чувствительность.
`double`	`regionSpec(int state)` Метрика качества — фрагментная специфичность.
`String`	`repr()` Возвращает более или менее детализированное текстовое представление объекта.
`String`	`repr(int state)` Возвращает текстовое представление точности распознавания по определенному классу скрытых состояний.
`double`	`symbolACP(int state)` Метрика качества — средняя условная вероятность (англ.
`double`	`symbolCC(int state)` Метрика качества — коэффициент корреляции.
`double`	`symbolPrecision()` Метрика качества — символьная точность алгоритма распознавания.
`double`	`symbolSens(int state)` Метрика качества — симольная чувствительность для конкретного типа скрытых состояний.
`double`	`symbolSpec(int state)` Метрика качества — симольная специфичность для конкретного типа скрытых состояний.

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

- Constructor Detail
  - PredictionQuality
```
public PredictionQuality(SequenceSet reference,
                 SequenceSet est)
```
    Создает контейнер для метрик качества на основе набора прецедентов и результата работы алгоритма распознавания.
    
    Parameters:
    reference - референсный набор прецедентов, для которых известны как наблюдаемые, так и скрытые цепочки состояний
    est - набор строк состояний, полученных в результате работы алгоритма распознавания
  - PredictionQuality
```
public PredictionQuality(SequenceSet reference)
```
    Создает контейнер для метрик качества на основе набора прецедентов. Последовательности скрытых состояний, получаемые алгоритмом распознавания, добавляются позже.
    
    Parameters:
    reference - референсный набор прецедентов, для которых известны как наблюдаемые, так и скрытые цепочки состояний
  - PredictionQuality
```
public PredictionQuality(PredictionQuality... samples)
```
    Создает контейнер для метрик качества, усредняющий показатели качества для набора других контейнеров.
    
    Parameters:
    samples - контейнеры метрик качества, по которым производится усреднение
- Method Detail
  - addSequence
```
public void addSequence(byte[] refSeq,
               byte[] estSeq)
```
    Добавляет результат распознавания наблюдаемой последовательности.
    
    Parameters:
    refSeq - действительная последовательность скрытых состояний
    estSeq - определенная алгоритмом последовательность скрытых состояний, или null в случае отказа от распознавания
  - symbolSpec
```
public double symbolSpec(int state)
```
    Метрика качества — симольная специфичность для конкретного типа скрытых состояний. Определяется как доля правильно распознанных алгоритмом состояний этого типа к общему количеству символов, которые алгоритм относит к этому типу.
    Значения метрики качества находятся в диапазоне [0, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    символьная специфичность по заданному состоянию
  - symbolSens
```
public double symbolSens(int state)
```
    Метрика качества — симольная чувствительность для конкретного типа скрытых состояний. Определяется как доля правильно распознанных алгоритмом состояний этого типа к общему количеству символов этого типа в референсной выборке.
    Значения метрики качества находятся в диапазоне [0, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    символьная чувствительность по заданному состоянию
  - symbolACP
```
public double symbolACP(int state)
```
    Метрика качества — средняя условная вероятность (англ. average conditional probability). Является средним арифметическим для символьной чувствительности и специфичности для некоторого типа скрытых состояний, а также еще двух метрик — чувствительности и специфичности для всех остальных скрытых состояний.
    Значения метрики качества находятся в диапазоне [0, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    средняя условная вероятность по заданному состоянию
  - symbolCC
```
public double symbolCC(int state)
```
    Метрика качества — коэффициент корреляции. Равен корреляции между двумя событиями: (1) появлением в строке скрытых состояний опреленного состояния и (2) отнесением алгоритмом распознавания скрытого состояния к этому классу.
    Значения метрики качества находятся в диапазоне [-1, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    значение коэффициента корреляции по заданному состоянию
  - regionSpec
```
public double regionSpec(int state)
```
    Метрика качества — фрагментная специфичность. Определяется как доля корректно распознанных алгоритмом фрагментов определенного типа (участки строки скрытых состояний, которые состоят из состояний одного типа и которые нельзя расширить путем добавления соседних состояний) среди всех фрагментов этого типа, выделенных алгоритмом.
    Значения метрики качества находятся в диапазоне [0, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    значение фрагментной специфичности по заданному состоянию
  - regionSens
```
public double regionSens(int state)
```
    Метрика качества — фрагментная чувствительность. Определяется как доля корректно распознанных алгоритмом фрагментов определенного типа (участки строки скрытых состояний, которые состоят из состояний одного типа и которые нельзя расширить путем добавления соседних состояний) среди всех фрагментов этого типа в референсной выборке.
    Значения метрики качества находятся в диапазоне [0, 1]. Метрика, близкая к единице, свидетельствует о хорошем качестве алгоритма распознавания.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    значение фрагментной чувствительности по заданному состоянию
  - symbolPrecision
```
public double symbolPrecision()
```
    Метрика качества — символьная точность алгоритма распознавания. Равна доле корректно распознанных алгоритмом скрытых состояний к общей длине всех строк из референсной выборки.
    
    Returns:
    символьная точность алгоритма распознавания
  - repr
```
public String repr(int state)
```
    Возвращает текстовое представление точности распознавания по определенному классу скрытых состояний.
    
    Parameters:
    state - индекс (с отсчетом от нуля) скрытого состояния в алфавите скрытых состояний
    
    Returns:
    текстовое представление основных метрик точности
  - repr
```
public String repr()
```
    Description copied from interface: Representable
    
    Возвращает более или менее детализированное текстовое представление объекта. В отличие от метода Object.toString(), подразумевается, что представление занимает одну или более полных строк.
    
    Specified by:
    
    repr in interface Representable
    
    Returns:
    текстовое представление объекта

Class PredictionQuality

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PredictionQuality

PredictionQuality

PredictionQuality

Method Detail

addSequence

symbolSpec

symbolSens

symbolACP

symbolCC

regionSpec

regionSens

symbolPrecision

repr

repr