eu.id3.face

Class TrackedFaceList

java.lang.Object

eu.id3.face.TrackedFaceList

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.lang.Iterable<TrackedFace>

public class TrackedFaceList
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<TrackedFace>

Represents a list of tracked faces.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TrackedFaceList() Creates a new instance of the TrackedFaceList class.
TrackedFaceList(long handle) Creates a new instance of the TrackedFaceList class.

Method Summary

Modifier and Type	Method and Description
void	add(TrackedFace trackedFaceItem) Adds an item to the TrackedFaceList object.
void	clear() Clears the TrackedFaceList object.
TrackedFaceList	clone() Creates a copy of the TrackedFaceList object.
void	close() Releases all resources used by this TrackedFaceList.
protected void	finalize() Finalizer for this class.
TrackedFace	findTrackedFace(int id) Finds a tracked face by ID.
TrackedFace	get(int index) Gets an item of the TrackedFaceList object.
int	getCount() Gets the number of elements in the TrackedFaceList object.
long	getHandle() Gets the native handle.
int[]	getIdList() Gets the list of IDs in the list.
TrackedFace	getLargestFace() Gets the largest face in the list.
java.util.Iterator<TrackedFace>	iterator()
void	removeAt(int index) Removes an element of the TrackedFaceList object.
void	rescaleAll(float scale) Rescales all tracked faces in the list.
void	resize(int newSize) TrackedFaceList object.
void	set(int index, TrackedFace trackedFaceItem) Sets an item of the TrackedFaceList object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TrackedFaceList

public TrackedFaceList()
                throws FaceException

Creates a new instance of the TrackedFaceList class.

Throws:

FaceException - An error has occurred during Face Library execution.

TrackedFaceList

public TrackedFaceList(long handle)
                throws FaceException

Creates a new instance of the TrackedFaceList class.

Parameters:

handle - Handle to the TrackedFaceList.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this TrackedFaceList.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

clone

public TrackedFaceList clone()
                      throws FaceException

Creates a copy of the TrackedFaceList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created TrackedFaceList object.

Throws:

FaceException - An error has occurred during Face Library execution.

clear

public void clear()
           throws FaceException

Clears the TrackedFaceList object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(TrackedFace trackedFaceItem)
         throws FaceException

Adds an item to the TrackedFaceList object.

Parameters:

trackedFaceItem - TrackedFace item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public TrackedFace get(int index)
                throws FaceException

Gets an item of the TrackedFaceList object.

Parameters:

index - Index of the TrackedFace item to get.

Returns:

TrackedFace item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(int index,
                TrackedFace trackedFaceItem)
         throws FaceException

Sets an item of the TrackedFaceList object.

Parameters:

index - Index of the TrackedFace item to set.

trackedFaceItem - TrackedFace item to set.

Throws:

FaceException - An error has occurred during Face Library execution.

getCount

public int getCount()
             throws FaceException

Gets the number of elements in the TrackedFaceList object.

Returns:

Number of elements in the TrackedFace object.

Throws:

FaceException - An error has occurred during Face Library execution.

removeAt

public void removeAt(int index)
              throws FaceException

Removes an element of the TrackedFaceList object.

Parameters:

index - Index of the TrackedFace item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

resize

public void resize(int newSize)
            throws FaceException

TrackedFaceList object.

Parameters:

newSize - TrackedFace object.

Throws:

FaceException - An error has occurred during Face Library execution.

findTrackedFace

public TrackedFace findTrackedFace(int id)
                            throws FaceException

Finds a tracked face by ID.

Parameters:

id - ID of the tracked face to find in the list.

Returns:

The found tracked face.

Throws:

FaceException - An error has occurred during Face Library execution.

getIdList

public int[] getIdList()
                throws FaceException

Gets the list of IDs in the list.

Returns:

The list of IDs in the list.

Throws:

FaceException - An error has occurred during Face Library execution.

getLargestFace

public TrackedFace getLargestFace()
                           throws FaceException

Gets the largest face in the list.

Returns:

The largest tracked face in the list.

Throws:

FaceException - An error has occurred during Face Library execution.

rescaleAll

public void rescaleAll(float scale)
                throws FaceException

Rescales all tracked faces in the list.

Parameters:

scale - Scale factor to apply. Range is [0;+inf[.

Throws:

FaceException - An error has occurred during Face Library execution.

iterator

public java.util.Iterator<TrackedFace> iterator()

Specified by:

iterator in interface java.lang.Iterable<TrackedFace>