efxtools.filtering
Class FilteringProfile

java.lang.Object
  extended by efxtools.filtering.FilteringProfile

public class FilteringProfile
extends java.lang.Object

Storage for performance values that are measured by the ScopeTMS. These values refer to the time spent for generating, determining, and filtering scopes as well as to the fraction of the input text that is actually processed within the filtering framework.

Author:
Author of EfXTools

Constructor Summary
FilteringProfile()
          The constructor initializes all values.
 
Method Summary
static FilteringProfile computeAverages(FilteringProfile[] profiles)
          Computes the averages of all values of the profiling objects.
static FilteringProfile computeStandardDeviations(FilteringProfile[] profiles, FilteringProfile averageProfile)
          Computes the standard deviations of all values of the profiling objects with respect to to the given average profile.
 java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Long> getAlgorithmsAnalyzedCharacters()
          Returns the number of analyzed characters for each algorithm.
 java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Long> getAlgorithmsInputCharacters()
          Returns the number of processed characters for each algorithm.
 long getAllAnnotations()
          Returns the number of annotations produced in total by all primitive analysis engines.
 double getAnalysisRate()
          Returns the analysis rate, i.e., the fraction of the run-time spent in total that has been spent for analysis.
 java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Double> getAnalysisTimes()
          Returns the time spent for analysis for each set of output types associated to an algorithm.
 long getAnalyzedCharacters()
          Returns the number of analyzed characters, i.e. the number of characters of all input texts that were passed to the analysis engines within a scope.
 double getCharacterFilterRate()
          Returns the character filter rate, i.e., a number between 0 and 1 that represents the fraction of all characters that have been analyzed.
 double getDeterminationTime()
          Returns the time spent for determining the scopes to be processed.
 double getFilteringTime()
          Returns the time spent for filtering scopes.
 double getFrameworkRate()
          Returns the framework rate, i.e., the fraction of the run-time spent in total that has been spent for the filtering framework.
 double getGenerationTime()
          Returns the time spent for generating scopes.
 long getInputCharacters()
          Returns the overall number of processed characters, i.e. the number of characters of all input texts.
 long getNonScopeAnnotations()
          Returns the number of non-scope annotations produced in total by all primitive analysis engines.
 double getOverallAnalysisTime()
          Returns the overall time spent for analysis by all algorithms.
 double getOverallTime()
          Returns the time spent in total.
 long getScopeAnnotations()
          Returns the number of scope annotations produced in total by all primitive analysis engines.
 void reset()
          Resets all values to the initial values.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilteringProfile

public FilteringProfile()
The constructor initializes all values.

Method Detail

reset

public void reset()
Resets all values to the initial values.


getAnalysisTimes

public java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Double> getAnalysisTimes()
Returns the time spent for analysis for each set of output types associated to an algorithm.

Returns:
The analysis times

getOverallAnalysisTime

public double getOverallAnalysisTime()
Returns the overall time spent for analysis by all algorithms.

Returns:
The generation time

getGenerationTime

public double getGenerationTime()
Returns the time spent for generating scopes.

Returns:
The generation time

getDeterminationTime

public double getDeterminationTime()
Returns the time spent for determining the scopes to be processed.

Returns:
The determination time

getFilteringTime

public double getFilteringTime()
Returns the time spent for filtering scopes.

Returns:
The filtering time

getOverallTime

public double getOverallTime()
Returns the time spent in total.

Returns:
The total time

getAnalysisRate

public double getAnalysisRate()
Returns the analysis rate, i.e., the fraction of the run-time spent in total that has been spent for analysis.

Returns:
The analysis rate

getFrameworkRate

public double getFrameworkRate()
Returns the framework rate, i.e., the fraction of the run-time spent in total that has been spent for the filtering framework.

Returns:
The framework rate

getInputCharacters

public long getInputCharacters()
Returns the overall number of processed characters, i.e. the number of characters of all input texts.

Returns:
The number of processed characters

getAlgorithmsInputCharacters

public java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Long> getAlgorithmsInputCharacters()
Returns the number of processed characters for each algorithm.

Returns:
The number of processed characters

getAnalyzedCharacters

public long getAnalyzedCharacters()
Returns the number of analyzed characters, i.e. the number of characters of all input texts that were passed to the analysis engines within a scope.

Returns:
The number of processed characters

getAlgorithmsAnalyzedCharacters

public java.util.Map<java.util.Set<org.apache.uima.analysis_engine.TypeOrFeature>,java.lang.Long> getAlgorithmsAnalyzedCharacters()
Returns the number of analyzed characters for each algorithm.

Returns:
The number of analyzed characters

getCharacterFilterRate

public double getCharacterFilterRate()
Returns the character filter rate, i.e., a number between 0 and 1 that represents the fraction of all characters that have been analyzed.

Returns:
The character filter rate

getAllAnnotations

public long getAllAnnotations()
Returns the number of annotations produced in total by all primitive analysis engines.

Returns:
The number of annotations

getScopeAnnotations

public long getScopeAnnotations()
Returns the number of scope annotations produced in total by all primitive analysis engines.

Returns:
The scope annotations

getNonScopeAnnotations

public long getNonScopeAnnotations()
Returns the number of non-scope annotations produced in total by all primitive analysis engines.

Returns:
The non-scope annotations

computeAverages

public static FilteringProfile computeAverages(FilteringProfile[] profiles)
Computes the averages of all values of the profiling objects.

Parameters:
profiles - The profiling objects
Returns:
The averaged values in a profiling object

computeStandardDeviations

public static FilteringProfile computeStandardDeviations(FilteringProfile[] profiles,
                                                         FilteringProfile averageProfile)
Computes the standard deviations of all values of the profiling objects with respect to to the given average profile.

Parameters:
profiles - The profiling objects
averageProfile - The average profile
Returns:
The standard deviations