eu.id3.face

Class DetectedFaceList

java.lang.Object

eu.id3.face.DetectedFaceList

All Implemented Interfaces:

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

public class DetectedFaceList
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable, java.lang.Iterable<DetectedFace>

Represents a list of detected faces.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

DetectedFaceList

public DetectedFaceList()
                 throws FaceException

Creates a new instance of the DetectedFaceList class.

Throws:

FaceException - An error has occurred during Face Library execution.

DetectedFaceList

public DetectedFaceList(long handle)
                 throws FaceException

Creates a new instance of the DetectedFaceList class.

Parameters:

handle - Handle to the DetectedFaceList.

Throws:

FaceException - An error has occurred during Face Library execution.

Method Detail

close

public void close()

Releases all resources used by this DetectedFaceList.

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 DetectedFaceList clone()
                       throws FaceException

Creates a copy of the DetectedFaceList object.

Overrides:

clone in class java.lang.Object

Returns:

The newly created DetectedFaceList object.

Throws:

FaceException - An error has occurred during Face Library execution.

clear

public void clear()
           throws FaceException

Clears the DetectedFaceList object.

Throws:

FaceException - An error has occurred during Face Library execution.

add

public void add(DetectedFace detectedFaceItem)
         throws FaceException

Adds an item to the DetectedFaceList object.

Parameters:

detectedFaceItem - DetectedFace item to add.

Throws:

FaceException - An error has occurred during Face Library execution.

get

public DetectedFace get(int index)
                 throws FaceException

Gets an item of the DetectedFaceList object.

Parameters:

index - Index of the DetectedFace item to get.

Returns:

DetectedFace item to get.

Throws:

FaceException - An error has occurred during Face Library execution.

set

public void set(int index,
                DetectedFace detectedFaceItem)
         throws FaceException

Sets an item of the DetectedFaceList object.

Parameters:

index - Index of the DetectedFace item to set.

detectedFaceItem - DetectedFace 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 DetectedFaceList object.

Returns:

Number of elements in the DetectedFace object.

Throws:

FaceException - An error has occurred during Face Library execution.

removeAt

public void removeAt(int index)
              throws FaceException

Removes an element of the DetectedFaceList object.

Parameters:

index - Index of the DetectedFace item to remove.

Throws:

FaceException - An error has occurred during Face Library execution.

resize

public void resize(int newSize)
            throws FaceException

DetectedFaceList object.

Parameters:

newSize - DetectedFace object.

Throws:

FaceException - An error has occurred during Face Library execution.

findDetectedFace

public DetectedFace findDetectedFace(int id)
                              throws FaceException

Finds a detected face by ID.

Parameters:

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

Returns:

The found detected 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 DetectedFace getLargestFace()
                            throws FaceException

Gets the largest face in the list.

Returns:

The largest detected face in the list.

Throws:

FaceException - An error has occurred during Face Library execution.

rescaleAll

public void rescaleAll(float scale)
                throws FaceException

Rescales all detected 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<DetectedFace> iterator()

Specified by:

iterator in interface java.lang.Iterable<DetectedFace>