gerber_diff.h File Reference

#include <geometry/shape_poly_set.h>
#include <math/vector2d.h>
#include <gal/color4d.h>
#include <nlohmann/json_fwd.hpp>
#include <wx/string.h>

Go to the source code of this file.

Classes
struct	GERBER_DIFF_RESULT
	Result of a Gerber diff calculation containing the geometric differences and area statistics. More...
struct	DIFF_RENDER_OPTIONS
	Options for diff PNG rendering. More...

Enumerations
enum class	DIFF_UNITS { MM , INCH , MILS }
	Units for diff result formatting. More...

Functions
VECTOR2I	CalculateAlignment (const SHAPE_POLY_SET &aReference, const SHAPE_POLY_SET &aComparison)
	Calculate the alignment offset to make a comparison poly set align with a reference.
GERBER_DIFF_RESULT	CalculateGerberDiff (const SHAPE_POLY_SET &aReference, const SHAPE_POLY_SET &aComparison)
	Calculate the geometric differences between two poly sets.
wxString	FormatDiffResultText (const GERBER_DIFF_RESULT &aResult, const wxString &aFile1, const wxString &aFile2, DIFF_UNITS aUnits=DIFF_UNITS::MM)
	Format a diff result as human-readable text.
nlohmann::json	FormatDiffResultJson (const GERBER_DIFF_RESULT &aResult, const wxString &aFile1, const wxString &aFile2, DIFF_UNITS aUnits=DIFF_UNITS::MM, double aMaxDiffPercent=0.0)
	Format a diff result as JSON.
bool	RenderDiffToPng (const GERBER_DIFF_RESULT &aResult, const wxString &aOutputPath, const DIFF_RENDER_OPTIONS &aOptions)
	Render a diff result to PNG with colored regions.

Enumeration Type Documentation

DIFF_UNITS

enum class DIFF_UNITS

strong

Units for diff result formatting.

Enumerator
MM
INCH
MILS

Definition at line 92 of file gerber_diff.h.

Function Documentation

CalculateAlignment()

VECTOR2I CalculateAlignment	(	const SHAPE_POLY_SET &	aReference,
		const SHAPE_POLY_SET &	aComparison )

Calculate the alignment offset to make a comparison poly set align with a reference.

Uses bounding box origin alignment.

Parameters

aReference	The reference poly set (will not be modified)
aComparison	The comparison poly set (offset will translate this to align)

Returns

Translation vector to apply to aComparison to align with aReference

Definition at line 28 of file gerber_diff.cpp.

References SHAPE_POLY_SET::BBox(), BOX2< Vec >::GetOrigin(), and SHAPE_POLY_SET::OutlineCount().

Referenced by GERBVIEW_JOBS_HANDLER::JobGerberDiff().

CalculateGerberDiff()

GERBER_DIFF_RESULT CalculateGerberDiff	(	const SHAPE_POLY_SET &	aReference,
		const SHAPE_POLY_SET &	aComparison )

Calculate the geometric differences between two poly sets.

Computes overlap, additions (in comparison but not reference), and removals (in reference but not comparison) using boolean operations.

Parameters

aReference	The reference poly set
aComparison	The comparison poly set

Returns

GERBER_DIFF_RESULT with geometry and statistics

Definition at line 41 of file gerber_diff.cpp.

References result.

Referenced by GERBVIEW_JOBS_HANDLER::JobGerberDiff().

FormatDiffResultJson()

nlohmann::json FormatDiffResultJson	(	const GERBER_DIFF_RESULT &	aResult,
		const wxString &	aFile1,
		const wxString &	aFile2,
		DIFF_UNITS	aUnits = DIFF_UNITS::MM,
		double	aMaxDiffPercent = 0.0 )

Format a diff result as JSON.

Parameters

aResult	The diff result to format
aFile1	Name of the reference file
aFile2	Name of the comparison file
aUnits	Output units for area values
aMaxDiffPercent	Threshold for within_threshold field (0 = any diff fails)

Returns

JSON object

Definition at line 149 of file gerber_diff.cpp.

References GERBER_DIFF_RESULT::additionsArea, GERBER_DIFF_RESULT::additionsPercent, GERBER_DIFF_RESULT::comparisonArea, GERBER_DIFF_RESULT::netChangePercent, GERBER_DIFF_RESULT::overlapArea, GERBER_DIFF_RESULT::referenceArea, GERBER_DIFF_RESULT::removalsArea, and GERBER_DIFF_RESULT::removalsPercent.

Referenced by GERBVIEW_JOBS_HANDLER::JobGerberDiff().

FormatDiffResultText()

wxString FormatDiffResultText	(	const GERBER_DIFF_RESULT &	aResult,
		const wxString &	aFile1,
		const wxString &	aFile2,
		DIFF_UNITS	aUnits = DIFF_UNITS::MM )

Format a diff result as human-readable text.

Parameters

aResult	The diff result to format
aFile1	Name of the reference file
aFile2	Name of the comparison file
aUnits	Output units for area values

Returns

Formatted text string

Definition at line 118 of file gerber_diff.cpp.

References GERBER_DIFF_RESULT::additionsArea, GERBER_DIFF_RESULT::additionsPercent, GERBER_DIFF_RESULT::comparisonArea, GERBER_DIFF_RESULT::netChangePercent, GERBER_DIFF_RESULT::overlapArea, GERBER_DIFF_RESULT::referenceArea, GERBER_DIFF_RESULT::removalsArea, and GERBER_DIFF_RESULT::removalsPercent.

Referenced by GERBVIEW_JOBS_HANDLER::JobGerberDiff().

RenderDiffToPng()

bool RenderDiffToPng	(	const GERBER_DIFF_RESULT &	aResult,
		const wxString &	aOutputPath,
		const DIFF_RENDER_OPTIONS &	aOptions )

Render a diff result to PNG with colored regions.

Draws overlap in gray, additions in green, and removals in red.

Parameters

aResult	The diff result containing geometry
aOutputPath	Path for the output PNG file
aOptions	Rendering options

Returns

true on success, false on failure

Definition at line 209 of file gerber_diff.cpp.

References GERBER_DIFF_RESULT::additions, DIFF_RENDER_OPTIONS::antialias, CalculatePlotterViewport(), DIFF_RENDER_OPTIONS::colorAdditions, DIFF_RENDER_OPTIONS::colorBackground, DIFF_RENDER_OPTIONS::colorOverlap, DIFF_RENDER_OPTIONS::colorRemovals, DIFF_RENDER_OPTIONS::dpi, PNG_PLOTTER::EndPlot(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetWidth(), DIFF_RENDER_OPTIONS::height, GERBER_PLOTTER_VIEWPORT::height, GERBER_PLOTTER_VIEWPORT::iuPerDecimil, BOX2< Vec >::Merge(), GERBER_PLOTTER_VIEWPORT::offset, GERBER_DIFF_RESULT::overlap, GERBER_PLOTTER_VIEWPORT::plotScale, GERBER_DIFF_RESULT::removals, PNG_PLOTTER::SaveFile(), PNG_PLOTTER::SetAntialias(), PNG_PLOTTER::SetBackgroundColor(), PNG_PLOTTER::SetPixelSize(), PNG_PLOTTER::SetResolution(), PNG_PLOTTER::SetViewport(), PNG_PLOTTER::StartPlot(), DIFF_RENDER_OPTIONS::width, and GERBER_PLOTTER_VIEWPORT::width.

Referenced by GERBVIEW_JOBS_HANDLER::JobGerberDiff().