Package boofcv.io.wrapper.images

Class ImageStreamSequence<T extends ImageBase<T>>

java.lang.Object

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

All Implemented Interfaces:

SimpleImageSequence<T>

public class ImageStreamSequence<T extends ImageBase<T>>
extends 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	Description
ImageStreamSequence(InputStream in, boolean storeData, ImageType<T> imageType)
ImageStreamSequence(String fileName, boolean storeData, ImageType<T> imageType)

Method Summary

Modifier and Type	Method	Description
void	close()	Call when done reading the image sequence.
int	getFrameNumber()	Returns the number of the current frame in the sequence.
BufferedImage	getGuiImage()	Returns the image in the original format that it was read in as.
int	getHeight()	Returns the height of the current image
T	getImage()	Returns the currently loaded image in the sequence
ImageType<T>	getImageType()	Returns the type of class used to store the output image
int	getWidth()	Returns the width of the current image
boolean	hasNext()	If a new image is available.
static void	main(String[] args)
T	next()	Steps to the next image in the sequence and loads it.
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

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

Constructor Details

ImageStreamSequence

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

ImageStreamSequence

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

Throws:

FileNotFoundException

Method Details

getWidth

public int getWidth()

Description copied from interface: SimpleImageSequence

Returns the width of the current image

Specified by:

getWidth in interface SimpleImageSequence<T extends ImageBase<T>>

getHeight

public int getHeight()

Description copied from interface: SimpleImageSequence

Returns the height of the current image

Specified by:

getHeight in interface SimpleImageSequence<T extends ImageBase<T>>

hasNext

public boolean hasNext()

Description copied from interface: SimpleImageSequence

If a new image is available.

Specified by:

hasNext in interface SimpleImageSequence<T extends ImageBase<T>>

Returns:

true if a new image is available.

next

public T next()

Description copied from interface: SimpleImageSequence

Steps to the next image in the sequence and loads it.

Specified by:

next in interface SimpleImageSequence<T extends ImageBase<T>>

Returns:

The next image in the sequence, which is now the current image.

getImage

public T getImage()

Description copied from interface: SimpleImageSequence

Returns the currently loaded image in the sequence

Specified by:

getImage in interface SimpleImageSequence<T extends ImageBase<T>>

getGuiImage

public 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<T>>

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<T>>

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<T>>

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<T>>

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<T>>

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<T>>

main

public static void main(String[] args)
                 throws FileNotFoundException

Throws:

FileNotFoundException