Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

View on GitHub Releases Get package
Stars 101
Forks 7
Total downloads 711,982
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-10-26
Command

Compare-Image

Module
ImagePlayground
Inputs
System.String

Compares two images and optionally saves a difference mask.

Syntax

Compare-Image
[-FilePath] <String>
[-FilePathToCompare] <String>
[[-OutputPath] <String>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

When OutputPath is omitted, the cmdlet writes the comparison result to the pipeline instead of creating a file.

Examples

Compare two images

Compare-Image -FilePath img1.png -FilePathToCompare img2.png

Parameters

-FilePath String requiredposition: 0pipeline: True (ByValue)
First image path.
-FilePathToCompare String requiredposition: 1
Second image path.
-OutputPath String optionalposition: 2
When provided, the cmdlet writes a visual difference image instead of only returning the comparison result.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.