boofcv.io.wrapper.images

Class ImageStreamSequence<T extends ImageBase>

java.lang.Object

boofcv.io.wrapper.images.ImageStreamSequence<T>

All Implemented Interfaces:

SimpleImageSequence<T>

public class ImageStreamSequence<T extends ImageBase>
extends java.lang.Object
implements SimpleImageSequence<T>

Given a sequence of images encoded with CombineFilesTogether, it will read the files from the stream and decode them. Only one image is read at a time and if it is initialized from a file the sequence can be restarted.

Constructor Summary

Constructors

Constructor and Description
ImageStreamSequence(java.io.InputStream in, boolean storeData, ImageType<T> imageType)
ImageStreamSequence(java.lang.String fileName, boolean storeData, ImageType<T> imageType)

Method Summary

Modifier and Type	Method and Description
void	close() Call when done reading the image sequence.
int	getFrameNumber() Returns the number of the current frame in the sequence.
java.awt.image.BufferedImage	getGuiImage() Returns the image in the original format that it was read in as.
ImageType<T>	getImageType() Returns the type of class used to store the output image
int	getNextHeight() Returns the height of the next image
int	getNextWidth() Returns the width of the next image
boolean	hasNext() If a new image is available.
static void	main(java.lang.String[] args)
T	next() Returns the next image available in the sequence.
void	reset() Start reading the sequence from the start
void	setLoop(boolean loop) Sets if the video should loop or not

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageStreamSequence

public ImageStreamSequence(java.io.InputStream in,
                           boolean storeData,
                           ImageType<T> imageType)

ImageStreamSequence

public ImageStreamSequence(java.lang.String fileName,
                           boolean storeData,
                           ImageType<T> imageType)
                    throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

Method Detail

getNextWidth

public int getNextWidth()

Description copied from interface: SimpleImageSequence

Returns the width of the next image

Specified by:

getNextWidth in interface SimpleImageSequence<T extends ImageBase>

getNextHeight

public int getNextHeight()

Description copied from interface: SimpleImageSequence

Returns the height of the next image

Specified by:

getNextHeight in interface SimpleImageSequence<T extends ImageBase>

hasNext

public boolean hasNext()

Description copied from interface: SimpleImageSequence

If a new image is available.

Specified by:

hasNext in interface SimpleImageSequence<T extends ImageBase>

Returns:

true if a new image is available.

next

public T next()

Description copied from interface: SimpleImageSequence

Returns the next image available in the sequence.

Specified by:

next in interface SimpleImageSequence<T extends ImageBase>

Returns:

Next image in the sequence.

getGuiImage

public java.awt.image.BufferedImage getGuiImage()

Description copied from interface: SimpleImageSequence

Returns the image in the original format that it was read in as. When dealing with swing or any standard Java SE environment this will almost always be BufferedImage. The type has been abstracted out to provide better Android support.

Specified by:

getGuiImage in interface SimpleImageSequence<T extends ImageBase>

Returns:

close

public void close()

Description copied from interface: SimpleImageSequence

Call when done reading the image sequence.

Specified by:

close in interface SimpleImageSequence<T extends ImageBase>

getFrameNumber

public int getFrameNumber()

Description copied from interface: SimpleImageSequence

Returns the number of the current frame in the sequence.

Specified by:

getFrameNumber in interface SimpleImageSequence<T extends ImageBase>

Returns:

Frame ID number.

setLoop

public void setLoop(boolean loop)

Description copied from interface: SimpleImageSequence

Sets if the video should loop or not

Specified by:

setLoop in interface SimpleImageSequence<T extends ImageBase>

Parameters:

loop - true for looping forever, false for once

getImageType

public ImageType<T> getImageType()

Description copied from interface: SimpleImageSequence

Returns the type of class used to store the output image

Specified by:

getImageType in interface SimpleImageSequence<T extends ImageBase>

reset

public void reset()

Description copied from interface: SimpleImageSequence

Start reading the sequence from the start

Specified by:

reset in interface SimpleImageSequence<T extends ImageBase>

main

public static void main(java.lang.String[] args)
                 throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException