org.openimaj.video.processing.shotdetector

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

java.lang.Object

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

Type Parameters:

T - the Image type

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

A class that represents a keyframe of a video. Encapsualtes the image representing the keyframe as well as the timecode at which the keyframe occurs in the video.

Author:

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

Created:

1 Jun 2011

Field Summary

Fields

Modifier and Type	Field and Description
T	imageAtBoundary An image at the shot boundary
VideoTimecode	timecode The timecode of the keyframe

Constructor Summary

Constructors

Constructor and Description
VideoKeyframe(VideoTimecode timecode, T img) Constructor that allows construction of an image-based shot boundary.

Method Summary

Modifier and Type	Method and Description
VideoKeyframe<T>	clone()
T	getImage() Return the image at the shot boundary.
VideoTimecode	getTimecode() Returns the timecode of this keyframe.

Methods inherited from class java.lang.Object

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

Field Detail

imageAtBoundary

public T extends Image<?,T> imageAtBoundary

An image at the shot boundary

timecode

public VideoTimecode timecode

The timecode of the keyframe

Constructor Detail

VideoKeyframe

public VideoKeyframe(VideoTimecode timecode,
                     T img)

Constructor that allows construction of an image-based shot boundary.

Parameters:

timecode - The timecode of the shot boundary

img - The image at the shot boundary

Method Detail

getImage

public T getImage()

Return the image at the shot boundary.

Returns:

The image at the shot boundary.

getTimecode

public VideoTimecode getTimecode()

Returns the timecode of this keyframe.

Returns:

The timecode of the keyframe in the video.

clone

public VideoKeyframe<T> clone()

Overrides:

clone in class Object