Compare-Image

Namespace ImagePlayground

Inputs

System.String

Compares two images and optionally saves a difference mask.

Remarks

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

Examples

Authored help example

Compare two images

PS>


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

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.

Syntax

Compare-Image -FilePath <String> -FilePathToCompare <String> [-OutputPath <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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