org.openimaj.image.processing.face.detection

Class HaarCascadeDetector

java.lang.Object

org.openimaj.image.processing.face.detection.HaarCascadeDetector

All Implemented Interfaces:

FaceDetector<DetectedFace,FImage>, ReadableBinary, ReadWriteableBinary, WriteableBinary

@Reference(type=Inproceedings,
           author={"Viola, P.","Jones, M."},
           title="Rapid object detection using a boosted cascade of simple features",
           year="2001",
           booktitle="Computer Vision and Pattern Recognition, 2001. CVPR 2001. Proceedings of the 2001 IEEE Computer Society Conference on",
           pages={" I","511 "," I","518 vol.1"},
           number="",
           volume="1",
           customData={"keywords"," AdaBoost; background regions; boosted simple feature cascade; classifiers; face detection; image processing; image representation; integral image; machine learning; object specific focus-of-attention mechanism; rapid object detection; real-time applications; statistical guarantees; visual object detection; feature extraction; image classification; image representation; learning (artificial intelligence); object detection;","doi","10.1109/CVPR.2001.990517","ISSN","1063-6919 "})
public class HaarCascadeDetector
extends Object
implements FaceDetector<DetectedFace,FImage>

A face detector based on a Haar cascade. The cascades provided by HaarCascadeDetector.BuiltInCascade are the same as those available in OpenCV.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HaarCascadeDetector.BuiltInCascade The set of pre-trained cascades from OpenCV.

Field Summary

Fields

Modifier and Type	Field and Description
protected Detector	detector
protected DetectionFilter<Rectangle,ObjectIntPair<Rectangle>>	groupingFilter
protected boolean	histogramEqualize

Constructor Summary

Constructors

Constructor and Description
HaarCascadeDetector() Construct with the HaarCascadeDetector.BuiltInCascade.frontalface_default cascade.
HaarCascadeDetector(int minSize) Construct with the HaarCascadeDetector.BuiltInCascade.frontalface_default cascade and the given minimum search window size.
HaarCascadeDetector(String cas) Construct with the given cascade resource.
HaarCascadeDetector(String cas, int minSize) Construct with the given cascade resource and the given minimum search window size.

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
List<DetectedFace>	detectFaces(FImage image) Detect faces in the image and return a list of faces found.
StageTreeClassifier	getCascade()
Detector	getDetector()
DetectionFilter<Rectangle,ObjectIntPair<Rectangle>>	getGroupingFilter()
int	getMaxSize()
int	getMinSize()
double	getScaleFactor()
int	hashCode()
static HaarCascadeDetector	read(InputStream is) Deserialize the detector from a stream.
void	readBinary(DataInput in) Read internal state from in.
void	save(OutputStream os) Serialize the detector using java serialization to the given stream
void	setCascade(String cascadeResource) Set the cascade classifier for this detector.
void	setGroupingFilter(DetectionFilter<Rectangle,ObjectIntPair<Rectangle>> grouping) Set the filter for merging detections
void	setMaxSize(int size) Set the maximum detection window size
void	setMinSize(int size) Set the minimum detection window size
void	setScale(float scaleFactor) Set the detector scale factor
String	toString()
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

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

Field Detail

detector

protected Detector detector

groupingFilter

protected DetectionFilter<Rectangle,ObjectIntPair<Rectangle>> groupingFilter

histogramEqualize

protected boolean histogramEqualize

Constructor Detail

HaarCascadeDetector

public HaarCascadeDetector(String cas)

Construct with the given cascade resource. See setCascade(String) to understand how the cascade is loaded.

Parameters:

cas - The cascade resource.

See Also:

setCascade(String)

HaarCascadeDetector

public HaarCascadeDetector()

Construct with the HaarCascadeDetector.BuiltInCascade.frontalface_default cascade.

HaarCascadeDetector

public HaarCascadeDetector(int minSize)

Construct with the HaarCascadeDetector.BuiltInCascade.frontalface_default cascade and the given minimum search window size.

Parameters:

minSize - minimum search window size

HaarCascadeDetector

public HaarCascadeDetector(String cas,
                           int minSize)

Construct with the given cascade resource and the given minimum search window size. See setCascade(String) to understand how the cascade is loaded.

Parameters:

cas - The cascade resource.

minSize - minimum search window size.

See Also:

setCascade(String)

Method Detail

getMinSize

public int getMinSize()

Returns:

The minimum detection window size

setMinSize

public void setMinSize(int size)

Set the minimum detection window size

Parameters:

size - the window size

getMaxSize

public int getMaxSize()

Returns:

The maximum detection window size

setMaxSize

public void setMaxSize(int size)

Set the maximum detection window size

Parameters:

size - the window size

getGroupingFilter

public DetectionFilter<Rectangle,ObjectIntPair<Rectangle>> getGroupingFilter()

Returns:

The grouping filter

setGroupingFilter

public void setGroupingFilter(DetectionFilter<Rectangle,ObjectIntPair<Rectangle>> grouping)

Set the filter for merging detections

Parameters:

grouping -

detectFaces

public List<DetectedFace> detectFaces(FImage image)

Description copied from interface: FaceDetector

Detect faces in the image and return a list of faces found.

Specified by:

detectFaces in interface FaceDetector<DetectedFace,FImage>

Parameters:

image - Image to search in

Returns:

List of detected faces.

getScaleFactor

public double getScaleFactor()

Returns:

The detector scale factor

See Also:

Detector.getScaleFactor()

setCascade

public void setCascade(String cascadeResource)
                throws Exception

Set the cascade classifier for this detector. The cascade file is first searched for as a java resource, and if it is not found then a it is assumed to be a file on the filesystem.

Parameters:

cascadeResource - The cascade to load.

Throws:

Exception - if there is a problem loading the cascade.

setScale

public void setScale(float scaleFactor)

Set the detector scale factor

Parameters:

scaleFactor - the scale factor

See Also:

Detector.setScaleFactor(float)

save

public void save(OutputStream os)
          throws IOException

Serialize the detector using java serialization to the given stream

Parameters:

os - the stream

Throws:

IOException

read

public static HaarCascadeDetector read(InputStream is)
                                throws IOException,
                                       ClassNotFoundException

Deserialize the detector from a stream. The detector must have been written with a previous invokation of save(OutputStream).

Parameters:

is -

Returns:

HaarCascadeDetector read from stream.

Throws:

IOException

ClassNotFoundException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

toString

public String toString()

Overrides:

toString in class Object

getCascade

public StageTreeClassifier getCascade()

Returns:

the underlying Haar cascade.

getDetector

public Detector getDetector()

Returns:

the underlying Detector.