Functions/GenXdev.Helpers/Get-ImageGeolocation.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Helpers Original cmdlet filename : Get-ImageGeolocation.ps1 Original author : René Vaessen / GenXdev Version : 1.268.2025 ################################################################################ MIT License Copyright 2021-2025 GenXdev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ################################################################################> ############################################################################### <# .SYNOPSIS Extracts geolocation data from an image file. .DESCRIPTION This function reads EXIF metadata from an image file to extract its latitude and longitude coordinates. It supports images that contain GPS metadata in their EXIF data. The function uses the System.Drawing.Image class to load the image and parse the GPS coordinates from property items. .PARAMETER ImagePath The full path to the image file to analyze. The file must be a valid image format that supports EXIF metadata (JPEG, TIFF, etc.). .OUTPUTS System.Collections.Hashtable Returns a hashtable containing Latitude and Longitude if GPS data is found, otherwise returns $null. .EXAMPLE Get-ImageGeolocation -ImagePath "C:\Photos\vacation.jpg" .EXAMPLE "C:\Photos\vacation.jpg" | Get-ImageGeolocation #> function Get-ImageGeolocation { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( ######################################################################## [Parameter( Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Path to the image file to analyze' )] [ValidateNotNullOrEmpty()] [string]$ImagePath ######################################################################## ) begin { # check if image path exists if (-not (Microsoft.PowerShell.Management\Test-Path -LiteralPath $ImagePath)) { Microsoft.PowerShell.Utility\Write-Error ( "The specified image path '$ImagePath' does not exist." ) return } Microsoft.PowerShell.Utility\Write-Verbose ( "Processing image: $ImagePath" ) } process { try { # load the image file Microsoft.PowerShell.Utility\Write-Verbose 'Loading image file' $image = [System.Drawing.Image]::FromFile($ImagePath) # get all property items $propertyItems = $image.PropertyItems # extract gps metadata properties Microsoft.PowerShell.Utility\Write-Verbose 'Extracting GPS metadata' $latitudeRef = $propertyItems | Microsoft.PowerShell.Core\Where-Object { $PSItem.Id -eq 0x0001 } $latitude = $propertyItems | Microsoft.PowerShell.Core\Where-Object { $PSItem.Id -eq 0x0002 } $longitudeRef = $propertyItems | Microsoft.PowerShell.Core\Where-Object { $PSItem.Id -eq 0x0003 } $longitude = $propertyItems | Microsoft.PowerShell.Core\Where-Object { $PSItem.Id -eq 0x0004 } # check if gps data exists if ($latitude -and $longitude -and $latitudeRef -and $longitudeRef) { # calculate actual latitude and longitude values $lat = [BitConverter]::ToUInt32($latitude.Value, 0) / [BitConverter]::ToUInt32($latitude.Value, 4) $lon = [BitConverter]::ToUInt32($longitude.Value, 0) / [BitConverter]::ToUInt32($longitude.Value, 4) # adjust for south and west hemispheres if ($latitudeRef.Value -eq [byte][char]'S') { $lat = - $lat } if ($longitudeRef.Value -eq [byte][char]'W') { $lon = - $lon } Microsoft.PowerShell.Utility\Write-Verbose ( "GPS coordinates found: $lat, $lon" ) return @{ Latitude = $lat Longitude = $lon } } else { Microsoft.PowerShell.Utility\Write-Verbose ( 'No GPS metadata found in image' ) return $null } } catch { Microsoft.PowerShell.Utility\Write-Error ( "Failed to process image: $_" ) } finally { if ($image) { $image.Dispose() } } } end { } } |