org.openimaj.tools.imagecollection.collection.video

Class XuggleVideoImageCollection

java.lang.Object

org.openimaj.tools.imagecollection.collection.video.XuggleVideoImageCollection

All Implemented Interfaces:

Iterable<ImageCollectionEntry<MBFImage>>, ImageCollection<MBFImage>

Direct Known Subclasses:

XuggleVideoImageCollection.FromFile, XuggleVideoImageCollection.FromURL

public abstract class XuggleVideoImageCollection
extends Object
implements ImageCollection<MBFImage>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XuggleVideoImageCollection.FromFile
static class	XuggleVideoImageCollection.FromURL

Field Summary

Fields

Modifier and Type	Field and Description
XuggleVideo	video

Constructor Summary

Constructors

Constructor and Description
XuggleVideoImageCollection()

Method Summary

Modifier and Type	Method and Description
int	countImages()
List<ImageCollectionEntry<MBFImage>>	getAll()
Iterator<ImageCollectionEntry<MBFImage>>	iterator()
protected abstract XuggleVideo	loadXuggleVideo(String object)
void	setEntrySelection(ImageCollectionEntrySelection<MBFImage> selection) Control how an image collection is to accept or ignore a given entry of the collection
void	setup(ImageCollectionConfig config) Setup this collection using the provided collection config.
int	useable(ImageCollectionConfig config) Is the contents of the provided image colleciton config sufficient for this collection to run.
protected abstract String	videoTag()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.tools.imagecollection.collection.ImageCollection

defaultConfig, useable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

video

public XuggleVideo video

Constructor Detail

XuggleVideoImageCollection

public XuggleVideoImageCollection()

Method Detail

iterator

public Iterator<ImageCollectionEntry<MBFImage>> iterator()

Specified by:

iterator in interface Iterable<ImageCollectionEntry<MBFImage>>

setEntrySelection

public void setEntrySelection(ImageCollectionEntrySelection<MBFImage> selection)

Description copied from interface: ImageCollection

Control how an image collection is to accept or ignore a given entry of the collection

Specified by:

setEntrySelection in interface ImageCollection<MBFImage>

setup

public void setup(ImageCollectionConfig config)
           throws ImageCollectionSetupException

Description copied from interface: ImageCollection

Setup this collection using the provided collection config.

Specified by:

setup in interface ImageCollection<MBFImage>

Throws:

ImageCollectionSetupException

countImages

public int countImages()

Specified by:

countImages in interface ImageCollection<MBFImage>

Returns:

The number of images in this collection (might be an estimate or 0, don't rely on this)

loadXuggleVideo

protected abstract XuggleVideo loadXuggleVideo(String object)

videoTag

protected abstract String videoTag()

useable

public int useable(ImageCollectionConfig config)

Description copied from interface: ImageCollection

Is the contents of the provided image colleciton config sufficient for this collection to run.

Specified by:

useable in interface ImageCollection<MBFImage>

Returns:

< 0 if this collection is not useable with this configuration. >= 0 otherwise, higher numbers give a clue as to ability to deal with configuration when compared to other collections

getAll

public List<ImageCollectionEntry<MBFImage>> getAll()

Specified by:

getAll in interface ImageCollection<MBFImage>

Returns:

List of all images in this collection