class VideoAnnotation extends Annotation

Traits

Properties

int $shape_id

Shape ID required for point validation.

from  Annotation

Methods

validatePoints(array $points = [])

Similar to \Biigle\VideoAnnotation::validatePoints.

validateCoordinatesAreNumeric(array $points)

Valies that all coordinates are either int or float

validateNumberOfCoordinates(array $points)

Validates that the number of coordinates matches the required number for the given shape

validateNumberOfPoints(array $points)

Validates that the number of points (sequential coordinate pairs) matches the expected number of points for the given shape

validateShape(array $points)

Validates some edgecases where the given points don't create a valid shape

setPointsAttribute(array $points)

Round the floats of the points array to 2 decimals before saving.

int
countDistinctPoints(array $points)

Counts number of distinct points

__construct(Shape $shape, array $points, array $labels, array $frames)

No description

array
getInsertData(int $id)

Get the array of metadata that can be used for Model::insert();

void
validate()

Validate the points and labels.

Details

at line 54
validatePoints(array $points = [])

Similar to \Biigle\VideoAnnotation::validatePoints.

Parameters

array $points

Points array like [x1, y1, x2, y2, x3, y3, ...]

in HasPointsAttribute at line 31
protected validateCoordinatesAreNumeric(array $points)

Valies that all coordinates are either int or float

Parameters

array $points

Exceptions

InvalidCoordinateTypeException

in HasPointsAttribute at line 44
protected validateNumberOfCoordinates(array $points)

Validates that the number of coordinates matches the required number for the given shape

Parameters

array $points

Exceptions

InvalidNumberOfCoordinatesException

in HasPointsAttribute at line 69
protected validateNumberOfPoints(array $points)

Validates that the number of points (sequential coordinate pairs) matches the expected number of points for the given shape

Parameters

array $points

Exceptions

InvalidNumberOfPointsException

in HasPointsAttribute at line 102
protected validateShape(array $points)

Validates some edgecases where the given points don't create a valid shape

Parameters

array $points

Exceptions

InvalidShapeException

in HasPointsAttribute at line 143
setPointsAttribute(array $points)

Round the floats of the points array to 2 decimals before saving.

This is a more than sufficient precision for annotation point coordinates and saves memory in the DB as well as when processing the annotations in PHP.

Parameters

array $points

in HasPointsAttribute at line 154
protected int countDistinctPoints(array $points)

Counts number of distinct points

Parameters

array $points

Return Value

int

number of distinct points *

at line 16
__construct(Shape $shape, array $points, array $labels, array $frames)

No description

Parameters

Shape $shape
array $points
array $labels
array $frames

at line 28
array getInsertData(int $id)

Get the array of metadata that can be used for Model::insert();

Parameters

int $id

ID of the image/video database model.

Return Value

array

at line 39
void validate()

Validate the points and labels.

Return Value

void

Exceptions

Exception