Major update. Prepare for maven release

KilianB · Aug 3, 2018 · edd7d09 · edd7d09
1 parent 456353d
commit edd7d09
Show file tree

Hide file tree

Showing 38 changed files with 2,806 additions and 379 deletions.
diff --git a/.classpath b/.classpath
@@ -0,0  1,30 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
 	<classpathentry kind="src" output="target/classes" path="src/main/java">
 		<attributes>
 			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
 		<attributes>
 			<attribute name="test" value="true"/>
 			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
 		<attributes>
 			<attribute name="test" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk1.8.0_60"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
 	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>
diff --git a/.gitignore b/.gitignore
@@ -1  1,3 @@
 .DS_Store
 /bin/
 /target/
diff --git a/.project b/.project
@@ -0,0  1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
 	<name>JImageHash</name>
 	<comment></comment>
 	<projects>
 	</projects>
 	<buildSpec>
 		<buildCommand>
 			<name>org.eclipse.jdt.core.javabuilder</name>
 			<arguments>
 			</arguments>
 		</buildCommand>
 		<buildCommand>
 			<name>org.eclipse.m2e.core.maven2Builder</name>
 			<arguments>
 			</arguments>
 		</buildCommand>
 	</buildSpec>
 	<natures>
 		<nature>org.eclipse.m2e.core.maven2Nature</nature>
 		<nature>org.eclipse.jdt.core.javanature</nature>
 	</natures>
 </projectDescription>
diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs
@@ -0,0  1,14 @@
 eclipse.preferences.version=1
 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
 org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
 org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
 org.eclipse.jdt.core.compiler.compliance=1.8
 org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 org.eclipse.jdt.core.compiler.debug.localVariable=generate
 org.eclipse.jdt.core.compiler.debug.sourceFile=generate
 org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
 org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
 org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
 org.eclipse.jdt.core.compiler.release=disabled
 org.eclipse.jdt.core.compiler.source=1.8
diff --git a/.settings/org.eclipse.m2e.core.prefs b/.settings/org.eclipse.m2e.core.prefs
@@ -0,0  1,4 @@
 activeProfiles=
 eclipse.preferences.version=1
 resolveWorkspaceProjects=true
 version=1
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0  1,21 @@
 - Semantic versioning
 
 ## [0.1.0] - 3.8.2018
 ## Added
 - BinaryTree class to save & compare precomputed hashes
 - UnitTests for hash algorthms and basic matchers
 - Examples
 	- Extensive gui example
 - Algorithm identifiers preventing mismatching hashes to be compared
 
 ## Changed
 - Preparation for maven distribution. Changed package structure
 - Using a dedicated Hash class instead of a BigInteger to represent hash results
 
 
 
 
 ## [0.0.8] - 
 ## Added
 - MIT License
 - usage of changelog
diff --git a/README.md b/README.md
@@ -96,31  96,24 @@ Each algorithm comes with individual properties
 
 
 ````java
-//Approximate final hash resolution
-int bitResolution = 64;
 
-public static void main(String[] args){
-
-  //Load images
-  BufferedImage img1 = ImageIO.read(new File("image1.jpg"));
-  BufferedImage img2 = ImageIO.read(new File("image2.jpg"));
-
-  //Pick an algorithm
-  HashingAlgorithm hasher = new AverageHash(bitResolution);
-
-  //Calculate similarity score
-  double normDistance = ImageHash.normalizedHammingDistance(hasher.hash(img1),hasher.hash(img2));
-  double distance = ImageHash.hammingDistance(hasher.hash(img1),hasher.hash(img2));
-
-  if(normDistance < 0.1){
-    //Duplicate found. Most likely an altered image 
-  }
-
-  //Or 
-  if(distance < 10){
-    //Likely duplicate found
-  }
-}
 	//Key bit resolution
 	int keyLength = 64;
 
 	//Pick an algorithm
 	HashingAlgorithm hasher = new AverageHash(keyLength);
 
 	public boolean compareTwoImages(File image1, File image2) throws IOException {
 
 		//Hash images
 		Hash hash1 = hasher.hash(image1);
 		Hash hash2 = hasher.hash(image2);
 
 		//Ranges between 0 - keyLength.  The lower the more similar the image is.
 		int similarityScore = hash1.hammingDistance(hash2);
 
 		return similarityScore < 20;	
 	}
 
 ````
 Only hashes produced by the same algorithm with the same bit resolution can be compared.

diff --git a/lib/JTransforms-3.1-with-dependencies.jar b/lib/JTransforms-3.1-with-dependencies.jar
diff --git a/pom.xml b/pom.xml
@@ -0,0  1,90 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0"
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 
 	<!-- Project settings -->
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.github.kilianB</groupId>
 	<artifactId>JImageHash</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 
 	<properties>
 		<bintrayRepository>maven</bintrayRepository>
 		<bintrayPackage>JImageHash</bintrayPackage>
 	</properties>	
 
 	<licenses>
 		<license>
 			<name>MIT</name>
 			<url>https://opensource.org/licenses/MIT</url>
 			<distribution>repo</distribution>
 		</license>
 	</licenses>
 
 	<developers>
 		<developer>
 			<name>Kilian Brachtendorf</name>
 			<email>[email protected]</email>
 			<roles>
 				<role>developer</role>
 			</roles>
 			<timezone>Europe/Berlin</timezone>
 		</developer>
 	</developers>
 
 
 
 	<!-- Dependencies -->
 
 	<dependencies>
 		<dependency>
 			<groupId>com.github.wendykierp</groupId>
 			<artifactId>JTransforms</artifactId>
 			<version>3.1</version>
 			<classifier>with-dependencies</classifier>
 		</dependency>
 
 		<!-- Google image downloading dependency -->
 		<dependency>
 			<groupId>net.sourceforge.htmlunit</groupId>
 			<artifactId>htmlunit</artifactId>
 			<version>2.32</version>
 		</dependency>
 
 		<dependency>
 			<groupId>javax.xml.bind</groupId>
 			<artifactId>jaxb-api</artifactId>
 			<version>2.4.0-b180725.0427</version>
 		</dependency>
 
 		<dependency>
 			<groupId>com.jfoenix</groupId>
 			<artifactId>jfoenix</artifactId>
 			<version>8.0.4</version>
 		</dependency>
 	</dependencies>
 
 	<!-- Build settings -->
 	<build>
 		<plugins>
 			<plugin>
 				<artifactId>maven-compiler-plugin</artifactId>
 				<version>3.7.0</version>
 				<configuration>
 					<release>10</release>
 				</configuration>
 			</plugin>
 		</plugins>
 	</build>
 
 	<!-- Environment Settings -->
 	<distributionManagement>
 		<repository>
 			<id>bintrayServer</id>
 			<url>https://bintray.com/kilianb/${bintrayRepository}/${bintrayPackage}/${project.version};publish=1</url>
 		</repository>
 	</distributionManagement>
 
 
 </project>
diff --git a/src/hashAlgorithms/PerceptiveHash.java b/src/hashAlgorithms/PerceptiveHash.java