diff --git a/API_README.md b/API_README.md index aed9d51b..b2369253 100644 --- a/API_README.md +++ b/API_README.md @@ -1626,18 +1626,6 @@ Returns list of x, y coordinates as tuples `[(x0, y0), (x1, y1)]` representing t Coordinates as (x, y) tuple for the center of the detected face. -#### `mouth` - -Coordinates as (x, y) tuple for the mouth of the detected face. - -#### `left_eye` - -Coordinates as (x, y) tuple for the left eye of the detected face. - -#### `right_eye` - -Coordinates as (x, y) tuple for the right eye of the detected face. - #### `size_pixels` Diameter of detected face region in pixels. @@ -1654,29 +1642,25 @@ Roll of face region in radians. Pitch of face region in radians. +**Note**: Only valid on Photos version <= 4, otherwise returns 0 + #### yaw Yaw of face region in radians. +**Note**: Only valid on Photos version <= 4, otherwise returns 0 + #### `Additional properties` The following additional properties are also available but are not yet fully documented. * `center_x`: x coordinate of center of face in Photos' internal reference frame * `center_y`: y coordinate of center of face in Photos' internal reference frame -* `mouth_x`: x coordinate of mouth in Photos' internal reference frame -* `mouth_y`: y coordinate of mouth in Photos' internal reference frame -* `left_eye_x`: x coordinate of left eye in Photos' internal reference frame -* `left_eye_y`: y coordinate of left eye in Photos' internal reference frame -* `right_eye_x`: x coordinate of right eye in Photos' internal reference frame -* `right_eye_y`: y coordinate of right eye in Photos' internal reference frame * `size`: size of face region in Photos' internal reference frame * `quality`: quality measure of detected face * `source_width`: width in pixels of photo * `source_height`: height in pixels of photo * `has_smile`: -* `left_eye_closed`: -* `right_eye_closed`: * `manual`: * `face_type`: * `age_type`: diff --git a/docs/_modules/osxphotos/_constants.html b/docs/_modules/osxphotos/_constants.html index 903a21e0..0a6d3def 100644 --- a/docs/_modules/osxphotos/_constants.html +++ b/docs/_modules/osxphotos/_constants.html @@ -5,7 +5,7 @@ - osxphotos._constants - osxphotos 0.48.1 documentation + osxphotos._constants - osxphotos 0.50.3 documentation @@ -123,7 +123,7 @@
-
osxphotos 0.48.1 documentation
 +
osxphotos 0.50.3 documentation
@@ -146,7 +146,7 @@
- osxphotos 0.48.1 documentation + osxphotos 0.50.3 documentation
-
osxphotos 0.50.1 documentation
 +
osxphotos 0.50.3 documentation
@@ -146,7 +146,7 @@
- osxphotos 0.50.1 documentation + osxphotos 0.50.3 documentation @@ -1076,7 +1076,7 @@ self.close() -class ExportDBTemp(ExportDBInMemory): +
[docs]class ExportDBTemp(ExportDBInMemory): """Temporary in-memory version of ExportDB""" def __init__(self): @@ -1091,7 +1091,7 @@ filepath = str(filepath) if filepath[0] == "/": return filepath[1:] - return filepath + return filepath
class ExportRecord: diff --git a/docs/_modules/osxphotos/personinfo.html b/docs/_modules/osxphotos/personinfo.html index 8b830b11..58f5b5af 100644 --- a/docs/_modules/osxphotos/personinfo.html +++ b/docs/_modules/osxphotos/personinfo.html @@ -1,37 +1,200 @@ + + + + + - + + osxphotos.personinfo - osxphotos 0.50.3 documentation + + + + + + - - - - - osxphotos.personinfo — osxphotos 0.47.9 documentation - - - - - - - - - - + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
osxphotos 0.50.3 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+
+

Source code for osxphotos.personinfo

+""" PhotoInfo and FaceInfo classes to expose info about persons and faces in the Photos library """
 
 import json
 import logging
@@ -39,17 +202,17 @@
 
 from collections import namedtuple
 
-__all__ = ["PersonInfo", "FaceInfo", "rotate_image_point"]
+__all__ = ["PersonInfo", "FaceInfo", "rotate_image_point"]
 
-MWG_RS_Area = namedtuple("MWG_RS_Area", ["x", "y", "h", "w"])
-MPRI_Reg_Rect = namedtuple("MPRI_Reg_Rect", ["x", "y", "h", "w"])
+MWG_RS_Area = namedtuple("MWG_RS_Area", ["x", "y", "h", "w"])
+MPRI_Reg_Rect = namedtuple("MPRI_Reg_Rect", ["x", "y", "h", "w"])
 
 
 
[docs]class PersonInfo:
-    """Info about a person in the Photos library"""
+    """Info about a person in the Photos library"""
 
     def __init__(self, db=None, pk=None):
-        """Creates a new PersonInfo instance
+        """Creates a new PersonInfo instance
 
         Arguments:
             db: instance of PhotosDB object
@@ -57,16 +220,16 @@
 
         Returns:
             PersonInfo instance
-        """
+        """
         self._db = db
         self._pk = pk
 
         person = self._db._dbpersons_pk[pk]
-        self.uuid = person["uuid"]
-        self.name = person["fullname"]
-        self.display_name = person["displayname"]
-        self.keyface = person["keyface"]
-        self.facecount = person["facecount"]
+        self.uuid = person["uuid"]
+        self.name = person["fullname"]
+        self.display_name = person["displayname"]
+        self.keyface = person["keyface"]
+        self.facecount = person["facecount"]
 
     @property
     def keyphoto(self):
@@ -74,9 +237,9 @@
             return self._keyphoto
         except AttributeError:
             person = self._db._dbpersons_pk[self._pk]
-            if person["photo_uuid"]:
+            if person["photo_uuid"]:
                 try:
-                    key_photo = self._db.get_photo(person["photo_uuid"])
+                    key_photo = self._db.get_photo(person["photo_uuid"])
                 except IndexError:
                     key_photo = None
             else:
@@ -86,14 +249,14 @@
 
     @property
     def photos(self):
-        """Returns list of PhotoInfo objects associated with this person"""
+        """Returns list of PhotoInfo objects associated with this person"""
         return self._db.photos_by_uuid(self._db._dbfaces_pk[self._pk])
 
     @property
     def face_info(self):
-        """Returns a list of FaceInfo objects associated with this person sorted by quality score
+        """Returns a list of FaceInfo objects associated with this person sorted by quality score
         Highest quality face is result[0] and lowest quality face is result[n]
-        """
+        """
         try:
             faces = self._db._db_faceinfo_person[self._pk]
             return sorted(
@@ -106,30 +269,32 @@
             return []
 
 
[docs]    def asdict(self):
-        """Returns dictionary representation of class instance"""
+        """Returns dictionary representation of class instance"""
         keyphoto = self.keyphoto.uuid if self.keyphoto is not None else None
         return {
-            "uuid": self.uuid,
-            "name": self.name,
-            "displayname": self.display_name,
-            "keyface": self.keyface,
-            "facecount": self.facecount,
-            "keyphoto": keyphoto,
+            "uuid": self.uuid,
+            "name": self.name,
+            "displayname": self.display_name,
+            "keyface": self.keyface,
+            "facecount": self.facecount,
+            "keyphoto": keyphoto,
         }

 
 
[docs]    def json(self):
-        """Returns JSON representation of class instance"""
+        """Returns JSON representation of class instance"""
         return json.dumps(self.asdict())

 
     def __str__(self):
-        return f"PersonInfo(name={self.name}, display_name={self.display_name}, uuid={self.uuid}, facecount={self.facecount})"
+        return f"PersonInfo(name={self.name}, display_name={self.display_name}, uuid={self.uuid}, facecount={self.facecount})"
 
     def __eq__(self, other):
-        if not isinstance(other, type(self)):
-            return False
-
-        return all(
-            getattr(self, field) == getattr(other, field) for field in ["_db", "_pk"]
+        return (
+            all(
+                getattr(self, field) == getattr(other, field)
+                for field in ["_db", "_pk"]
+            )
+            if isinstance(other, type(self))
+            else False
         )
 
     def __ne__(self, other):
@@ -137,10 +302,10 @@
 
 
 class FaceInfo:
-    """Info about a face in the Photos library"""
+    """Info about a face in the Photos library"""
 
     def __init__(self, db=None, pk=None):
-        """Creates a new FaceInfo instance
+        """Creates a new FaceInfo instance
 
         Arguments:
             db: instance of PhotosDB object
@@ -148,95 +313,59 @@
 
         Returns:
             FaceInfo instance
-        """
+        """
         self._db = db
         self._pk = pk
 
         face = self._db._db_faceinfo_pk[pk]
         self._info = face
-        self.uuid = face["uuid"]
-        self.name = face["fullname"]
-        self.asset_uuid = face["asset_uuid"]
-        self._person_pk = face["person"]
-        self.center_x = face["centerx"]
-        self.center_y = face["centery"]
-        self.mouth_x = face["mouthx"]
-        self.mouth_y = face["mouthy"]
-        self.left_eye_x = face["lefteyex"]
-        self.left_eye_y = face["lefteyey"]
-        self.right_eye_x = face["righteyex"]
-        self.right_eye_y = face["righteyey"]
-        self.size = face["size"]
-        self.quality = face["quality"]
-        self.source_width = face["sourcewidth"]
-        self.source_height = face["sourceheight"]
-        self.has_smile = face["has_smile"]
-        self.left_eye_closed = face["left_eye_closed"]
-        self.right_eye_closed = face["right_eye_closed"]
-        self.manual = face["manual"]
-        self.face_type = face["facetype"]
-        self.age_type = face["agetype"]
-        # self.bald_type = face["baldtype"]
-        self.eye_makeup_type = face["eyemakeuptype"]
-        self.eye_state = face["eyestate"]
-        self.facial_hair_type = face["facialhairtype"]
-        self.gender_type = face["gendertype"]
-        self.glasses_type = face["glassestype"]
-        self.hair_color_type = face["haircolortype"]
-        self.intrash = face["intrash"]
-        self.lip_makeup_type = face["lipmakeuptype"]
-        self.smile_type = face["smiletype"]
+        self.uuid = face["uuid"]
+        self.name = face["fullname"]
+        self.asset_uuid = face["asset_uuid"]
+        self._person_pk = face["person"]
+        self.center_x = face["centerx"]
+        self.center_y = face["centery"]
+        self.size = face["size"]
+        self.quality = face["quality"]
+        self.source_width = face["sourcewidth"]
+        self.source_height = face["sourceheight"]
+        self.has_smile = face["has_smile"]
+        self.manual = face["manual"]
+        self.face_type = face["facetype"]
+        self.age_type = face["agetype"]
+        self.eye_makeup_type = face["eyemakeuptype"]
+        self.eye_state = face["eyestate"]
+        self.facial_hair_type = face["facialhairtype"]
+        self.gender_type = face["gendertype"]
+        self.glasses_type = face["glassestype"]
+        self.hair_color_type = face["haircolortype"]
+        self.intrash = face["intrash"]
+        self.lip_makeup_type = face["lipmakeuptype"]
+        self.smile_type = face["smiletype"]
 
     @property
     def center(self):
-        """Coordinates, in PIL format, for center of face
+        """Coordinates, in PIL format, for center of face
 
         Returns:
             tuple of coordinates in form (x, y)
-        """
+        """
         return self._make_point((self.center_x, self.center_y))
 
     @property
     def size_pixels(self):
-        """Size of face in pixels (centered around center_x, center_y)
+        """Size of face in pixels (centered around center_x, center_y)
 
         Returns:
             size, in int pixels, of a circle drawn around the center of the face
-        """
+        """
         photo = self.photo
         size_reference = photo.width if photo.width > photo.height else photo.height
         return self.size * size_reference
 
-    @property
-    def mouth(self):
-        """Coordinates, in PIL format, for mouth position
-
-        Returns:
-            tuple of coordinates in form (x, y)
-        """
-        return self._make_point_with_rotation((self.mouth_x, self.mouth_y))
-
-    @property
-    def left_eye(self):
-        """Coordinates, in PIL format, for left eye position
-
-        Returns:
-            tuple of coordinates in form (x, y)
-        """
-        return self._make_point_with_rotation((self.left_eye_x, self.left_eye_y))
-
-    @property
-    def right_eye(self):
-        """Coordinates, in PIL format, for right eye position
-
-        Returns:
-            tuple of coordinates in form (x, y)
-        """
-        return self._make_point_with_rotation((self.right_eye_x, self.right_eye_y))
-
     @property
     def person_info(self):
-        """PersonInfo instance for person associated with this face"""
+        """PersonInfo instance for person associated with this face"""
         try:
             return self._person
         except AttributeError:
@@ -245,18 +374,18 @@
 
     @property
     def photo(self):
-        """PhotoInfo instance associated with this face"""
+        """PhotoInfo instance associated with this face"""
         try:
             return self._photo
         except AttributeError:
             self._photo = self._db.get_photo(self.asset_uuid)
             if self._photo is None:
-                logging.warning(f"Could not get photo for uuid: {self.asset_uuid}")
+                logging.warning(f"Could not get photo for uuid: {self.asset_uuid}")
             return self._photo
 
     @property
     def mwg_rs_area(self):
-        """Get coordinates for Metadata Working Group Region Area.
+        """Get coordinates for Metadata Working Group Region Area.
 
         Returns:
             MWG_RS_Area named tuple with x, y, h, w where:
@@ -267,7 +396,7 @@
 
         Reference:
             https://photo.stackexchange.com/questions/106410/how-does-xmp-define-the-face-region
-        """
+        """
         x, y = self.center_x, self.center_y
         x, y = self._fix_orientation((x, y))
 
@@ -282,7 +411,7 @@
 
     @property
     def mpri_reg_rect(self):
-        """Get coordinates for Microsoft Photo Region Rectangle.
+        """Get coordinates for Microsoft Photo Region Rectangle.
 
         Returns:
             MPRI_Reg_Rect named tuple with x, y, h, w where:
@@ -293,7 +422,7 @@
 
         Reference:
             https://docs.microsoft.com/en-us/windows/win32/wic/-wic-people-tagging
-        """
+        """
         x, y = self.center_x, self.center_y
         x, y = self._fix_orientation((x, y))
 
@@ -311,13 +440,13 @@
         return MPRI_Reg_Rect(x, y, h, w)
 
     def face_rect(self):
-        """Get face rectangle coordinates for current version of the associated image
+        """Get face rectangle coordinates for current version of the associated image
             If image has been edited, rectangle applies to edited version, otherwise original version
             Coordinates in format and reference frame used by PIL
 
         Returns:
             list [(x0, x1), (y0, y1)] of coordinates in reference frame used by PIL
-        """
+        """
         photo = self.photo
         size_reference = photo.width if photo.width > photo.height else photo.height
         radius = (self.size / 2) * size_reference
@@ -327,34 +456,34 @@
         return [(x0, y0), (x1, y1)]
 
     def roll_pitch_yaw(self):
-        """Roll, pitch, yaw of face in radians as tuple"""
+        """Roll, pitch, yaw of face in radians as tuple"""
         info = self._info
-        roll = 0 if info["roll"] is None else info["roll"]
-        pitch = 0 if info["pitch"] is None else info["pitch"]
-        yaw = 0 if info["yaw"] is None else info["yaw"]
+        roll = 0 if info["roll"] is None else info["roll"]
+        pitch = 0 if info["pitch"] is None else info["pitch"]
+        yaw = 0 if info["yaw"] is None else info["yaw"]
 
         return (roll, pitch, yaw)
 
     @property
     def roll(self):
-        """Return roll angle in radians of the face region"""
+        """Return roll angle in radians of the face region"""
         roll, _, _ = self.roll_pitch_yaw()
         return roll
 
     @property
     def pitch(self):
-        """Return pitch angle in radians of the face region"""
+        """Return pitch angle in radians of the face region"""
         _, pitch, _ = self.roll_pitch_yaw()
         return pitch
 
     @property
     def yaw(self):
-        """Return yaw angle in radians of the face region"""
+        """Return yaw angle in radians of the face region"""
         _, _, yaw = self.roll_pitch_yaw()
         return yaw
 
     def _fix_orientation(self, xy):
-        """Translate an (x, y) tuple based on image orientation
+        """Translate an (x, y) tuple based on image orientation
 
         Arguments:
             xy: tuple of (x, y) coordinates for point to translate
@@ -362,7 +491,7 @@
 
         Returns:
             (x, y) tuple of translated coordinates
-        """
+        """
         # Reference: https://github.com/neilpa/phace/blob/7594776480505d0c389688a42099c94ac5d34f3f/cmd/phace/draw.go#L79-L94
 
         orientation = self.photo.orientation
@@ -386,15 +515,15 @@
         elif orientation == 8:
             x, y = y, x
         elif orientation == 0:
-            # set by osxphotos if adjusted orientation cannot be read, assume it's 1
+            # set by osxphotos if adjusted orientation cannot be read, assume it's 1
             y = 1.0 - y
         else:
-            logging.warning(f"Unhandled orientation: {orientation}")
+            logging.warning(f"Unhandled orientation: {orientation}")
 
         return (x, y)
 
     def _make_point(self, xy):
-        """Translate an (x, y) tuple based on image orientation
+        """Translate an (x, y) tuple based on image orientation
             and convert to image coordinates
 
         Arguments:
@@ -403,7 +532,7 @@
 
         Returns:
             (x, y) tuple of translated coordinates in pixels in PIL format/reference frame
-        """
+        """
         # Reference: https://github.com/neilpa/phace/blob/7594776480505d0c389688a42099c94ac5d34f3f/cmd/phace/draw.go#L79-L94
 
         orientation = self.photo.orientation
@@ -415,7 +544,7 @@
         return (int(x * dx), int(y * dy))
 
     def _make_point_with_rotation(self, xy):
-        """Translate an (x, y) tuple based on image orientation and rotation
+        """Translate an (x, y) tuple based on image orientation and rotation
             and convert to image coordinates
 
         Arguments:
@@ -424,7 +553,7 @@
 
         Returns:
             (x, y) tuple of translated coordinates in pixels in PIL format/reference frame
-        """
+        """
 
         # convert to image coordinates
         x, y = self._make_point(xy)
@@ -437,70 +566,58 @@
         return (int(xr), int(yr))
 
     def asdict(self):
-        """Returns dict representation of class instance"""
+        """Returns dict representation of class instance"""
         roll, pitch, yaw = self.roll_pitch_yaw()
         return {
-            "_pk": self._pk,
-            "uuid": self.uuid,
-            "name": self.name,
-            "asset_uuid": self.asset_uuid,
-            "_person_pk": self._person_pk,
-            "center_x": self.center_x,
-            "center_y": self.center_y,
-            "center": self.center,
-            "mouth_x": self.mouth_x,
-            "mouth_y": self.mouth_y,
-            "mouth": self.mouth,
-            "left_eye_x": self.left_eye_x,
-            "left_eye_y": self.left_eye_y,
-            "left_eye": self.left_eye,
-            "right_eye_x": self.right_eye_x,
-            "right_eye_y": self.right_eye_y,
-            "right_eye": self.right_eye,
-            "size": self.size,
-            "face_rect": self.face_rect(),
-            "mpri_reg_rect": self.mpri_reg_rect._asdict(),
-            "mwg_rs_area": self.mwg_rs_area._asdict(),
-            "roll": roll,
-            "pitch": pitch,
-            "yaw": yaw,
-            "quality": self.quality,
-            "source_width": self.source_width,
-            "source_height": self.source_height,
-            "has_smile": self.has_smile,
-            "left_eye_closed": self.left_eye_closed,
-            "right_eye_closed": self.right_eye_closed,
-            "manual": self.manual,
-            "face_type": self.face_type,
-            "age_type": self.age_type,
-            # "bald_type": self.bald_type,
-            "eye_makeup_type": self.eye_makeup_type,
-            "eye_state": self.eye_state,
-            "facial_hair_type": self.facial_hair_type,
-            "gender_type": self.gender_type,
-            "glasses_type": self.glasses_type,
-            "hair_color_type": self.hair_color_type,
-            "intrash": self.intrash,
-            "lip_makeup_type": self.lip_makeup_type,
-            "smile_type": self.smile_type,
+            "_pk": self._pk,
+            "uuid": self.uuid,
+            "name": self.name,
+            "asset_uuid": self.asset_uuid,
+            "_person_pk": self._person_pk,
+            "center_x": self.center_x,
+            "center_y": self.center_y,
+            "center": self.center,
+            "size": self.size,
+            "face_rect": self.face_rect(),
+            "mpri_reg_rect": self.mpri_reg_rect._asdict(),
+            "mwg_rs_area": self.mwg_rs_area._asdict(),
+            "roll": roll,
+            "pitch": pitch,
+            "yaw": yaw,
+            "quality": self.quality,
+            "source_width": self.source_width,
+            "source_height": self.source_height,
+            "has_smile": self.has_smile,
+            "manual": self.manual,
+            "face_type": self.face_type,
+            "age_type": self.age_type,
+            "eye_makeup_type": self.eye_makeup_type,
+            "eye_state": self.eye_state,
+            "facial_hair_type": self.facial_hair_type,
+            "gender_type": self.gender_type,
+            "glasses_type": self.glasses_type,
+            "hair_color_type": self.hair_color_type,
+            "intrash": self.intrash,
+            "lip_makeup_type": self.lip_makeup_type,
+            "smile_type": self.smile_type,
         }
 
     def json(self):
-        """Return JSON representation of FaceInfo instance"""
+        """Return JSON representation of FaceInfo instance"""
         return json.dumps(self.asdict())
 
     def __str__(self):
-        return f"FaceInfo(uuid={self.uuid}, center_x={self.center_x}, center_y = {self.center_y}, size={self.size}, person={self.name}, asset_uuid={self.asset_uuid})"
+        return f"FaceInfo(uuid={self.uuid}, center_x={self.center_x}, center_y = {self.center_y}, size={self.size}, person={self.name}, asset_uuid={self.asset_uuid})"
 
     def __repr__(self):
-        return f"FaceInfo(db={self._db}, pk={self._pk})"
+        return f"FaceInfo(db={self._db}, pk={self._pk})"
 
     def __eq__(self, other):
         if not isinstance(other, type(self)):
             return False
 
         return all(
-            getattr(self, field) == getattr(other, field) for field in ["_db", "_pk"]
+            getattr(self, field) == getattr(other, field) for field in ["_db", "_pk"]
         )
 
     def __ne__(self, other):
@@ -508,7 +625,7 @@
 
 
 def rotate_image_point(x, y, xmid, ymid, angle):
-    """rotate image point about xm, ym by angle in radians
+    """rotate image point about xm, ym by angle in radians
 
     Arguments:
         x: x coordinate of point to rotate
@@ -520,7 +637,7 @@
 
     Returns:
         tuple of rotated points (xr, yr)
-    """
+    """
     # translate point relative to the mid point
     x = x - xmid
     y = y - ymid
@@ -535,72 +652,45 @@
 
     return (xr, yr)
- -
+ +
+
+ +
+
-
- -
- ©2021, Rhet Turnbull. +
- - - - - + + +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_modules/osxphotos/photosdb/photosdb.html b/docs/_modules/osxphotos/photosdb/photosdb.html index 2632d435..f48da2ae 100644 --- a/docs/_modules/osxphotos/photosdb/photosdb.html +++ b/docs/_modules/osxphotos/photosdb/photosdb.html @@ -5,7 +5,7 @@ - osxphotos.photosdb.photosdb - osxphotos 0.50.0 documentation + osxphotos.photosdb.photosdb - osxphotos 0.50.3 documentation @@ -123,7 +123,7 @@
-
osxphotos 0.50.0 documentation
 +
osxphotos 0.50.3 documentation
@@ -146,7 +146,7 @@
- osxphotos 0.50.0 documentation + osxphotos 0.50.3 documentation