Class StorySegmentationEvaluation

java.lang.Object
  |
  +--StorySegmentationEvaluation

public class StorySegmentationEvaluation
extends java.lang.Object


Field Summary
 java.util.Vector listTruth
           
 
Constructor Summary
StorySegmentationEvaluation(java.lang.String directorySubmissionStr)
          Constructor of the Class.
 
Method Summary
 java.util.Vector copylistTruth(java.util.Vector v)
           
 TimeBase getAlignementOfPossibleSubmission(TruthData truth)
          This function returns the offset you must apply on the submission file corresponding to the truth file.
 java.lang.String getExtension(java.io.File f)
          This method get the extension of a file
 int getGlobalNumberOfEvaluatedBoundariesinAllTruth()
          This Method figures out the total number of boundaries evaluted in every files of the reference
 int getGlobalTotalTimeofOneStoryAllTruth(java.lang.String typeStory)
          This Method figures out the length of a story type in every files of the reference
 int getNumberOfRunSubmitted(Submission submi)
          Returns the number of the runs submitted in an Submission ie one xml file
 int getNumberOfVideoSubmitted(org.w3c.dom.Node run)
          This method returns the number of videos in on specific run
 java.util.Vector getRunsEvaluated()
          This function is called in the constructor of this class.
 TruthData getTruth(VideoSubmission vidsub)
          This method is used to get the TruthData object corresponding to the video.
 org.w3c.dom.Element getVideosMissing(org.w3c.dom.Node run)
          This methos returns the name of the Videos Missing in a run of the submission
 java.util.Vector loadClippingPoints()
           
 java.util.Vector loadOffsets()
          It load All the offset fron the alignment table named "alignment.txt.final".
 java.util.Vector loadTruthData()
          It loads all the Reference file within the directory directoryTruth, an attribute of this class
static void main(java.lang.String[] args)
           
 void write()
          This method write an xml file into the directory Result you put in argument of the execution command.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

listTruth

public java.util.Vector listTruth
Constructor Detail

StorySegmentationEvaluation

public StorySegmentationEvaluation(java.lang.String directorySubmissionStr)
Constructor of the Class. it loops on the files within the directoris you give in paramter

Parameters:
directorySubmissionStr - The name of the directory you want to be evaluated. This directory must be in the path indicated by the attribute pathsubmission. The name of the directory should be the name of the group. Afterwards this name will be concatenated to the result file. Indeed if you would like to evalute the result of the nist it will create a file named Resultnist.xml into the directory given in the attribute pathResult
Method Detail

getRunsEvaluated

public java.util.Vector getRunsEvaluated()
This function is called in the constructor of this class. It returns a Vector of Elements

Returns:
A vector of Element

getAlignementOfPossibleSubmission

public TimeBase getAlignementOfPossibleSubmission(TruthData truth)
This function returns the offset you must apply on the submission file corresponding to the truth file. To apply the clipping points it's important to kmow the clipping points anf the o

Parameters:
truth -
Returns:
the offset you apply on the submission

getGlobalNumberOfEvaluatedBoundariesinAllTruth

public int getGlobalNumberOfEvaluatedBoundariesinAllTruth()
This Method figures out the total number of boundaries evaluted in every files of the reference

Returns:
it returns an int, number of boundaries evaluated in the whole truth

copylistTruth

public java.util.Vector copylistTruth(java.util.Vector v)

getGlobalTotalTimeofOneStoryAllTruth

public int getGlobalTotalTimeofOneStoryAllTruth(java.lang.String typeStory)
This Method figures out the length of a story type in every files of the reference

Parameters:
typeStory - the type of the story we are looking for, for TRECVID2003 it was "news"
Returns:
it returns an int, length of a type

write

public void write()
This method write an xml file into the directory Result you put in argument of the execution command. if the directory containing the submission is name xxx, the result file will be named Resulxxx.xml and it will be placed in the Result directory


getVideosMissing

public org.w3c.dom.Element getVideosMissing(org.w3c.dom.Node run)
This methos returns the name of the Videos Missing in a run of the submission

Returns:
it returns an XML Element, it is the tag

getNumberOfRunSubmitted

public int getNumberOfRunSubmitted(Submission submi)
Returns the number of the runs submitted in an Submission ie one xml file

Parameters:
submi - its is a submission object wich is the Object containing all usefull information for one XML file
Returns:
it returns an int

getNumberOfVideoSubmitted

public int getNumberOfVideoSubmitted(org.w3c.dom.Node run)
This method returns the number of videos in on specific run

Parameters:
run - it is the the XML Node of one run
Returns:
it returns an int

getExtension

public java.lang.String getExtension(java.io.File f)
This method get the extension of a file

Parameters:
f - the you want to get the extension from
Returns:
it returns the extension as a string

getTruth

public TruthData getTruth(VideoSubmission vidsub)
This method is used to get the TruthData object corresponding to the video. ie its finds the reference for a specific video

Parameters:
vidsub - a VideoSubmission object, it is actually a object contaning the result for One video of One specific run of One group
Returns:
TruthData object, the reference object you have to compare the video to

loadTruthData

public java.util.Vector loadTruthData()
It loads all the Reference file within the directory directoryTruth, an attribute of this class

Returns:
TruthData Object is created for each file and is added to a vector which is returned

loadClippingPoints

public java.util.Vector loadClippingPoints()

loadOffsets

public java.util.Vector loadOffsets()
It load All the offset fron the alignment table named "alignment.txt.final".

Returns:
it returns a Vector containing sub-Vector. Those sub-Vector contains the offset and the name of the file the offset has to be applied

main

public static void main(java.lang.String[] args)