CLMDetectedFace (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- org.openimaj.image.processing.face.detection.DetectedFace
- - org.openimaj.image.processing.face.detection.CLMDetectedFace

All Implemented Interfaces:: ReadableBinary, ReadWriteableBinary, WriteableBinary

@Reference(type=Inproceedings,
           author={"Jason M. Saragih","Simon Lucey","Jeffrey F. Cohn"},
           title="Face alignment through subspace constrained mean-shifts",
           year="2009",
           booktitle="IEEE 12th International Conference on Computer Vision, ICCV 2009, Kyoto, Japan, September 27 - October 4, 2009",
           pages={"1034","1041"},
           publisher="IEEE",
           customData={"doi","http://dx.doi.org/10.1109/ICCV.2009.5459377","researchr","http://researchr.org/publication/SaragihLC09","cites","0","citedby","0"})
public class CLMDetectedFace
extends DetectedFace

A constrained local model detected face. In addition to the patch and detection rectangle, also provides the shape matrix (describing the 2D point positions in the patch image), and the weight vectors for the model pose (relative to the detection image) and shape.

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

Field Summary
- Fields inherited from class org.openimaj.image.processing.face.detection.DetectedFace
  bounds, confidence, facePatch

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CLMDetectedFace()`
	`CLMDetectedFace(MultiTracker.TrackedFace face, FImage image)` Construct a `CLMDetectedFace` by copying the state from a `MultiTracker.TrackedFace`
	`CLMDetectedFace(Rectangle bounds, Jama.Matrix shape, Jama.Matrix poseParameters, Jama.Matrix shapeParameters, Jama.Matrix visibility, FImage fullImage)` Construct with the given bounds, shape and pose parameters and detection image.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`binaryHeader()` Header for binary input.
`MultiTracker.TrackedFace`	`convert()` Helper method that converts this `CLMDetectedFace` into a `MultiTracker.TrackedFace`.
`static List<CLMDetectedFace>`	`convert(List<MultiTracker.TrackedFace> faces, FImage image)` Helper method to convert a list of `MultiTracker.TrackedFace`s to `CLMDetectedFace`s.
`static List<CLMDetectedFace>`	`convert(List<MultiTracker.TrackedFace> faces, MBFImage image)` Helper method to convert a list of `MultiTracker.TrackedFace`s to `CLMDetectedFace`s.
`double`	`getPitch()` Returns the pitch of the model (that is the look up/down, noddy head movement).
`DoubleFV`	`getPoseParameters()` Get the parameters describing the pose of the face.
`DoubleFV`	`getPoseShapeParameters()` Get a vector describing the pose (pitch, yaw and roll only) and shape of the model.
`double`	`getRoll()` Returns the roll of the model (that is the spinning, standy on the head movement)
`double`	`getScale()` Returns the scale (size) of the face
`Jama.Matrix`	`getShapeMatrix()` Get the matrix of points describing the model.
`DoubleFV`	`getShapeParameters()` Get the parameters describing the shape model (i.e.
`double`	`getTranslationX()` Returns the x-translation in the model
`double`	`getTranslationY()` Returns the y-translation in the model
`Jama.Matrix`	`getVisibility()` Get the visibility matrix
`double`	`getYaw()` Returns the yaw of the face (that is the side-to-side, shakey head movement).
`void`	`readBinary(DataInput in)` Read internal state from in.
`void`	`writeBinary(DataOutput out)` Write the content of this as binary to out.

Methods inherited from class org.openimaj.image.processing.face.detection.DetectedFace
getBounds, getConfidence, getFacePatch, getShape, setBounds, setConfidence, setFacePatch

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CLMDetectedFace
```
protected CLMDetectedFace()
```
  - CLMDetectedFace
```
public CLMDetectedFace(MultiTracker.TrackedFace face,
                       FImage image)
```
    Construct a CLMDetectedFace by copying the state from a MultiTracker.TrackedFace
    
    Parameters:
    
    face - the MultiTracker.TrackedFace
    
    image - the image in which the tracked face was detected
  - CLMDetectedFace
```
public CLMDetectedFace(Rectangle bounds,
                       Jama.Matrix shape,
                       Jama.Matrix poseParameters,
                       Jama.Matrix shapeParameters,
                       Jama.Matrix visibility,
                       FImage fullImage)
```
    Construct with the given bounds, shape and pose parameters and detection image. The face patch is extracted automatically.
    
    Parameters:
    
    bounds -
    
    shape -
    
    poseParameters -
    
    shapeParameters -
    
    visibility -
    
    fullImage -
- Method Detail
  - convert
```
public static List<CLMDetectedFace> convert(List<MultiTracker.TrackedFace> faces,
                                            MBFImage image)
```
    Helper method to convert a list of MultiTracker.TrackedFaces to CLMDetectedFaces.
    
    Parameters:
    
    faces - the MultiTracker.TrackedFaces.
    
    image - the image the MultiTracker.TrackedFaces came from.
    
    Returns:
    
    the list of CLMDetectedFaces
  - convert
```
public static List<CLMDetectedFace> convert(List<MultiTracker.TrackedFace> faces,
                                            FImage image)
```
    Helper method to convert a list of MultiTracker.TrackedFaces to CLMDetectedFaces.
    
    Parameters:
    
    faces - the MultiTracker.TrackedFaces.
    
    image - the image the MultiTracker.TrackedFaces came from.
    
    Returns:
    
    the list of CLMDetectedFaces
  - convert
```
public MultiTracker.TrackedFace convert()
```
    Helper method that converts this CLMDetectedFace into a MultiTracker.TrackedFace.
    
    Returns:
    
    A MultiTracker.TrackedFace
  - 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
    
    Overrides:
    
    writeBinary in class DetectedFace
    
    Parameters:
    
    out - sink to write to
    
    Throws:
    
    IOException - an error writing to out
  - 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
    
    Overrides:
    
    binaryHeader in class DetectedFace
    
    Returns:
    
    header
  - readBinary
```
public void readBinary(DataInput in)
                throws IOException
```
    Description copied from interface: ReadableBinary
    
    Read internal state from in.
    
    Specified by:
    
    readBinary in interface ReadableBinary
    
    Overrides:
    
    readBinary in class DetectedFace
    
    Parameters:
    
    in - source to read from.
    
    Throws:
    
    IOException - an error reading input
  - getScale
```
public double getScale()
```
    Returns the scale (size) of the face
    
    Returns:
    
    the scale of the model
  - getPitch
```
public double getPitch()
```
    Returns the pitch of the model (that is the look up/down, noddy head movement).
    
    Returns:
    
    the pitch of the model
  - getYaw
```
public double getYaw()
```
    Returns the yaw of the face (that is the side-to-side, shakey head movement).
    
    Returns:
    
    the yaw of the model
  - getRoll
```
public double getRoll()
```
    Returns the roll of the model (that is the spinning, standy on the head movement)
    
    Returns:
    
    the roll of the model
  - getTranslationX
```
public double getTranslationX()
```
    Returns the x-translation in the model
    
    Returns:
    
    the x-translation of the model
  - getTranslationY
```
public double getTranslationY()
```
    Returns the y-translation in the model
    
    Returns:
    
    the y-translation of the model
  - getPoseParameters
```
public DoubleFV getPoseParameters()
```
    Get the parameters describing the pose of the face. This doesn't include the translation or scale. The values are {pitch, yaw, roll}
    
    Returns:
    
    the pose parameters
  - getShapeParameters
```
public DoubleFV getShapeParameters()
```
    Get the parameters describing the shape model (i.e. the weights for the eigenvectors of the point distribution model)
    
    Returns:
    
    the shape parameters
  - getPoseShapeParameters
```
public DoubleFV getPoseShapeParameters()
```
    Get a vector describing the pose (pitch, yaw and roll only) and shape of the model.
    
    Returns:
    
    the combined pose and shape vector
  - getShapeMatrix
```
public Jama.Matrix getShapeMatrix()
```
    Get the matrix of points describing the model. The points are relative to the image given by DetectedFace.getFacePatch().
    
    Returns:
    
    the shape matrix
  - getVisibility
```
public Jama.Matrix getVisibility()
```
    Get the visibility matrix
    
    Returns:
    
    the visibility matrix

Class CLMDetectedFace

Field Summary

Fields inherited from class org.openimaj.image.processing.face.detection.DetectedFace

Constructor Summary

Method Summary

Methods inherited from class org.openimaj.image.processing.face.detection.DetectedFace

Methods inherited from class java.lang.Object

Constructor Detail

CLMDetectedFace

CLMDetectedFace

CLMDetectedFace

Method Detail

convert

convert

convert

writeBinary

binaryHeader

readBinary

getScale

getPitch

getYaw

getRoll

getTranslationX

getTranslationY

getPoseParameters

getShapeParameters

getPoseShapeParameters

getShapeMatrix

getVisibility