Shot Boundary Task Evaluation
A C E G I L M O P R S T U V W

A

add(Transition) - Method in class Segmentation
Add a given transition to the segmentation.
addSegmentation(Segmentation) - Method in class systemResult
Add the given segmentation to the system results.
adjustPost(int) - Method in class Transition
Sets the post frame value with the given shifting amount.
adjustPre(int) - Method in class Transition
Sets the pre frame value with the given shifting amount.
adjustSystemResult(int) - Method in class ComparisonManager
Adjust the system transition's pre and post values according to the given shifting amount.
ApproximateComparator - class ApproximateComparator.
A class that implements the java.util.Comparator interface to compare two transitions regarding the overlaping of the longer.

C

characters(char[], int, int) - Method in class shotResultContentHandler
SAX DocumentHandler method.
compare(Object, Object) - Method in class ApproximateComparator
Compares its two arguments for ordering them.
compare(Object, Object) - Method in class IntervalComparator
Compares its two arguments for ordering them.
compare(Object, Object) - Method in class OverlapComparator
Compares its two arguments for ordering them.
ComparisonManager - class ComparisonManager.
This class is the main in processing the comparison of a system's shot boundaries segmentations and some references.
ComparisonManager() - Constructor for class ComparisonManager
 
comparisonResult - class comparisonResult.
This class represents the result of a comparison between a system result for one video and the reference.
comparisonResult(String, String, int) - Constructor for class comparisonResult
Constructs comparisonResult object with the given parameters.

E

endDocument() - Method in class shotResultContentHandler
SAX DocumentHandler method.
endElement(String, String, String) - Method in class shotResultContentHandler
SAX DocumentHandler method.
error(SAXParseException) - Method in class shotResultContentHandler
SAX ErrorHandler method.

G

getConfusion(String, String) - Static method in class Transition
Returns true if the given type has to be confused during a comparison.
getCutFrameCount() - Method in class Segmentation
Returns the number of Cut transitions within the segmentation.
getElements() - Method in class Segmentation
Returns an iterator on the transitions within the segmentation.
getFullRefDirName() - Static method in class ComparisonManager
Gets the full path to the reference directory.
getInstance() - Static method in class ApproximateComparator
Returns the unique instance of this class with default parameter value.
getInstance() - Static method in class IntervalComparator
Returns the unique instance of this class.
getInstance() - Static method in class OverlapComparator
Returns the unique instance of this class with default parameter values.
getInstance(double) - Static method in class ApproximateComparator
Returns the unique instance of this class and set the parameter.
getInstance(double, double) - Static method in class OverlapComparator
Returns the unique instance of this class and set the parameters.
getPost() - Method in class Transition
Gets the post frame.
getPre() - Method in class Transition
Gets the pre frame.
getReferenceFileNames() - Method in class shotResultContentHandler
Returns the reference file namesparsed and contained in an Hashtable.
getRefSegmentation() - Method in class shotResultContentHandler
Returns the reference segmentation parsed from one Xml file per segmentation in the reference.
getRMax() - Static method in class OverlapComparator
Gets the RMax parameter.
getRMin() - Static method in class OverlapComparator
Gets the RMin parameter.
getRone() - Static method in class ApproximateComparator
Gets the parameter.
getSegmentations() - Method in class systemResult
Returns an enumeration of segmentations.
getSegmentationsVideoNames() - Method in class systemResult
Returns a Vector containing video names of the segmentations.
getSysId() - Method in class systemResult
Returns the system ID.
getSystemResults() - Method in class shotResultContentHandler
Returns the systemResults parsed and contained in an Hashtable.
getTransitionCount() - Method in class Segmentation
Returns the number of transitions within the segmentation.
getVideoName() - Method in class Segmentation
Returns the video name the segmentation is related to.

I

ignorableWhitespace(char[], int, int) - Method in class shotResultContentHandler
SAX DocumentHandler method.
intersected(Transition) - Method in class Transition
Returns true if there is an intersection with the given transition.
intersection(Transition) - Method in class Transition
Returns a transition representing the intersection with the given transition.
IntervalComparator - class IntervalComparator.
A class that implements the java.util.Comparator interface to compare two transitions regarding their limits.

L

length() - Method in class Transition
Returns the length of the transition (post - pre).

M

main(String[]) - Static method in class ComparisonManager
Main entry point to the program.
matched - Variable in class Transition
Indicates wether the transition has matched with another one during a comparison.

O

OverlapComparator - class OverlapComparator.
A class that implements the java.util.Comparator interface to compare two transitions regarding their overlapping.

P

parseReference() - Method in class ComparisonManager
Launch the parsing of the file containing the Xml reference segmentations.
parseReferenceFileNames(File) - Method in class ComparisonManager
Launch the parsing of the file containing the mapping between a video file name and an Xml segmentation reference file.
parseResults(File) - Method in class ComparisonManager
Launch the parsing of the file containing the results per system results.
post - Variable in class Transition
The post frame: the first frame of the following shot without any content of the transition effect.
pre - Variable in class Transition
The pre frame: the last frame of a previous shot without any content of the transition effect.
processComparison() - Method in class ComparisonManager
Process the comparison between the reference segmentations and each system segmentation.
processComparison(String, Segmentation) - Method in class RefSegmentation
Process the comparison between the current assumed reference segmentation and the given system segmentation.
processingInstruction(String, String) - Method in class shotResultContentHandler
SAX DocumentHandler method.

R

refDirName - Static variable in class ComparisonManager
The reference direcotry.
RefSegmentation - class RefSegmentation.
This class represents a reference segmentation related to a video file used in shot boundary detection task programs of TREC 2001.
RefSegmentation(String, Comparator, int) - Constructor for class RefSegmentation
Constructs Segmentation object with an ordering comparator for its set of transitions.
refToString() - Method in class Transition
Returns an Xml style string of transition with the Xml element name euqal to "refTrans".

S

sameType(Transition) - Method in class Transition
Returns true if the given transition has the same type as the current instance regarding the setted confusions between types.
Segmentation - class Segmentation.
This class represents a segmentation related to a video file used in shot boundary detection task programs of TREC 2001.
Segmentation() - Constructor for class Segmentation
 
setConfusion(String, String) - Static method in class Transition
Sets the confusion between one type and another.
setDocumentLocator(Locator) - Method in class shotResultContentHandler
SAX DocumentHandler method.
setRefDirName(String) - Static method in class ComparisonManager
Overrule refDir, only if directory exists
setResults(int, int, int, String, int, int, int, String, int, int, String, String) - Method in class comparisonResult
Given the parameter, this method writes in the file the results.
setRMax(double) - Static method in class OverlapComparator
Sets the RMax parameter.
setRMin(double) - Static method in class OverlapComparator
Sets the RMin parameter.
setRone(double) - Static method in class ApproximateComparator
Sets the parameter.
shotResultContentHandler - class shotResultContentHandler.
A class that extends DefaultHandler classes of Java Xml SAX API.
shotResultContentHandler(Writer) - Constructor for class shotResultContentHandler
Constructs an instance of this class with the given Writer as the output writer used to get information during parsing...
startDocument() - Method in class shotResultContentHandler
SAX DocumentHandler method.
startElement(String, String, String, Attributes) - Method in class shotResultContentHandler
SAX DocumentHandler method used to recognized Xml tags and get the information in the required Hashtable or any data structure for later use.
SysSegmentation - class SysSegmentation.
This class represents a system segmentation related to a video file used in shot boundary detection task programs of TREC 2001.
SysSegmentation(String, Comparator) - Constructor for class SysSegmentation
Constructs Segmentation object with an ordering comparator for its set of transitions
systemResult - class systemResult.
This class represents the results for one system identified by its ID.
systemResult(String) - Constructor for class systemResult
Instanciate a systemResult object with only the given system ID.
sysToString() - Method in class Transition
Returns an Xml style string of transition with the Xml element name equal to "sysTrans".

T

toString() - Method in class Segmentation
Returns an Xml string representing the segmentation in a pre-defined format.
toString() - Method in class systemResult
Returns an Xml String of the system results including all segmentations.
toString() - Method in class Transition
Returns an Xml style string of transition.
totalFrameNumber - Variable in class RefSegmentation
The number of frames of the video.
Transition - class Transition.
This class represents a shot transition.
Transition(int, int, String) - Constructor for class Transition
Constructs Transition object with the given parameters.
TransitionDefinitionException - exception TransitionDefinitionException.
Thrown when attempts to define a transition with uncorrect values.
transitionSet - Variable in class Segmentation
This object is containing all the transitions of the segmentation.
type - Variable in class Transition
The type of transition: could take the value "cut" and anything else stands for a gradual transition.

U

usage() - Static method in class ComparisonManager
Print usage message

V

videoName - Variable in class Segmentation
The video name the segmentation is related to.

W

warning(SAXParseException) - Method in class shotResultContentHandler
SAX ErrorHandler method.

A C E G I L M O P R S T U V W
Shot Boundary Task Evaluation

For information over@nist.gov or rtaban@nist.gov