Difference between revisions of "Addon:Image Metadata Gramplet"

From Gramps
Jump to: navigation, search
(Re-write Wiki Page to make it better than it has been before!)
m (CallMeDave moved page Image Metadata Gramplet to Addon:Image Metadata Gramplet: move like the rest of them to "Addon:" )
 
(21 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Plugins]]
+
{{Third-party plugin}}
[[Category:Developers/General]]
+
{{man warn|Update|Since Gramps 3.3 some of these features have been added as core gramplets, see [[Gramps_3.3_Wiki_Manual_-_Gramplets#Image_Metadata|Image Metadata Gramplet]].}}
 +
[[File:ImageMetadata-detached-gramplet-40.png|thumb|right|400px|Fig. Image Metadata Gramplet]]
 +
The Image Metadata Gramplet offers an easy interface to add, edit, and remove Image Exif Metadata from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).
 +
 
 +
==Installation==
 +
;Prerequisite: '''Special Note: Before being able to use this gramplet/ addon, you will need to download and install [http://tilloy.net/dev/pyexiv2/ pyexiv2] or install pyexiv2 from your local Linux repository.  Windows user, there is an installer for you.  Ubuntu, use the Universe repository to find pyexiv2.'''<br>
 +
 
 +
Once you have installed pyexiv2, see above for directions to download and install this addon...<br>
 +
 
 +
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:<br>
 +
 
 +
# import the pyexiv2 library
 +
#: from pyexiv2 import ImageMetadata, ExifTag
 +
# specify your image
 +
#: image = ImageMetadata("/home/user/image.jpg")
 +
# read the image
 +
#: image.read()
  
''This is a [[Third-party Plugin|Third-party plugin]]. Please treat this as anything else of value to you, use carefully on data that is not backed up, and help make it better by reporting any comments or problems to the author.''
+
Exif, IPTC, XMP metadata reference tags can be found [http://www.exiv2.org/metadata.html here].<br>
  
 +
Example:
 
<hr>
 
<hr>
 +
image["Exif.Image.Artist"] # Artist<br>
 +
Smith and Johnson's Photography Studio<br>
  
[[Image:Image_Metadata_Gramplet.gif|thumb|right|150px|Fig. Image Metadata Gramplet]]
+
image["Exif.Image.DateTime"] # DateTime<br>
 
+
1826 Apr 12 14:00:00<br>
    * '''''Special Note: Before being able to use this gramplet/ addon, you will need to download and install pyexiv2 from its [http://tilloy.net/dev/pyexiv2/ website] or install pyexiv2 from your local Linux repository.  Windows user, there is an installer for you.'''''<br><br>
 
  
The Image Metadata Gramplet offers an easy interface to add, edit, and remove Image Exif Metadata from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).
+
image["Exif.Image.DateTime"] = datetime.datetime.now() # Add DateTime<br>
  
Once you have installed pyexiv2, see above for directions to download and install this addon...
+
image.write() # write the Metadata<br>
  
 +
==Usage scenario==
 
My perferred way to use this addon is:
 
My perferred way to use this addon is:
1) install pyexiv2
+
# install pyexiv2<br>
2) Install this addon
+
# Install this addon<br>
3)) Install [http://www.gramps-project.org/wiki/index.php?title=Split_Views Split Views ]
+
# Install [http://www.gramps-project.org/wiki/index.php?title=Split_Views Split Views ]<br>
4) Restart Gramps
+
# Restart Gramps<br>
5) Click on Split Views from the left-side Navigation Sidebar
+
# Click on Split Views from the left-side Navigation Sidebar<br>
6) Click Views from the Menu bar, and select Media Views
+
# Click Views from the Menu bar, and select Media Views<br>
7) Close the right side Views by clicking the X
+
# Close the right side View by clicking the X at the top left side<br>
8) Slide the available empty right view to about half the screen.
+
# Slide the available empty right view to about half the screen.<br>
9) Right click in the open space, and select Add a gramplet
+
# Right click in the open space, and select Add a Gramplet<br>
10) Select Image Metadata Gramplet
+
# Select Image Metadata Gramplet<br>
11) Select an image from the left hand Media View
+
# Select an image from the left hand MediaView<br>
  
'''Data Fields'''<br>
+
==The interface==
 +
===Data Fields===
  
Photographer:<br>
+
Photographer:
The name of the person or company taking the image
+
:The name of the person or company taking the image
  
Select Date<br>
+
Select Date
Will bring up a calendar, and double-click on a date. The time will be filled in as the current time<br>
+
:Will bring up a calendar, and double-click on a date. The time will be filled in as the current time<br>
  
Date<br>
+
Date
The Date/ Time needs to be typed in as a very specific format:<br>
+
:The Date/ Time needs to be typed in as a very specific format:<br>
Year Mon Day Hour:Minutes:Seconds<br>
+
:Year Mon Day Hour:Minutes:Seconds<br>
11826 Apr 12 14:06:00<br>
+
:11826 Apr 12 14:06:00<br>
  
Copyright<br>
+
Copyright
Can be anything that you please... Ex: (C) 2010 Smith and Wesson<br>
+
:Can be anything that you please... Ex: (C) 2010 Smith and Wesson<br>
  
Subject<br>
+
Subject
Please enter keywords that describe the picture.  Do NOT add a space after the comma. Ex. : Census,Milwaukee,Oregon
+
:Please enter keywords that describe the picture.  Do NOT add a space after the comma. Ex. : Census,Milwaukee,Oregon
  
Latitude/ Longitude<br>
+
Latitude/ Longitude
Latitude/ Longitude data can be entered in one of two ways:<br>
+
:Latitude/ Longitude data can be entered in one of two ways:<br>
1) Degrees Minutes Seconds Ex.: 10 59 14<br>
+
:# Degrees Minutes Seconds Ex.: 10 59 14
 +
:#:In this format, you will need to select latitude reference, and longitude reference<br>
 +
:#:If the Latitude begins with a negative number, select 'S' as Lat. Ref. or 'N' if a positive number.  If the Longitude begins with a negative number, select 'W' as the Long. Ref. or 'E' if a positive number.
 +
:# Decimal, Ex. : -34.15954
 +
:#:In this format, the Latitude and Longitude reference will be selected for you after you click Convert GPS  Coordinates or press the Save button.  For foreign countries that might use a ", " instead of a ".", please use the "."
  
  * In this format, you will need to select latitude reference, and longitude reference<br>
+
Description
** If the Latitude begins with a negative number, select 'S' as Lat. Ref. or 'N' if a positive numberIf the Longitude begins with a negative number, select 'W' as the Long. Ref. or 'E' if a positive number.
+
:Type in something about the image, the people in it or the location of the image. Non-latin characters are NOT allowedASCII characters only...
  
2) Decimal, Ex. : -34.15954<br>
+
===Buttons===
  
    * In this format, the Latitude and Longitude reference will be selected for you after you click Convert GPS Coordinates or press the Save button.  For foreign countries that might use a ", " instead of a ".", please use the .
+
#Save<br>
 +
#:Will write the metadata to the image, and convert latitude/ longitude if it is in decimal format.
 +
#Clear<br>
 +
#:Will clear all data fields
 +
#Convert GPS Coordinates<br>
 +
#:will convert Latitude/ Longitude if it is in decimal format
  
Description<br>
+
My favorite source for GPS Coordinates is: [http://www.gpsvisualizer.com/geocode GPS Visualizer]
Type in something about the image, the people in it or the location of the image.  Non-latin characters are NOT allowed.  ASCII characters only...
 
  
'''Buttons '''<br>
+
== Part of core code ==
  
1) Save<br>
+
'''Update''': Since Gramps 3.3 some of these features have been added as core gramplets, see [[Gramps_3.3_Wiki_Manual_-_Gramplets#Image_Metadata|Gramplets]].
Will write the metadata to the image, and convert latitude/ longitude if it is in decimal format.
 
  
2) Clear<br>
+
== See also ==
Will clear all data fields
+
* [[Addon:Edit Image Exif Metadata]] - Gramplet offers an easy interface to add, edit, and remove Image Exif (Exchangeable image file format) Metadata from your images
 +
See also the built-in:
 +
* [[Gramps_{{Version manual}}_Wiki_Manual_-_Gramplets#Image_Metadata|Image Metadata Gramplet]] that only displays the Exif information.
  
3) Convert GPS Coordinates<br>
 
will convert Latitude/ Longitude if it is in decimal format
 
  
My favorite source for GPS Coordinates is: [http://www.gpsvisualizer.com/geocode GPS Visualizer]
+
[[Category:Plugins]]
 
+
[[Category:Developers/General]]
<br clear="all"/>
+
[[Category:Gramplets]]

Latest revision as of 22:40, 28 June 2022

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager.

Gnome-important.png
Update

Since Gramps 3.3 some of these features have been added as core gramplets, see Image Metadata Gramplet.

Fig. Image Metadata Gramplet

The Image Metadata Gramplet offers an easy interface to add, edit, and remove Image Exif Metadata from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).

Installation

Prerequisite
Special Note: Before being able to use this gramplet/ addon, you will need to download and install pyexiv2 or install pyexiv2 from your local Linux repository. Windows user, there is an installer for you. Ubuntu, use the Universe repository to find pyexiv2.

Once you have installed pyexiv2, see above for directions to download and install this addon...

Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:

  1. import the pyexiv2 library
    from pyexiv2 import ImageMetadata, ExifTag
  2. specify your image
    image = ImageMetadata("/home/user/image.jpg")
  3. read the image
    image.read()

Exif, IPTC, XMP metadata reference tags can be found here.

Example:


image["Exif.Image.Artist"] # Artist
Smith and Johnson's Photography Studio

image["Exif.Image.DateTime"] # DateTime
1826 Apr 12 14:00:00

image["Exif.Image.DateTime"] = datetime.datetime.now() # Add DateTime

image.write() # write the Metadata

Usage scenario

My perferred way to use this addon is:

  1. install pyexiv2
  2. Install this addon
  3. Install Split Views
  4. Restart Gramps
  5. Click on Split Views from the left-side Navigation Sidebar
  6. Click Views from the Menu bar, and select Media Views
  7. Close the right side View by clicking the X at the top left side
  8. Slide the available empty right view to about half the screen.
  9. Right click in the open space, and select Add a Gramplet
  10. Select Image Metadata Gramplet
  11. Select an image from the left hand MediaView

The interface

Data Fields

Photographer:

The name of the person or company taking the image

Select Date

Will bring up a calendar, and double-click on a date. The time will be filled in as the current time

Date

The Date/ Time needs to be typed in as a very specific format:
Year Mon Day Hour:Minutes:Seconds
11826 Apr 12 14:06:00

Copyright

Can be anything that you please... Ex: (C) 2010 Smith and Wesson

Subject

Please enter keywords that describe the picture. Do NOT add a space after the comma. Ex. : Census,Milwaukee,Oregon

Latitude/ Longitude

Latitude/ Longitude data can be entered in one of two ways:
  1. Degrees Minutes Seconds Ex.: 10 59 14
    In this format, you will need to select latitude reference, and longitude reference
    If the Latitude begins with a negative number, select 'S' as Lat. Ref. or 'N' if a positive number. If the Longitude begins with a negative number, select 'W' as the Long. Ref. or 'E' if a positive number.
  2. Decimal, Ex. : -34.15954
    In this format, the Latitude and Longitude reference will be selected for you after you click Convert GPS Coordinates or press the Save button. For foreign countries that might use a ", " instead of a ".", please use the "."

Description

Type in something about the image, the people in it or the location of the image. Non-latin characters are NOT allowed. ASCII characters only...

Buttons

  1. Save
    Will write the metadata to the image, and convert latitude/ longitude if it is in decimal format.
  2. Clear
    Will clear all data fields
  3. Convert GPS Coordinates
    will convert Latitude/ Longitude if it is in decimal format

My favorite source for GPS Coordinates is: GPS Visualizer

Part of core code

Update: Since Gramps 3.3 some of these features have been added as core gramplets, see Gramplets.

See also

  • Addon:Edit Image Exif Metadata - Gramplet offers an easy interface to add, edit, and remove Image Exif (Exchangeable image file format) Metadata from your images

See also the built-in: