Index (The OpenIMAJ Core Experiment Library 1.3.5 API)

A B C D E F G I K L M N O P Q R S T U V W

A

accumulate(String, NanoTimer) - Static method in class org.openimaj.experiment.agent.TimeTracker: Accumulate the given duration into the statistics with the given identifier
accumulate(String, Timer) - Static method in class org.openimaj.experiment.agent.TimeTracker: Accumulate the given duration into the statistics with the given identifier
accumulate(String, long) - Static method in class org.openimaj.experiment.agent.TimeTracker: Accumulate the given duration into the statistics with the given identifier
actual - Variable in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
add(CMResult<CLASS>) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAggregator
add(List<TargetEstimatePair<CLASS, CLASS>>, Set<CLASS>, Set<CLASS>) - Method in enum org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser.Strategy
add(RESULT) - Method in interface org.openimaj.experiment.evaluation.ResultAggregator: Add a new result to this aggregation
addMissing(Map<String, SummaryStatistics>) - Static method in class org.openimaj.experiment.agent.TimeTracker: Add any times from the given map that are not present in the internal map to the internal map.
adjRandInd - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
adjRandInd - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
adjRandInd - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
AdjustedRandomIndexAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: The adjsuted random index as described by: http://faculty.washington.edu/kayee/pca/supp.pdf
AdjustedRandomIndexAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
AdjustedRandomIndexClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: Create an AdjustedRandomIndexAnalysis instance
AdjustedRandomIndexClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexClusterAnalyser
agentmain(String, Instrumentation) - Static method in class org.openimaj.experiment.agent.ExperimentAgent: JVM hook to dynamically load javaagent at runtime.
AggregatedCMResult<CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: Aggregated confusion matrix results
AggregatedCMResult() - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult: Default constructor
AggregatedCMResult(List<CMResult<CLASS>>) - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult: Construct with a list of results
AggregatedCMResult.AggregateStatistics - Class in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: Aggregated accuracy and error rate.
AggregateStatistics() - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult.AggregateStatistics
analyse(Map<OBJECT, ClassificationResult<CLASS>>, Map<OBJECT, Set<CLASS>>) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser
analyse(Map<OBJECT, ClassificationResult<CLASS>>, Map<OBJECT, Set<CLASS>>) - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCAnalyser
analyse(Map<OBJECT, ClassificationResult<CLASS>>, Map<OBJECT, Set<CLASS>>) - Method in interface org.openimaj.experiment.evaluation.classification.ClassificationAnalyser: Analyse the performance of the predicted results against the actual ground-truth results.
analyse(Map<OBJECT, ClassificationResult<CLASS>>) - Method in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexClusterAnalyser
analyse(int[][], int[][]) - Method in interface org.openimaj.experiment.evaluation.cluster.analyser.ClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEClusterAnalyser
analyse(int[][], int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEClusterAnalyser
analyse(int[][]) - Method in class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
analyse(T) - Method in interface org.openimaj.experiment.evaluation.Evaluator: Analyse the raw data produced by a call to Evaluator.evaluate() and return the analysed data.
analyse(Map<QUERY, List<DOCUMENT>>, Map<QUERY, Set<DOCUMENT>>) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalAnalyser
analyse(Map<QUERY, List<DOCUMENT>>, Map<QUERY, Set<DOCUMENT>>) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtN
analyse(Map<QUERY, List<DOCUMENT>>, Map<QUERY, Set<DOCUMENT>>) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECEvalAnalyser
analyse(Map<QUERY, List<DOCUMENT>>, Map<QUERY, Set<DOCUMENT>>) - Method in interface org.openimaj.experiment.evaluation.retrieval.RetrievalAnalyser: Analyse ranked results from a RetrievalEngine against a ground-truth set of relevant results and produce an AnalysisResult which can be read by a human.
analyse(Map<QUERY, List<DOCUMENT>>) - Method in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator
analyser - Variable in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
analyser - Variable in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator
AnalysisResult - Interface in org.openimaj.experiment.evaluation: The result of the analysis of raw data.
analysisResults(DecisionAnalysis) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionClusterAnalyser: Given a DecisionAnalysis, construct an analysis
analysisResults(DecisionAnalysis) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreClusterAnalyser
analysisResults(DecisionAnalysis) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexClusterAnalyser
asList(Dataset<INSTANCE>) - Static method in class org.openimaj.experiment.dataset.util.DatasetAdaptors: Create a List view of the given dataset.

B

BasicClassificationResult<CLASS> - Class in org.openimaj.experiment.evaluation.classification: A basic implementation of a ClassificationResult that internally maintains a map of classes to confidences.
BasicClassificationResult() - Constructor for class org.openimaj.experiment.evaluation.classification.BasicClassificationResult: Construct with a default threshold of 0.
BasicClassificationResult(double) - Constructor for class org.openimaj.experiment.evaluation.classification.BasicClassificationResult: Construct with the given threshold.

C

calculate(Map<K, A>, Map<K, A>) - Static method in class org.openimaj.experiment.evaluation.agreement.CohensKappaInterraterAgreement: The input should be a Map for each rater where the keys represent all the subjects that were rated by the raters and the values represent the annotations given by the raters.
calculate(List<Map<K, A>>) - Static method in class org.openimaj.experiment.evaluation.agreement.FleissInterraterAgreement: Calculate Fleiss interrater agreement
calculate(Map<K, A>, Map<K, A>) - Static method in class org.openimaj.experiment.evaluation.agreement.PercentageInterraterAgreement: The input should be a Map for each rater where the keys represent all the subjects that were rated by the raters and the values represent the annotations given by the raters.
calculateBasicMajorityVote(List<A>) - Static method in class org.openimaj.experiment.evaluation.agreement.MajorityVoting: Returns the basic majority vote or null if there is no majority within the given list of annotations.
calculateBasicMajorityVote(Map<String, List<A>>) - Static method in class org.openimaj.experiment.evaluation.agreement.MajorityVoting: Calculated the majority vote for a set of subjects, where each subject has a set of answers.
ClassificationAnalyser<RESULT extends AnalysisResult,CLASS,OBJECT> - Interface in org.openimaj.experiment.evaluation.classification: A ClassificationAnalyser is used to analyse the raw results from a Classifier in the context of a ClassificationEvaluator and to produce an AnalysisResult describing the performance of the ClassificationEvaluator.
ClassificationEvaluator<RESULT extends AnalysisResult,CLASS,OBJECT> - Class in org.openimaj.experiment.evaluation.classification: Implementation of an Evaluator for the evaluation of classification experiments.
ClassificationEvaluator(Classifier<CLASS, OBJECT>, Collection<OBJECT>, Map<OBJECT, Set<CLASS>>, ClassificationAnalyser<RESULT, CLASS, OBJECT>) - Constructor for class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator: Construct a new ClassificationEvaluator with the given classifier, set of objects to classify, ground truth ("actual") data and an ClassificationAnalyser.
ClassificationEvaluator(Classifier<CLASS, OBJECT>, Map<OBJECT, Set<CLASS>>, ClassificationAnalyser<RESULT, CLASS, OBJECT>) - Constructor for class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator: Construct a new ClassificationEvaluator with the given classifier, ground truth ("actual") data and an ClassificationAnalyser.
ClassificationEvaluator(Classifier<CLASS, OBJECT>, GroupedDataset<CLASS, ? extends ListDataset<OBJECT>, OBJECT>, ClassificationAnalyser<RESULT, CLASS, OBJECT>) - Constructor for class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator: Construct a new ClassificationEvaluator with the given classifier, ground truth ("actual") data and an ClassificationAnalyser.
ClassificationEvaluator(Map<OBJECT, ClassificationResult<CLASS>>, Map<OBJECT, Set<CLASS>>, ClassificationAnalyser<RESULT, CLASS, OBJECT>) - Constructor for class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator: Construct a new ClassificationEvaluator with the given pre-classified results, the ground truth ("actual") data and an ClassificationAnalyser.
ClassificationResult<CLASS> - Interface in org.openimaj.experiment.evaluation.classification: The result of a Classifier.
classifier - Variable in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
Classifier<CLASS,OBJECT> - Interface in org.openimaj.experiment.evaluation.classification: Interface describing a classifier.
classify(OBJECT) - Method in interface org.openimaj.experiment.evaluation.classification.Classifier: Classify an object.
ClusterAnalyser<T extends AnalysisResult> - Interface in org.openimaj.experiment.evaluation.cluster.analyser
ClusterAnalyserUtils - Class in org.openimaj.experiment.evaluation.cluster.analyser: Tools for ClusterAnalyser instances
ClusterAnalyserUtils() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.ClusterAnalyserUtils
Clusterer<DATA> - Interface in org.openimaj.experiment.evaluation.cluster.processor: Something which wraps the functionality of producing clusters
ClusterEvalDataset - Class in org.openimaj.experiment.dataset.cluster: Reads datasets of items and cluster labels from the clustereval tool: http://chris.de-vries.id.au/2013/06/clustereval-10-release.html The general format of clustereval is: item cluster_label*
ClusterEvalDataset(String) - Constructor for class org.openimaj.experiment.dataset.cluster.ClusterEvalDataset: Read from this file location
ClusterEvalDataset(File) - Constructor for class org.openimaj.experiment.dataset.cluster.ClusterEvalDataset: Load this file as a dataset
ClusterEvalDataset(InputStream) - Constructor for class org.openimaj.experiment.dataset.cluster.ClusterEvalDataset: Read the clusters from this stream
ClusterEvaluator<D,T extends AnalysisResult> - Class in org.openimaj.experiment.evaluation.cluster
ClusterEvaluator(Clusterer<D>, D, int[][], ClusterAnalyser<T>) - Constructor for class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
ClusterEvaluator(Clusterer<D>, D, Map<A, ? extends List<B>>, ClusterAnalyser<T>) - Constructor for class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
ClusterEvaluator(Clusterer<D>, D, Function<B, Integer>, Map<A, ? extends List<B>>, ClusterAnalyser<T>) - Constructor for class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
ClusterEvaluator(Clusterer<D>, Map<A, ? extends List<B>>, Function<List<B>, D>, ClusterAnalyser<T>) - Constructor for class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
ClusterStatsAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: Analysers extracts stats of the correct and estimated clusterings
ClusterStatsAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalyser
ClusterStatsAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Counts some overall statistics of cluster evaluation such as min, max and average cluster length
ClusterStatsAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
CMAggregator<CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: A ResultAggregator for collecting multiple CMResults and producing a single unified report.
CMAggregator() - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAggregator
CMAnalyser<OBJECT,CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: A ClassificationAnalyser that creates Confusion Matrices.
CMAnalyser(CMAnalyser.Strategy) - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser: Construct with the given strategy for building the confusion matrix
CMAnalyser.Strategy - Enum in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: Strategies for building confusion matrices
CMResult<CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix: Results of a confusion matrix analysis using the CMAnalyser.
CMResult(ConfusionMatrix<CLASS>) - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult: Construct with a ConfusionMatrix.
CohensKappaInterraterAgreement - Class in org.openimaj.experiment.evaluation.agreement: Calculates the interrater agreement for a given dataset between two (and only two) raters.
CohensKappaInterraterAgreement() - Constructor for class org.openimaj.experiment.evaluation.agreement.CohensKappaInterraterAgreement
computeStatistics() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult: Compute the current aggregate statistics of the accumulated results.
convertRelevant(Map<Q, Set<D>>) - Static method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalAnalyser
convertResults(Map<Q, List<D>>) - Static method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalAnalyser
correct - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis: Stats regarding the correct or baseline clusters
correct - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: The correct clustering
createCrossValidationData(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, int, int, int) - Static method in class org.openimaj.experiment.dataset.split.GroupedRandomSplitter: Create a CrossValidationIterable from the dataset.
createIterable(DATASET) - Method in interface org.openimaj.experiment.validation.cross.CrossValidator: Create the iterable from the dataset.
createIterable(GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.validation.cross.GroupedKFold
createIterable(GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.validation.cross.GroupedLeaveOneOut
createIterable(ListDataset<INSTANCE>) - Method in class org.openimaj.experiment.validation.cross.KFold
createIterable(ListDataset<INSTANCE>) - Method in class org.openimaj.experiment.validation.cross.LeaveOneOut
createIterable(GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.validation.cross.StratifiedGroupedKFold
CrossValidationIterable<DATASET extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.validation.cross: Interface for cross-validation schemes.
CrossValidator<DATASET extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.validation.cross: Interface for cross-validation schemes.

D

DatasetAdaptors - Class in org.openimaj.experiment.dataset.util: Helper methods to provide different types of view on a dataset.
DatasetAdaptors() - Constructor for class org.openimaj.experiment.dataset.util.DatasetAdaptors
DatasetDescription - Annotation Type in org.openimaj.experiment.annotations: An annotation for marking up a specific org.openimaj.data.Dataset subclass with metadata about the dataset.
decision - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis: The DecisionAnalysis instance
decision - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis: The DecisionAnalysis instance
DecisionAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Counting the number of true positives, true negatives, flase postitives and false negatives one can produce various cluster quality metrics including the fscore and randindex
DecisionAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
DecisionClusterAnalyser<T extends AnalysisResult> - Class in org.openimaj.experiment.evaluation.cluster.analyser: Gather the true positives, true negatives, false positives, false negatives for a DecisionAnalysis instance
DecisionClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.DecisionClusterAnalyser
DefaultValidationData<DATASET extends org.openimaj.data.dataset.Dataset<?>> - Class in org.openimaj.experiment.validation: Data for performing validation.
DefaultValidationData() - Constructor for class org.openimaj.experiment.validation.DefaultValidationData
DefaultValidationData(DATASET, DATASET) - Constructor for class org.openimaj.experiment.validation.DefaultValidationData: Construct with the training and validation datasets.
DependentVariable - Annotation Type in org.openimaj.experiment.annotations: Annotation for marking dependent variables within a RunnableExperiment instance.

E

engine - Variable in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator
estimated - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis: Stats regarding the estimated clusters
estimated - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: The estimation
eval - Variable in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
evaluate() - Method in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
evaluate() - Method in class org.openimaj.experiment.evaluation.cluster.ClusterEvaluator
evaluate() - Method in interface org.openimaj.experiment.evaluation.Evaluator: Run, or evaluate the system, returning the raw data.
evaluate() - Method in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator
evaluate(DATASET, DATASET) - Method in interface org.openimaj.experiment.validation.ValidationOperation: Perform the operations required for one round of validation using the provided training and validation datasets.
Evaluator<T,Q extends AnalysisResult> - Interface in org.openimaj.experiment.evaluation: Evaluators are used to perform evaluations.
Experiment - Annotation Type in org.openimaj.experiment.annotations: Annotation for describing an instance of a RunnableExperiment.
ExperimentAgent - Class in org.openimaj.experiment.agent: Java instrumentation agent for instrumenting experiments.
ExperimentAgent() - Constructor for class org.openimaj.experiment.agent.ExperimentAgent
ExperimentContext - Class in org.openimaj.experiment: The recorded context of an experiment.
ExperimentContext(RunnableExperiment) - Constructor for class org.openimaj.experiment.ExperimentContext
ExperimentContext.Variable - Class in org.openimaj.experiment: Representation of a recorded variable in an experiment (i.e.
ExperimentRunner - Class in org.openimaj.experiment: Support for running RunnableExperiments and automatically creating and populating the context of the experiments.

F

findMaxClassCount(int[], Map<Integer, Integer>) - Static method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterAnalyserUtils
finish(ExperimentContext) - Method in interface org.openimaj.experiment.RunnableExperiment: Finalise the experiment, possibly writing the results, cleaning up, etc.
flattenListGroupedDataset(GroupedDataset<ANN, ? extends ListDataset<List<INSTANCE>>, ? extends List<INSTANCE>>) - Static method in class org.openimaj.experiment.dataset.util.DatasetAdaptors: if you have a grouped dataset where the groups contains lists of feature objects (i.e.
FleissInterraterAgreement - Class in org.openimaj.experiment.evaluation.agreement: Calculates Fleiss inter-rater agreement - a version of Cohen's kappa that works with multiple raters.
FleissInterraterAgreement() - Constructor for class org.openimaj.experiment.evaluation.agreement.FleissInterraterAgreement
FN - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis: The total number of pairs in different clusters which belong to the same class
format(Map<String, SummaryStatistics>) - Static method in class org.openimaj.experiment.agent.TimeTracker: Pretty-print a map of times
format(SummaryStatistics) - Static method in class org.openimaj.experiment.agent.TimeTracker: Pretty print a time
FP - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis: The total number of pairs in a cluster which do not belong to the same class
fscore(double) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
fscore - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis: The FScoreAnalysis instance
fscore - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: F-Score
fscore - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
FScoreAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Uses a decision analysis to produce the random index result
FScoreAnalysis(DecisionAnalysis) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
FScoreClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser
FScoreClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.FScoreClusterAnalyser
FullMEAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Sina Samangooei (ss@ecs.soton.ac.uk)
FullMEAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
FullMEClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: A set of measures used to evaulate clustering.
FullMEClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.FullMEClusterAnalyser

G

getAggregatedResult() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAggregator
getAggregatedResult() - Method in interface org.openimaj.experiment.evaluation.ResultAggregator: Get the aggregated result
getBibliography() - Method in class org.openimaj.experiment.ExperimentContext: Get the bibliography for the experiment.
getConfidence(CLASS) - Method in class org.openimaj.experiment.evaluation.classification.BasicClassificationResult
getConfidence(CLASS) - Method in interface org.openimaj.experiment.evaluation.classification.ClassificationResult: Get the confidence associated with the given class.
getDecisionAnalysis() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
getDecisionAnalysis() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
getDependentVariables() - Method in class org.openimaj.experiment.ExperimentContext: Get the dependent variables of the experiment and their values at the time this method is called.
getDetailReport(String, String) - Method in interface org.openimaj.experiment.evaluation.AnalysisResult: Get a JasperPrint detailing the result.
getDetailReport() - Method in interface org.openimaj.experiment.evaluation.AnalysisResult: Get a String detailing the result.
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
getDetailReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult
getDetailReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult
getDetailReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult
getExpected() - Method in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator: Get the expected classes for each instance
getGroupedDatasetSubset(GroupedDataset<ANN, DATASET, INSTANCE>, ANN...) - Static method in class org.openimaj.experiment.dataset.util.DatasetAdaptors: Takes a grouped dataset and returns a new dataset that contains only those groups specified.
getIndependentVariables() - Method in class org.openimaj.experiment.ExperimentContext: Get the independent variables of the experiment and their values at the time this method is called.
getInterpolatedPRData() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getMatrix() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult: Get the internal ConfusionMatrix.
getPredictedClasses() - Method in class org.openimaj.experiment.evaluation.classification.BasicClassificationResult
getPredictedClasses() - Method in interface org.openimaj.experiment.evaluation.classification.ClassificationResult: Get the set of classes predicted by this result.
getRank() - Method in interface org.openimaj.experiment.evaluation.retrieval.Ranked
getRegroupedDataset(GroupedDataset<ANN, DATASET, INSTANCE>, Map<ANN, ANN[]>) - Static method in class org.openimaj.experiment.dataset.util.DatasetAdaptors: Takes a grouped dataset and returns a new dataset with the groups re-shuffled as specified in the regrouping criteria.
getROCData() - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
getScore() - Method in interface org.openimaj.experiment.evaluation.retrieval.Scored
getSplit(int) - Method in interface org.openimaj.experiment.dataset.split.KWaySplitProvider: Get the ith split
getSummaryData() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getSummaryReport(String, String) - Method in interface org.openimaj.experiment.evaluation.AnalysisResult: Get a JasperPrint summarising the result.
getSummaryReport() - Method in interface org.openimaj.experiment.evaluation.AnalysisResult: Get a String summarising the result.
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult
getSummaryReport(String, String) - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult
getSummaryReport() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult
getTestDataset() - Method in class org.openimaj.experiment.dataset.split.GroupedRandomSplitter
getTestDataset() - Method in interface org.openimaj.experiment.dataset.split.TestSplitProvider
getTimes() - Static method in class org.openimaj.experiment.agent.TimeTracker: Get a copy of all the accumulated data
getTimingInfo() - Method in class org.openimaj.experiment.ExperimentContext: Get the timing information for the experiment.
getTrainingDataset() - Method in class org.openimaj.experiment.dataset.split.GroupedRandomSplitter
getTrainingDataset() - Method in interface org.openimaj.experiment.dataset.split.TrainSplitProvider
getTrainingDataset() - Method in class org.openimaj.experiment.validation.DefaultValidationData
getUnmodified() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
getValidationDataset() - Method in class org.openimaj.experiment.dataset.split.GroupedRandomSplitter
getValidationDataset() - Method in interface org.openimaj.experiment.dataset.split.ValidateSplitProvider
getValidationDataset() - Method in class org.openimaj.experiment.validation.DefaultValidationData
GroupedKFold<KEY,INSTANCE> - Class in org.openimaj.experiment.validation.cross: K-Fold Cross-Validation on grouped datasets.
GroupedKFold(int) - Constructor for class org.openimaj.experiment.validation.cross.GroupedKFold: Construct the GroupedKFold with the given number of folds.
GroupedLeaveOneOut<KEY,INSTANCE> - Class in org.openimaj.experiment.validation.cross: Leave-One-Out Cross Validation (LOOCV) with a GroupedDataset.
GroupedLeaveOneOut() - Constructor for class org.openimaj.experiment.validation.cross.GroupedLeaveOneOut
GroupedRandomisedPercentageHoldOut<KEY,INSTANCE> - Class in org.openimaj.experiment.validation: Hold-Out validation for grouped data that selects a percentage of the original data to use for training, and the remainder to use for validation.
GroupedRandomisedPercentageHoldOut(double, GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Constructor for class org.openimaj.experiment.validation.GroupedRandomisedPercentageHoldOut: Construct with the given dataset and percentage of training data (0..1).
GroupedRandomSplitter<KEY,INSTANCE> - Class in org.openimaj.experiment.dataset.split: This class splits a GroupedDataset into subsets for training, validation and testing.
GroupedRandomSplitter(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, int, int, int) - Constructor for class org.openimaj.experiment.dataset.split.GroupedRandomSplitter: Construct the dataset splitter with the given target instance sizes for each group of the training, validation and testing data.
GroupedUniformRandomisedSampler<KEY,INSTANCE> - Class in org.openimaj.experiment.dataset.sampling: A uniformly random sampling scheme for grouped datasets.
GroupedUniformRandomisedSampler(double) - Constructor for class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Construct a GroupedUniformRandomisedSampler with the given percentage of instances to select.
GroupedUniformRandomisedSampler(double, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Construct a GroupedUniformRandomisedSampler with the given percentage of instances to select, using with with-replacement or without-replacement sampling.
GroupedUniformRandomisedSampler(int) - Constructor for class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Construct a GroupedUniformRandomisedSampler with the given number of instances to select.
GroupedUniformRandomisedSampler(int, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Construct a GroupedUniformRandomisedSampler with the given number of instances to select, using with with-replacement or without-replacement sampling.
GroupSampler<KEY,INSTANCE> - Class in org.openimaj.experiment.dataset.sampling: Sampler that samples whole groups from a GroupedDataset.
GroupSampler(int, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.GroupSampler: Construct the sample to extract the given number of groups, either randomly or by taking them in the order provided by the iterator of groups.

I

identifier - Variable in class org.openimaj.experiment.ExperimentContext.Variable: The variables identifier taken from the annotation, or the variables name if the annotation has the default identifier.
IndependentVariable - Annotation Type in org.openimaj.experiment.annotations: Annotation for marking independent or controlled variables within a RunnableExperiment instance.
initialise() - Static method in class org.openimaj.experiment.agent.ExperimentAgent: Programmatic hook to dynamically load CitationAgent at runtime.
invert(int[][]) - Static method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterAnalyserUtils: Map index to cluster from cluster array
IREvalAnalyser<QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable> - Class in org.openimaj.experiment.evaluation.retrieval.analysers: An evaluator suitable for any kind of result document from the RetrievalEngine.
IREvalAnalyser() - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalAnalyser
IREvalResult - Class in org.openimaj.experiment.evaluation.retrieval.analysers: An AnalysisResult that is bascked by a SetRetrievalEvaluator to capture the results of a retrieval experiment.
IREvalResult(SetRetrievalEvaluator) - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult: Construct with the given SetRetrievalEvaluator result.
isLoaded() - Static method in class org.openimaj.experiment.agent.ExperimentAgent: Is the agent loaded?

K

KFold<INSTANCE> - Class in org.openimaj.experiment.validation.cross: K-Fold cross validation for ListDatasets.
KFold(int) - Constructor for class org.openimaj.experiment.validation.cross.KFold: Construct with the given number of folds.
KWaySplitProvider<OUT extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.dataset.split: An object that breaks a dataset into K splits.

L

LeaveOneOut<INSTANCE> - Class in org.openimaj.experiment.validation.cross: Leave-One-Out Cross Validation (LOOCV) with a ListDataset.
LeaveOneOut() - Constructor for class org.openimaj.experiment.validation.cross.LeaveOneOut
lock() - Method in class org.openimaj.experiment.ExperimentContext

M

MajorityVoting - Class in org.openimaj.experiment.evaluation.agreement: Majority voting.
MajorityVoting() - Constructor for class org.openimaj.experiment.evaluation.agreement.MajorityVoting
matrices - Variable in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult

N

N - Variable in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtN
NamedGroupSampler<KEY,INSTANCE> - Class in org.openimaj.experiment.dataset.sampling: Sampler that samples whole groups from a GroupedDataset.
NamedGroupSampler(Collection<KEY>) - Constructor for class org.openimaj.experiment.dataset.sampling.NamedGroupSampler: Construct the sample to extract the given groups.
nmi - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis: the NMIAnalysis instance
nmi - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis: The NMI
NMIAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Measures normalised mutual information.
NMIAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
NMIClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: The normalised mutual information of a cluster estimate
NMIClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.NMIClusterAnalyser
numberIterations() - Method in interface org.openimaj.experiment.validation.cross.CrossValidationIterable: Get the number of iterations that the Iterator returned by Iterable.iterator() will perform.

O

objects - Variable in class org.openimaj.experiment.evaluation.classification.ClassificationEvaluator
org.openimaj.experiment - package org.openimaj.experiment
org.openimaj.experiment.agent - package org.openimaj.experiment.agent
org.openimaj.experiment.annotations - package org.openimaj.experiment.annotations
org.openimaj.experiment.dataset.cluster - package org.openimaj.experiment.dataset.cluster
org.openimaj.experiment.dataset.sampling - package org.openimaj.experiment.dataset.sampling: The sampling package deals with sampling datasets to produce smaller datasets.
org.openimaj.experiment.dataset.split - package org.openimaj.experiment.dataset.split: Interfaces describing objects which can provide different splits of a dataset.
org.openimaj.experiment.dataset.util - package org.openimaj.experiment.dataset.util
org.openimaj.experiment.evaluation - package org.openimaj.experiment.evaluation
org.openimaj.experiment.evaluation.agreement - package org.openimaj.experiment.evaluation.agreement
org.openimaj.experiment.evaluation.classification - package org.openimaj.experiment.evaluation.classification
org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix - package org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix
org.openimaj.experiment.evaluation.classification.analysers.roc - package org.openimaj.experiment.evaluation.classification.analysers.roc
org.openimaj.experiment.evaluation.cluster - package org.openimaj.experiment.evaluation.cluster
org.openimaj.experiment.evaluation.cluster.analyser - package org.openimaj.experiment.evaluation.cluster.analyser: This package contains classes that can be used to evaluate clustering performance.
org.openimaj.experiment.evaluation.cluster.processor - package org.openimaj.experiment.evaluation.cluster.processor
org.openimaj.experiment.evaluation.retrieval - package org.openimaj.experiment.evaluation.retrieval
org.openimaj.experiment.evaluation.retrieval.analysers - package org.openimaj.experiment.evaluation.retrieval.analysers
org.openimaj.experiment.validation - package org.openimaj.experiment.validation
org.openimaj.experiment.validation.cross - package org.openimaj.experiment.validation.cross

P

PercentageInterraterAgreement - Class in org.openimaj.experiment.evaluation.agreement: Calculates the percentage interrater agreement for a given dataset between two (and only two) raters.
PercentageInterraterAgreement() - Constructor for class org.openimaj.experiment.evaluation.agreement.PercentageInterraterAgreement
perform() - Method in interface org.openimaj.experiment.RunnableExperiment: Perform the experiment
performClustering(DATA) - Method in interface org.openimaj.experiment.evaluation.cluster.processor.Clusterer
precision() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
PrecisionAtN<QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable> - Class in org.openimaj.experiment.evaluation.retrieval.analysers: RetrievalAnalyser that computes the precision after N documents have been retrieved (P@N).
PrecisionAtN(int) - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtN: Construct with the given N.
PrecisionAtNResult<QUERY> - Class in org.openimaj.experiment.evaluation.retrieval.analysers: AnalysisResult used with PrecisionAtN to hold the P@N precision after N documents have been retrieved.
PrecisionAtNResult(int) - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult: Construct with the given N.
premain(String, Instrumentation) - Static method in class org.openimaj.experiment.agent.ExperimentAgent: JVM hook to statically load the javaagent at startup.
purity - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis: A measure of how pure each cluster is.
purity - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis: the purity
purity - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: A measure of how pure each cluster is.
purity - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis: A measure of how pure each cluster is.
PurityAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: A measure of how pure each cluster is.
PurityAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
PurityClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: Create a measure of purity
PurityClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.PurityClusterAnalyser
put(CLASS, double) - Method in class org.openimaj.experiment.evaluation.classification.BasicClassificationResult: Add a class/confidence pair.

Q

queries - Variable in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator

R

randIndex() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
randIndex - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.FullMEAnalysis: The RandomIndexAnalysis instance
randIndex - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
randIndex() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
randIndex - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
RandomBaselineClusterAnalyser<ANNER extends ClusterAnalyser<ANNYS>,ANNYS extends RandomBaselineWrappable & AnalysisResult> - Class in org.openimaj.experiment.evaluation.cluster.analyser: Wraps the functionality of any ClusterAnalyser as corrected by a Random baseline.
RandomBaselineClusterAnalyser(ANNER) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalyser
RandomBaselineClusterAnalyser(ANNER, int) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalyser
RandomBaselineClusterAnalyser(ANNER, int, long) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalyser
RandomBaselineClusterAnalysis<T extends RandomBaselineWrappable & AnalysisResult> - Class in org.openimaj.experiment.evaluation.cluster.analyser: The result of a TestRandomBaselineClusterAnalyser which wraps the baseline result and result of an AnalysisResult
RandomBaselineClusterAnalysis(T, double) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
RandomBaselineSMEAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Results of applying a RandomBaselineSMEAnalysis to evaluate clustering.
RandomBaselineSMEAnalysis(int[][], int[][]) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: Construct with the correct assignments and estimated assignments.
RandomBaselineSMEClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: A set of measures used to evaluate clustering quality.
RandomBaselineSMEClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEClusterAnalyser: Default constructor
RandomBaselineWrappable - Interface in org.openimaj.experiment.evaluation.cluster.analyser: An AnalysisResult which can offer some score and thus be compared to a random baseline
RandomIndexAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Uses a decision analysis to produce the random index result
RandomIndexAnalysis(DecisionAnalysis) - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
RandomIndexClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser
RandomIndexClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexClusterAnalyser
RandomisedPercentageHoldOut<INSTANCE> - Class in org.openimaj.experiment.validation: Hold-Out validation that selects a percentage of the original data to use for training, and the remainder to use for validation.
RandomisedPercentageHoldOut(double, ListDataset<INSTANCE>) - Constructor for class org.openimaj.experiment.validation.RandomisedPercentageHoldOut: Construct with the given dataset and percentage of training data (0..1).
Ranked - Interface in org.openimaj.experiment.evaluation.retrieval: Interface for objects that have a ranked position.
recall() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
recomputeSubsets() - Method in class org.openimaj.experiment.dataset.split.GroupedRandomSplitter: Recompute the underlying splits of the training, validation and testing data by randomly picking new subsets of the input dataset given in the constructor.
relevant - Variable in class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator
reset() - Static method in class org.openimaj.experiment.agent.TimeTracker: Reset all the previously accumulated times, returning them.
ResultAggregator<RESULT,AGGREGATED extends AnalysisResult> - Interface in org.openimaj.experiment.evaluation: A ResultAggregator aggregates multiple results into a single AnalysisResult.
RetrievalAnalyser<RESULT extends AnalysisResult,QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable> - Interface in org.openimaj.experiment.evaluation.retrieval: A RetrievalAnalyser is used to analyse the raw search results from a RetrievalEngine in the context of a RetrievalEvaluator and to produce an AnalysisResult describing the performance of the RetrievalEngine.
RetrievalEngine<DOCUMENT extends org.openimaj.data.identity.Identifiable,QUERY> - Interface in org.openimaj.experiment.evaluation.retrieval: Interface describing a retrieval engine
RetrievalEvaluator<RESULT extends AnalysisResult,DOCUMENT extends org.openimaj.data.identity.Identifiable,QUERY> - Class in org.openimaj.experiment.evaluation.retrieval: An implementation of an Evaluator for the evaluation of retrieval experiments using the Cranfield methodology.
RetrievalEvaluator(RetrievalEngine<DOCUMENT, QUERY>, Collection<QUERY>, Map<QUERY, Set<DOCUMENT>>, RetrievalAnalyser<RESULT, QUERY, DOCUMENT>) - Constructor for class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator: Construct a new RetrievalEvaluator with a search engine, a set of queries to perform, relevant documents for each query, and a RetrievalAnalyser to analyse the results.
RetrievalEvaluator(RetrievalEngine<DOCUMENT, QUERY>, Map<QUERY, Set<DOCUMENT>>, RetrievalAnalyser<RESULT, QUERY, DOCUMENT>) - Constructor for class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator: Construct a new RetrievalEvaluator with a search engine, relevant documents for each query, and a RetrievalAnalyser to analyse the results.
RetrievalEvaluator(Map<QUERY, List<DOCUMENT>>, Map<QUERY, Set<DOCUMENT>>, RetrievalAnalyser<RESULT, QUERY, DOCUMENT>) - Constructor for class org.openimaj.experiment.evaluation.retrieval.RetrievalEvaluator: Construct a new RetrievalEvaluator with the given ranked results lists and sets of relevant documents for each query, and a RetrievalAnalyser to analyse the results.
ROCAnalyser<OBJECT,CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.roc: A ClassificationAnalyser capable of producing a Receiver Operating Characteristic curve and associated statistics.
ROCAnalyser() - Constructor for class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCAnalyser
ROCResult<CLASS> - Class in org.openimaj.experiment.evaluation.classification.analysers.roc: An AnalysisResult representing a set of ROC curves and associated statistics.
run(ResultAggregator<ANALYSIS_RESULT, AGGREGATE_ANALYSIS_RESULT>, DATASET, CrossValidator<DATASET>, ValidationOperation<DATASET, ANALYSIS_RESULT>) - Static method in class org.openimaj.experiment.validation.ValidationRunner: Perform cross validation using the given cross validation scheme on the given data.
run(ResultAggregator<ANALYSIS_RESULT, AGGREGATE_ANALYSIS_RESULT>, DATASET, CrossValidator<DATASET>, ValidationOperation<DATASET, ANALYSIS_RESULT>, ThreadPoolExecutor) - Static method in class org.openimaj.experiment.validation.ValidationRunner: Perform cross validation using the given cross validation scheme on the given data.
runExperiment(RunnableExperiment) - Static method in class org.openimaj.experiment.ExperimentRunner: Run an experiment, filling in the context of the experiment as it runs.
RunnableExperiment - Interface in org.openimaj.experiment: Interface for classes implementing experiments that can be run with the ExperimentRunner.

S

sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, double) - Static method in class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Sample a dataset with the given percentage of instances to select.
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, double, boolean) - Static method in class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Sample a dataset with the given percentage of instances to select, using with with-replacement or without-replacement sampling.
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, int) - Static method in class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Sample a dataset with the given number of instances to select.
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, int, boolean) - Static method in class org.openimaj.experiment.dataset.sampling.GroupedUniformRandomisedSampler: Sample a dataset with the given number of instances to select, using with with-replacement or without-replacement sampling.
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.dataset.sampling.GroupSampler
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, int, boolean) - Static method in class org.openimaj.experiment.dataset.sampling.GroupSampler: Sample a dataset with the given number of groups to select.
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.dataset.sampling.NamedGroupSampler
sample(GroupedDataset<KEY, ? extends ListDataset<INSTANCE>, INSTANCE>, Collection<KEY>) - Static method in class org.openimaj.experiment.dataset.sampling.NamedGroupSampler: Sample a dataset by selecting only the given group keys.
sample(DATASET) - Method in interface org.openimaj.experiment.dataset.sampling.Sampler: Perform the sampling operation on the given data and return the sampled dataset.
sample(GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Method in class org.openimaj.experiment.dataset.sampling.StratifiedGroupedUniformRandomisedSampler
sample(ListDataset<INSTANCE>) - Method in class org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler
Sampler<DATASET extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.dataset.sampling: Interface describing classes that can sample instances from a dataset to create a new (smaller) dataset.
score() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
score() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
score() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
score() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
score() - Method in interface org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineWrappable
score() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
Scored - Interface in org.openimaj.experiment.evaluation.retrieval: Interface for objects that have an associated score.
search(QUERY) - Method in interface org.openimaj.experiment.evaluation.retrieval.RetrievalEngine: Search with the given query and return a ranked list of matching documents.
setup() - Method in interface org.openimaj.experiment.RunnableExperiment: Setup of the experiment
SimpleMEAnalysis - Class in org.openimaj.experiment.evaluation.cluster.analyser: Result of applying a SimpleMEClusterAnalyser.
SimpleMEAnalysis() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEAnalysis
SimpleMEClusterAnalyser - Class in org.openimaj.experiment.evaluation.cluster.analyser: A set of measures used to evaluate clustering.
SimpleMEClusterAnalyser() - Constructor for class org.openimaj.experiment.evaluation.cluster.analyser.SimpleMEClusterAnalyser
stats - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis: General statistics
strategy - Variable in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser
StratifiedGroupedKFold<KEY,INSTANCE> - Class in org.openimaj.experiment.validation.cross: Stratified K-Fold Cross-Validation on grouped datasets.
StratifiedGroupedKFold(int) - Constructor for class org.openimaj.experiment.validation.cross.StratifiedGroupedKFold: Construct a StratifiedGroupedKFold with the given target number of folds, K.
StratifiedGroupedRandomisedPercentageHoldOut<KEY,INSTANCE> - Class in org.openimaj.experiment.validation: Stratified Hold-Out validation for grouped data that selects a percentage of the original data to use for training, and the remainder to use for validation.
StratifiedGroupedRandomisedPercentageHoldOut(double, GroupedDataset<KEY, ListDataset<INSTANCE>, INSTANCE>) - Constructor for class org.openimaj.experiment.validation.StratifiedGroupedRandomisedPercentageHoldOut: Construct with the given dataset and percentage of training data (0..1).
StratifiedGroupedUniformRandomisedSampler<KEY,INSTANCE> - Class in org.openimaj.experiment.dataset.sampling: A stratified uniformly random sampling scheme for grouped datasets.
StratifiedGroupedUniformRandomisedSampler(double) - Constructor for class org.openimaj.experiment.dataset.sampling.StratifiedGroupedUniformRandomisedSampler: Construct a StratifiedGroupedUniformRandomisedSampler with the given percentage of instances to select.
StratifiedGroupedUniformRandomisedSampler(double, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.StratifiedGroupedUniformRandomisedSampler: Construct a StratifiedGroupedUniformRandomisedSampler with the given percentage of instances to select, using with with-replacement or without-replacement sampling.
StratifiedGroupedUniformRandomisedSampler(int) - Constructor for class org.openimaj.experiment.dataset.sampling.StratifiedGroupedUniformRandomisedSampler: Construct a StratifiedGroupedUniformRandomisedSampler with the given number of instances to select.
StratifiedGroupedUniformRandomisedSampler(int, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.StratifiedGroupedUniformRandomisedSampler: Construct a StratifiedGroupedUniformRandomisedSampler with the given number of instances to select, using with with-replacement or without-replacement sampling.

T

TestSplitProvider<OUT extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.dataset.split: An object that can provide a test dataset.
Time - Annotation Type in org.openimaj.experiment.annotations: An annotation to mark that you want the execution time of a method to be recorded during an experiment.
TimeClassTransformer - Class in org.openimaj.experiment.agent: ClassFileTransformer that dynamically augments classes and methods annotated with Time annotations in order to register and collect the method timing information.
TimeClassTransformer() - Constructor for class org.openimaj.experiment.agent.TimeClassTransformer
TimeTracker - Class in org.openimaj.experiment.agent: A class for tracking various execution times and generating statistics.
TimeTracker() - Constructor for class org.openimaj.experiment.agent.TimeTracker
TN - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis: The total number of pairs in different clusters which belong to different classes
toClusters() - Method in class org.openimaj.experiment.dataset.cluster.ClusterEvalDataset
toString() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.AggregatedCMResult
toString() - Method in class org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMResult
toString() - Method in class org.openimaj.experiment.evaluation.classification.analysers.roc.ROCResult
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.AdjustedRandomIndexAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.ClusterStatsAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.FScoreAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.PurityAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineClusterAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.cluster.analyser.RandomIndexAnalysis
toString() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.IREvalResult
toString() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult
toString() - Method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult
toString() - Method in class org.openimaj.experiment.ExperimentContext
toString() - Method in class org.openimaj.experiment.validation.cross.GroupedKFold
toString() - Method in class org.openimaj.experiment.validation.cross.GroupedLeaveOneOut
toString() - Method in class org.openimaj.experiment.validation.cross.KFold
toString() - Method in class org.openimaj.experiment.validation.cross.LeaveOneOut
toString() - Method in class org.openimaj.experiment.validation.cross.StratifiedGroupedKFold
TP - Variable in class org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis: The total number of pairs in a cluster which belong to the same class
training - Variable in class org.openimaj.experiment.validation.DefaultValidationData
TrainSplitProvider<OUT extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.dataset.split: An object that can provide a training dataset.
transform(String, CtClass) - Method in class org.openimaj.experiment.agent.TimeClassTransformer
TRECEvalAnalyser<QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable> - Class in org.openimaj.experiment.evaluation.retrieval.analysers: A RetrievalAnalyser that uses the trec_eval commandline tool to perform the analysis.
TRECEvalAnalyser() - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.TRECEvalAnalyser: Default constructor
TRECResult - Class in org.openimaj.experiment.evaluation.retrieval.analysers: An AnalysisResult wrapping the output of the trec_eval tool.
TRECResult(String) - Constructor for class org.openimaj.experiment.evaluation.retrieval.analysers.TRECResult: Construct with the given output from trec_eval

U

UniformRandomisedSampler<INSTANCE> - Class in org.openimaj.experiment.dataset.sampling: A uniformly random sampling scheme for ListDatasets.
UniformRandomisedSampler(double) - Constructor for class org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler: Construct a UniformRandomisedSampler with the given percentage of instances to select.
UniformRandomisedSampler(double, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler: Construct a UniformRandomisedSampler with the given percentage of instances to select, using with with-replacement or without-replacement sampling.
UniformRandomisedSampler(int) - Constructor for class org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler: Construct a UniformRandomisedSampler with the given number of instances to select.
UniformRandomisedSampler(int, boolean) - Constructor for class org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler: Construct a UniformRandomisedSampler with the given number of instances to select, using with with-replacement or without-replacement sampling.

V

ValidateSplitProvider<OUT extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.dataset.split: An object that can provide a validation dataset.
validation - Variable in class org.openimaj.experiment.validation.DefaultValidationData
ValidationData<DATASET extends org.openimaj.data.dataset.Dataset<?>> - Interface in org.openimaj.experiment.validation: Data for performing validation.
ValidationOperation<DATASET extends org.openimaj.data.dataset.Dataset<?>,ANALYSIS_RESULT> - Interface in org.openimaj.experiment.validation: Interface describing the contract for classes which can perform a the operations required for a single round of validation.
ValidationRunner - Class in org.openimaj.experiment.validation: Utility methods for performing validation and cross validation.
valueOf(String) - Static method in enum org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser.Strategy: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.openimaj.experiment.evaluation.classification.analysers.confusionmatrix.CMAnalyser.Strategy: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeQRELS(Map<Q, Set<D>>, PrintStream) - Static method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECEvalAnalyser: Write the ground-truth data in TREC QRELS format.
writeTop(Map<Q, List<D>>, PrintStream) - Static method in class org.openimaj.experiment.evaluation.retrieval.analysers.TRECEvalAnalyser: Write retrieval results in TREC TOP format.

A B C D E F G I K L M N O P Q R S T U V W