RPJosh
/
memories
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

controller: add docs to people utils 

Signed-off-by: Varun Patil <varunpatil@ucla.edu>
pull/563/head
Varun Patil 2023-03-22 17:50:36 -07:00
parent 473eb0a17e
commit b55c0b3950
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
lib/Controller/PeopleControllerUtils.php
View File

@ -25,6 +25,20 @@ namespace OCA\Memories\Controller;
trait PeopleControllerUtils
{
/**
* Sort a list of faces by the score.
*
* Needs the following fields:
* - x: x position of the face in the image (percentage)
* - y: y position of the face in the image (percentage)
* - width: width of the face in the image (percentage)
* - height: height of the face in the image (percentage)
* - image_width: width of the image in pixels
* - image_height: height of the image in pixels
* - fileid: file id of the image (unused, converted to int)
*
* A score is calculated for each face, and the list is sorted by that score.
*/
private function sortByScores(array &$list): void
{
// Score the face detections
@ -63,8 +77,15 @@ trait PeopleControllerUtils
/**
* Crop the preview to the face.
*
* @param \OCP\Files\SimpleFS\ISimpleFile $file
* @param array $object The face object
* Needs the following fields:
* - x: x position of the face in the image (percentage)
* - y: y position of the face in the image (percentage)
* - width: width of the face in the image (percentage)
* - height: height of the face in the image (percentage)
*
* @param \OCP\Files\SimpleFS\ISimpleFile $file Actual file containing the image
* @param array $object The face object
* @param float $padding The padding to add around the face
*
* @return [Blob, mimetype] of resulting image
*