bham.leakiest

Class CSVFile

java.lang.Object

bham.leakiest.CSVFile

public class CSVFile
extends java.lang.Object

This class represents an RFC 4180-compliant CSV file containing information about the leakage estimations generated by processing observations.

The columns of the CSV file are, in order:

1. the number of observations processed so far;
2. the uncorrected leakage estimation;
3. the corrected leakage estimation;
4. the lower bound on the confidence interval for the leakage estimate;
5. the upper bound on the confidence interval for the leakage estimate;
6. the upper bound on the value of corrected leakage that is consistent with zero leakage.

Not all of these statistics can be calculated for every leakage measure. Statistics that are omitted are represented with the empty string in their respective column.

Version:

1.4.3

Author:

Tom Chothia, Yusuke Kawamoto, Chris Novakovic

Constructor Summary

Constructors

Constructor and Description
CSVFile(java.io.File out) Creates a new, empty CSV file at the path specified by out.

Method Summary

Modifier and Type	Method and Description
void	addLeakageData(int observations, double uncorrectedLeakage, double correctedLeakage, double confidenceIntervalLowerBound, double confidenceIntervalUpperBound, double upperBoundForZeroLeakage) Adds a new line of information leakage statistics to the CSV file, given all of the statistics that need to be written.
void	addLeakageData(Observations observations, int leakageType) Adds a new line of information leakage statistics to the CSV file, given an Observations object.
void	close() Closes the CSV file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVFile

public CSVFile(java.io.File out)
        throws java.io.FileNotFoundException

Creates a new, empty CSV file at the path specified by out. If a file already exists at that path, it will be overwritten.

Parameters:

out - The path that the CSV file should be written to.

Throws:

java.io.FileNotFoundException - If out cannot be written to.

Method Detail

addLeakageData

public void addLeakageData(int observations,
                           double uncorrectedLeakage,
                           double correctedLeakage,
                           double confidenceIntervalLowerBound,
                           double confidenceIntervalUpperBound,
                           double upperBoundForZeroLeakage)

Adds a new line of information leakage statistics to the CSV file, given all of the statistics that need to be written. Double.NaN values indicate that the statistic cannot be calculated, and are not written to the CSV file.

Parameters:

observations - The number of observations processed so far.

uncorrectedLeakage - The raw, uncorrected value for leakage.

correctedLeakage - The value of leakage after the correction has been applied.

confidenceInterval - The confidence interval for the corrected leakage estimation.

upperBoundForZeroLeakage - The upper bound for the value of corrected leakage that is consistent with zero leakage.

addLeakageData

public void addLeakageData(Observations observations,
                           int leakageType)

Adds a new line of information leakage statistics to the CSV file, given an Observations object. All statistics are calculated based on the data stored in this Observations object.

Parameters:

observations - The Observations object to use to calculate leakage statistics.

leakageType - The leakage measurement to calculate. Permitted values are:

• 1 — mutual information;
• 2 — channel capacity;
• 3 — min-entropy;
• 4 — min-capacity.

close

public void close()

Closes the CSV file. No more statistics may be written to this CSV file after this method has been called.