Package org.dkpro.statistics.agreement.coding

Class WeightedAgreement

java.lang.Object

org.dkpro.statistics.agreement.DisagreementMeasure

org.dkpro.statistics.agreement.coding.WeightedAgreement

All Implemented Interfaces:

IAgreementMeasure, IWeightedAgreement

Direct Known Subclasses:

KrippendorffAlphaAgreement, WeightedKappaAgreement

public abstract class WeightedAgreement
extends DisagreementMeasure
implements IWeightedAgreement

Abstract base class for weighted measures. In most cases, weighted measures are defined as disagreement functions. They are characterized by a distance function that is used to score the similarity between two categories.

Author:

Christian M. Meyer

See Also:

IDistanceFunction, DisagreementMeasure

Field Summary

Fields

Modifier and Type	Field	Description
protected IDistanceFunction	distanceFunction
protected ICodingAnnotationStudy	study

Constructor Summary

Constructors

Constructor	Description
WeightedAgreement(ICodingAnnotationStudy study)	Initializes the instance for the given annotation study.

Method Summary

Modifier and Type	Method	Description
protected void	ensureDistanceFunction()
IDistanceFunction	getDistanceFunction()	Returns the distance function that is used to measure the distance between two annotation categories.
void	setDistanceFunction(IDistanceFunction distanceFunction)	Uses the given distance function for upcoming calculations of the inter-rater agreement.

Methods inherited from class org.dkpro.statistics.agreement.DisagreementMeasure

calculateAgreement, calculateExpectedDisagreement, calculateObservedDisagreement

Methods inherited from class java.lang.Object

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

Field Details

distanceFunction

protected IDistanceFunction distanceFunction

study

protected ICodingAnnotationStudy study

Constructor Details

WeightedAgreement

public WeightedAgreement(ICodingAnnotationStudy study)

Initializes the instance for the given annotation study. The study should never be null.

Method Details

getDistanceFunction

public IDistanceFunction getDistanceFunction()

Description copied from interface: IWeightedAgreement

Returns the distance function that is used to measure the distance between two annotation categories.

Specified by:

getDistanceFunction in interface IWeightedAgreement

setDistanceFunction

public void setDistanceFunction(IDistanceFunction distanceFunction)

Uses the given distance function for upcoming calculations of the inter-rater agreement.

ensureDistanceFunction

protected void ensureDistanceFunction()