photoprism/internal/classify/label.go

package classify

import (
	"strings"

	"github.com/photoprism/photoprism/internal/face"

	"github.com/photoprism/photoprism/pkg/txt"
)

// Label represents a MediaFile label (automatically created).
type Label struct {
	Name        string   `json:"label"`       // Label name
	Source      string   `json:"source"`      // Where was this label found / detected?
	Uncertainty int      `json:"uncertainty"` // >= 0
	Priority    int      `json:"priority"`    // >= 0
	Categories  []string `json:"categories"`  // List of similar labels
}

// LocationLabel returns a new location label.
func LocationLabel(name string, uncertainty int) Label {
	priority := -1

	if index := strings.Index(name, " / "); index > 1 {
		name = name[:index]
	}

	if index := strings.Index(name, " - "); index > 1 {
		name = name[:index]
	}

	var categories []string

	if rule, ok := rules.Find(name); ok {
		priority = rule.Priority
		categories = rule.Categories
	}

	return Label{
		Name:        name,
		Source:      SrcLocation,
		Uncertainty: uncertainty,
		Priority:    priority,
		Categories:  categories,
	}
}

// Title returns a formatted label title as string.
func (l Label) Title() string {
	return txt.Title(txt.Clip(l.Name, txt.ClipDefault))
}

// FaceLabels returns matching labels if there are people in the image.
func FaceLabels(faces face.Faces, src string) Labels {
	var r LabelRule

	count := faces.Count()

	if count < 1 {
		return Labels{}
	} else if count == 1 {
		r = rules["portrait"]
	} else {
		r = rules["people"]
	}

	return Labels{Label{
		Name:        r.Label,
		Source:      src,
		Uncertainty: faces.Uncertainty(),
		Priority:    r.Priority,
		Categories:  r.Categories,
	}}
}