Class StoriesSegment

java.lang.Object
  |
  +--StoriesSegment
Direct Known Subclasses:
TruthData, VideoSubmission

public abstract class StoriesSegment
extends java.lang.Object


Field Summary
 java.util.Vector clippedRef
           
 java.util.Vector clippedSub
           
 java.util.Vector clippingPoints
           
 java.util.Vector deletion
           
 java.util.Vector insertion
           
 TimeBase lengthVideo
           
 java.util.Vector match
           
 java.util.Vector matchType
           
 java.util.Vector missingType
           
 java.util.Vector nomatchType
           
 TimeBase offsetAnalogMinusDigital
           
 java.util.Vector segmentation
           
 java.util.Vector segmentationBeforeClipping
           
 boolean treated
           
 
Constructor Summary
StoriesSegment()
          Constructor method.
 
Method Summary
abstract  void addEndTime()
          this method add the end Time of the last Story ofthe segmentation Vector.
 void addOneStory(TimeBase beginTime, TimeBase endTime, java.lang.String type)
          Add a story to the SoriesSegment.
abstract  java.util.Vector applyClippingPoints()
          This method applies the clipping points on a StoriesSegment object.
 void displaySegment()
          This method display on the standard ouput the content of the segmentation of a StoriesSegment Object.
abstract  TimeBase getAlign()
          Get the offset you have to apply on the a StoriesSegment Object Time to get the AnalogTime
 TimeBase getBeginStoryForTime(TimeBase t)
          Gives a time t and this method will return the BeginTime of the story that time t belongs to
 int getBeginTimeStory(int nbStory)
          returns the Begin Time of the story number nbSTory in the segmentation
 int getEndTimeStory(int nbStory)
          returns the End Time of the story number nbSTory in the segmentation
 TimeBase getMPEG1Length()
          Return the length of the Mpeg1 video associated
 int getNumberOfBoundaries()
          Returns the number of boundaries of the current StoriesSegment
 int getNumberOfEvaluatedBoundaries()
          Returns the number of boundaries evaluated of the current StoriesSegment.
 int getNumberOfStories()
          Returns the number of Stories of the current StoriesSegment
 int getTimeOfBoundary(int noBoundary)
          Returns the time of the 1st, 2nd ...n th boundary
 int getTotalTimeOneStory(java.lang.String typeStory)
          Returns the length of story named typeStory of the current StoriesSegment
 java.lang.String getType(int nbStory)
          returns the type of the story number nbSTory in the segmentation
 java.lang.String getType(TimeBase t1, TimeBase t2)
          This method return the type of a story between two boundaries.
abstract  java.lang.String getVideoFileName()
          returns the video file name of the current object either Truth or Submission
 TimeBase getVideoLength()
          It returns the length of the current video (Mpeg1)
 java.util.Vector invertStoriesSegment(java.util.Vector segmentationInv)
          This method invert the stories in the storiesSegment object.
 java.util.Vector returnResultBoundaryDistribution()
          Returns a Vector with all the Vectors useful ofr the Story boundary task
 java.util.Vector returnResultStoryDistribution()
          Returns a Vector with all the Vectors useful ofr the Classification task
 java.util.Vector searchClippingPoints()
          It returns the clipping points ie the clipping start and the clipping end for the current Stories segment object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

segmentation

public java.util.Vector segmentation

segmentationBeforeClipping

public java.util.Vector segmentationBeforeClipping

clippingPoints

public java.util.Vector clippingPoints

lengthVideo

public TimeBase lengthVideo

treated

public boolean treated

offsetAnalogMinusDigital

public TimeBase offsetAnalogMinusDigital

insertion

public java.util.Vector insertion

deletion

public java.util.Vector deletion

match

public java.util.Vector match

clippedRef

public java.util.Vector clippedRef

clippedSub

public java.util.Vector clippedSub

matchType

public java.util.Vector matchType

nomatchType

public java.util.Vector nomatchType

missingType

public java.util.Vector missingType
Constructor Detail

StoriesSegment

public StoriesSegment()
Constructor method. It instantiates the segmentation Vector. The structure of the segmentation Vector is as following :
    |      |      |      |                        |      |
    |Vector|Vector|Vector| .......................|Vector|
    |      |      |      |                        |      |
       |
       |

    | bTime  | : Begin Time of the Story
    | eTime  | : End Time of the Story, which is the begin time of the next one 
    | Type   | : Type of the story, for TRECVID2003 "misc" or "news"

Method Detail

getVideoFileName

public abstract java.lang.String getVideoFileName()
returns the video file name of the current object either Truth or Submission

Returns:
String

addEndTime

public abstract void addEndTime()
this method add the end Time of the last Story ofthe segmentation Vector. Indeed the eTime of a story is always the beginning of the next story except for the last one.


getAlign

public abstract TimeBase getAlign()
Get the offset you have to apply on the a StoriesSegment Object Time to get the AnalogTime


getMPEG1Length

public TimeBase getMPEG1Length()
Return the length of the Mpeg1 video associated

Returns:
TimeBase object, length of the video

applyClippingPoints

public abstract java.util.Vector applyClippingPoints()
This method applies the clipping points on a StoriesSegment object.

Returns:
Vector it returns the clipped Stories.

displaySegment

public void displaySegment()
This method display on the standard ouput the content of the segmentation of a StoriesSegment Object. Thus it will be be display like following : ... start : 28.03 end :54.02 Type : news start : 128.03 end :154.02 Type : misc ...


getType

public java.lang.String getType(TimeBase t1,
                                TimeBase t2)
This method return the type of a story between two boundaries. t1 t2 must be story boundaries from the submission or the Reference or also one from the submission and the other one from reference ... Warning : it works ONLY if t1 and t2 are boundaries and t1
Parameters:
t1 - first TimeBase object of a story boundary
t2 - second timeBase object of a story boundary
Returns:
String type is "misc" or "news" for TRECVID2003

getVideoLength

public TimeBase getVideoLength()
It returns the length of the current video (Mpeg1)

Returns:
TimeBase

searchClippingPoints

public java.util.Vector searchClippingPoints()
It returns the clipping points ie the clipping start and the clipping end for the current Stories segment object. If the clipping points are not found for this object, its attibute treated is set to false and this method return an empty Vector

Returns:
Vector having the following structure
          |fileName |
                 |clipstart|
                 |clipend  |

addOneStory

public void addOneStory(TimeBase beginTime,
                        TimeBase endTime,
                        java.lang.String type)
Add a story to the SoriesSegment. The description of the story is in argument

Parameters:
beginTime - the begin Time of the story to add
endTime - the end time of the story to add
type - type of the story to add

invertStoriesSegment

public java.util.Vector invertStoriesSegment(java.util.Vector segmentationInv)
This method invert the stories in the storiesSegment object. Therefore the last story becomes the first.

Parameters:
segmentationInv - the segmenttaion to invert.
Returns:
Vector . The inverted segmentation.

getTimeOfBoundary

public int getTimeOfBoundary(int noBoundary)
Returns the time of the 1st, 2nd ...n th boundary

Parameters:
noBoundary - int : numero of the boudary in the segmentation
Returns:
int number of centiseconds

getBeginTimeStory

public int getBeginTimeStory(int nbStory)
returns the Begin Time of the story number nbSTory in the segmentation

Parameters:
nbStory - int :no of story in the segmentation
Returns:
int

getEndTimeStory

public int getEndTimeStory(int nbStory)
returns the End Time of the story number nbSTory in the segmentation

Parameters:
nbStory - int :no of story in the segmentation
Returns:
int

getType

public java.lang.String getType(int nbStory)
returns the type of the story number nbSTory in the segmentation

Parameters:
nbStory - int :no of story in the segmentation
Returns:
String : "news" or "misc" for TRECVID2003

getBeginStoryForTime

public TimeBase getBeginStoryForTime(TimeBase t)
Gives a time t and this method will return the BeginTime of the story that time t belongs to

Parameters:
t - TimeBase Whose story is this time t?
Returns:
TimeBase begin Time of a story

getNumberOfStories

public int getNumberOfStories()
Returns the number of Stories of the current StoriesSegment

Returns:
int

getNumberOfBoundaries

public int getNumberOfBoundaries()
Returns the number of boundaries of the current StoriesSegment

Returns:
int

getNumberOfEvaluatedBoundaries

public int getNumberOfEvaluatedBoundaries()
Returns the number of boundaries evaluated of the current StoriesSegment. Ie those inside the clipping points expect those ones

Returns:
int

getTotalTimeOneStory

public int getTotalTimeOneStory(java.lang.String typeStory)
Returns the length of story named typeStory of the current StoriesSegment

Parameters:
typeStory - type of the story. For TRECVID2003 it is "news"
Returns:
int total length od soty in the current StoriesSegment

returnResultBoundaryDistribution

public java.util.Vector returnResultBoundaryDistribution()
Returns a Vector with all the Vectors useful ofr the Story boundary task

Returns:
Vector The structure of this Vector is as following :
         |insertion | : Vector containing the information for insertion story boundaries
         | deletion | : Vector containing the information for deletion story boundaries
         |  match   | : Vector containing the information for match story boundaries
         |ClippedRef| : Vector containing the information for Clipped story boundaries from the reference
         |ClippedSub| : Vector containing the information for Clipped story boundaries from the submission
 

returnResultStoryDistribution

public java.util.Vector returnResultStoryDistribution()
Returns a Vector with all the Vectors useful ofr the Classification task

Returns:
Vector The structure of this Vector is as following :
 
         |matchtype  | : Vector containing the information for match stories
         |nomatch    | : Vector containing the information for storie that doesn't match
         |missingType| : Vector containing the information for stories which are in the Reference but not in the submission
         |ClippedRef | : Vector containing the information for Clipped stories from the reference
         |ClippedSub | : Vector containing the information for Clipped stories from the submission