org.openimaj.video.processing.shotdetector

Class ShotBoundary<T extends Image<?,T>>

java.lang.Object

org.openimaj.video.processing.shotdetector.ShotBoundary<T>

Type Parameters:

T - The type of image

Direct Known Subclasses:

FadeShotBoundary

public class ShotBoundary<T extends Image<?,T>>
extends Object

A class for encapsulating shot boundary information.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected VideoKeyframe<T>	keyframe The keyframe of the boundary.
protected VideoTimecode	timecode The timecode of the shot boundary

Constructor Summary

Constructors

Constructor and Description
ShotBoundary(VideoTimecode timecode) Construct a shot boundary using the given video timecode.

Method Summary

Methods

Modifier and Type	Method and Description
VideoKeyframe<T>	getKeyframe()
VideoTimecode	getTimecode() Get the timecode of this shot boundary.
void	setKeyframe(VideoKeyframe<T> keyframe)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

timecode

protected VideoTimecode timecode

The timecode of the shot boundary

keyframe

protected VideoKeyframe<T extends Image<?,T>> keyframe

The keyframe of the boundary. May not be set

Constructor Detail

ShotBoundary

public ShotBoundary(VideoTimecode timecode)

Construct a shot boundary using the given video timecode.

Parameters:

timecode - The timecode

Method Detail

getTimecode

public VideoTimecode getTimecode()

Get the timecode of this shot boundary.

Returns:

The timecode of this shot boundary;

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getKeyframe

public VideoKeyframe<T> getKeyframe()

Returns:

the keyframe

setKeyframe

public void setKeyframe(VideoKeyframe<T> keyframe)

Parameters:

keyframe - the keyframe to set