BinarizationResult-class {Binarize} R Documentation

Class "BinarizationResult"

Description

This is the base class for objects that store the results of a binarization algorithm. It defines the slots and methods that the results of all algorithms share.

Objects of this class

Objects of this class shouldn't be created directly. They are created implicitly by a call to one of the binarizeation algorithms.

Slots

originalMeasurements:

A numeric vector storing the input measurements.

binarizedMeasurements:

An integer vector of binarized values (0 or 1) corresponding to the original measurements.

threshold:

The threshold that separates 0 and 1.

method:

A string describing the binarization method that yielded the result.

p.value:

The p-value obtained by a test for validity of the binarization (e.g. BASC bootstrap test, Hartigan's dip test for k-means binarization, scan statistic p-value for best window. If no test was performed, this is NA.

Methods

plot

signature(x = "BinarizationResult"): Plot the binarization and the threshold.

print

signature(x = "BinarizationResult"): Print a summary of the binarization.

show

signature(object = "BinarizationResult"): ...

binarize.BASC, binarize.kMeans, BASCResult,