Search
Preparing search index...
The search index is not available
face-api.js
Options
All
Public
Public/Protected
All
Inherited
Menu
Globals
PredictedBox
Class PredictedBox
Hierarchy
LabeledBox
PredictedBox
Implements
IBoundingBox
IRect
Index
Constructors
constructor
Accessors
area
bottom
class
Score
height
label
left
right
score
top
width
x
y
Methods
calibrate
clip
AtImage
Borders
floor
pad
pad
AtBorders
rescale
round
shift
to
Square
assert
IsValid
Box
assert
IsValid
Labeled
Box
assert
IsValid
Predicted
Box
is
Rect
Constructors
constructor
new
Predicted
Box
(
box
:
IBoundingBox
|
IRect
|
any
, label
:
number
, score
:
number
, classScore
:
number
)
:
PredictedBox
Parameters
box:
IBoundingBox
|
IRect
|
any
label:
number
score:
number
classScore:
number
Returns
PredictedBox
Accessors
area
get
area
(
)
:
number
Returns
number
bottom
get
bottom
(
)
:
number
Returns
number
class
Score
get
classScore
(
)
:
number
Returns
number
height
get
height
(
)
:
number
Returns
number
label
get
label
(
)
:
number
Returns
number
left
get
left
(
)
:
number
Returns
number
right
get
right
(
)
:
number
Returns
number
score
get
score
(
)
:
number
Returns
number
top
get
top
(
)
:
number
Returns
number
width
get
width
(
)
:
number
Returns
number
x
get
x
(
)
:
number
Returns
number
y
get
y
(
)
:
number
Returns
number
Methods
calibrate
calibrate
(
region
:
Box
)
:
Box
<
any
>
Parameters
region:
Box
Returns
Box
<
any
>
clip
AtImage
Borders
clip
AtImage
Borders
(
imgWidth
:
number
, imgHeight
:
number
)
:
Box
<
LabeledBox
>
Parameters
imgWidth:
number
imgHeight:
number
Returns
Box
<
LabeledBox
>
floor
floor
(
)
:
Box
<
LabeledBox
>
Returns
Box
<
LabeledBox
>
pad
pad
(
padX
:
number
, padY
:
number
)
:
Box
<
LabeledBox
>
Parameters
padX:
number
padY:
number
Returns
Box
<
LabeledBox
>
pad
AtBorders
pad
AtBorders
(
imageHeight
:
number
, imageWidth
:
number
)
:
object
Parameters
imageHeight:
number
imageWidth:
number
Returns
object
rescale
rescale
(
s
:
IDimensions
|
number
)
:
Box
<
LabeledBox
>
Parameters
s:
IDimensions
|
number
Returns
Box
<
LabeledBox
>
round
round
(
)
:
Box
<
LabeledBox
>
Returns
Box
<
LabeledBox
>
shift
shift
(
sx
:
number
, sy
:
number
)
:
Box
<
LabeledBox
>
Parameters
sx:
number
sy:
number
Returns
Box
<
LabeledBox
>
to
Square
to
Square
(
)
:
Box
<
LabeledBox
>
Returns
Box
<
LabeledBox
>
Static
assert
IsValid
Box
assert
IsValid
Box
(
box
:
any
, callee
:
string
, allowNegativeDimensions
?:
boolean
)
:
void
Parameters
box:
any
callee:
string
Default value
allowNegativeDimensions:
boolean
= false
Returns
void
Static
assert
IsValid
Labeled
Box
assert
IsValid
Labeled
Box
(
box
:
any
, callee
:
string
)
:
void
Parameters
box:
any
callee:
string
Returns
void
Static
assert
IsValid
Predicted
Box
assert
IsValid
Predicted
Box
(
box
:
any
, callee
:
string
)
:
void
Parameters
box:
any
callee:
string
Returns
void
Static
is
Rect
is
Rect
(
rect
:
any
)
:
boolean
Parameters
rect:
any
Returns
boolean
Globals
Predicted
Box
constructor
area
bottom
class
Score
height
label
left
right
score
top
width
x
y
calibrate
clip
AtImage
Borders
floor
pad
pad
AtBorders
rescale
round
shift
to
Square
assert
IsValid
Box
assert
IsValid
Labeled
Box
assert
IsValid
Predicted
Box
is
Rect
Generated using
TypeDoc