Merge branch 'master' into ns-image-processing-class

Author: Jyotsna-Shetty

.gitignore

@@ -1,9 +1,11 @@
-*.iml
+# Folders
 .gradle
-/local.properties
-/.idea
+.idea
 /.idea/caches
 /.idea/libraries
+# Files
+*.iml
+/local.properties
 /.idea/modules.xml
 /.idea/workspace.xml
 /.idea/navEditor.xml
@@ -14,5 +16,6 @@
 .externalNativeBuild
 .cxx
 local.properties
-/app/src/androidTest/java/com/example/vehicleinfocheck
-/app/src/test/java/com/example/vehicleinfocheck
+# Test Folders (not used in this project, hence added to .gitignore)
+/app/src/androidTest/java/com/example/vehicleinfocheck/
+/app/src/test/java/com/example/vehicleinfocheck/

README.md

@@ -1,11 +1,83 @@
 # VehicleInfoCheck
-
-An app to scan license plate images and extract vehicle details.
+An Android application that scans Indian license plate images and extracts the details of the vehicle from the national vehicle registry, VAHAN.
 
 Status: _In progress_
+## Description
+The app can capture an image using the device camera or choose an image from the device’s gallery which can be cropped as per the user’s preference.
+This image is then processed using OpenCV for Java. This involves:
+*	Extracting the license plate from the image
+*	Conversion of image to greyscale
+*	OpenCV operations such as erosion and dilation to aid character segmentation 
+*	Conversion of image to binary 
+*	Finding the contour of each character present in the license plate
+*	Cropping the license plate to get individual images for each character
+
+The processed images are sent to the Tensorflow deep learning model which performs optical character recognition to identify the license plate number.
+> Presently, the deep learning model used in the project gives an incorrect prediction of the license plate number.
+
+Next, the user is redirected to the page which displays the [VAHAN website](https://vahan.nic.in/nrservices/faces/user/login.xhtml), where the detected license plate number can be used to obtain details such as vehicle model, fuel type, manufacturer details, among others.
+## To import the project into Android Studio 
+1.	Open Android Studio, click **File --> New --> Project from Version Control**.
+2.	Choose Git from the Version control dropdown.
+3.	Copy the hyperlink present when you click on the Code button in the repository and paste in the URL tab.
+4.	Click Clone.
+5.	Sync project and run.
+## System requirements
+Android Studio – this project was built on version 4.1.0
+
+Git installed on the device.
+
+External library – OpenCV (see [Enabling OpenCV](https://github.com/Jyotsna-Shetty/VehicleInfoCheck#enabling-opencv))
+
+RAM – preferably 8 GB and above (users with 4 GB RAM will have issues running the emulator).
+
+Available disk space – 8 GB and above (IDE + Android SDK + Android Emulator).
+
+Operating system:
+*	64-bit Microsoft Windows 8/10
+*	MacOS 10.14 (Mojave) or higher
+* 64-bit Linux distribution that supports Gnome, KDE, or Unity DE; GNU C Library (glibc) 2.31 or later
+
+Processor – 2nd generation Intel Core or newer.
+
+Complete list of system requirements for Android Studio can be found [here.](https://developer.android.com/studio)
+### To run the app on an Android phone, the requirements are:
+Android version – 5.0 (Lollipop, API 21) and above.
+
+Available storage space on device – 50 MB +
+## Enabling OpenCV
+1. Open `build.gradle` from the OpenCV library module present in the Project panel of Android Studio, check if the `compileSdkVersion` and `targetSdkVersion` match the version in your PC. If not, change it to your version.
+2. Go to **File --> Sync project with Gradle files**. The library should now be visible in the Android panel of Android Studio. 
+## Folders
+### app
+This folder contains the main code and gradle file for the app, along with auto-generated .gitignore and proguard-rules files.
+
+#### src
+Contains `main` folder (all Android Studio files and folders present in it) and two test folders (not used in this project). Inside `main`, we have:
+
+***java/com/example/vehicleinfocheck***: Contains all java classes defining the function of the app.
+1. Activity classes: MainActivity- loading screen; ImageActivity- image selection and processing; WebActivity- Website display and function.
+2. WebScraper and Element classes: Contain methods for accessing and displaying the website within the app. 
+
+***ml***: Contains the deep learning tflite model.
+
+***res***: 
+1. `drawable`: All the pre-existing and imported drawables (images and xml) are present here.
+2. `layout`: Layout files for every activity of the are present here.
+3. `mipmap`: App icon files are present in these folders.
+4. `font`: The fonts added manually to the project are present here.
+5. `values`: Contains folders for strings, colours, dimensions and preloaded fonts.
+6. `xml`: File path for saving images is present here.
+
+***AndroidManifest.xml***: Manifest file with all neccesary information regarding the app, such as app package name, activites, permissions the app needs and content providers.
+
+***ic_launcher_custom-playstore.png***: Logo of the app.
 
-Presently, the app can take login credentials and can click images/take images from the device's gallery and display it.
+### Gradle files and .idea
+The gradle/wrapper folder, build.gradle (outside of app folder), gradle.properties, gradlew, gradlew.bat, settings.gradle, .idea are all gradles files generated by Android studio and are added to .gitignore since no changes are made to them.
+### LICENSE
+This project is licensed under the GNU General Public License v3.0. The file contains the complete description of the license, its permissions, limitations and  conditions.
+## Credits
+Deep learning model used - https://github.com/SarthakV7/AI-based-indian-license-plate-detection.
 
-To run the app on Android studio: 
-------------------------------
-Open Android Studio -->  Checkout Project from Version Control --> Choose Git --> Paste the URL of the repository --> Clone
+Reference used for WebScraper class - https://github.com/Udayraj123/VehicleInfoOCR. 

app/build.gradle

@@ -33,7 +33,7 @@ android {
 
 dependencies {
     api 'com.theartofdev.edmodo:android-image-cropper:2.8.+'
-    implementation 'androidx.appcompat:appcompat:1.2.0'
+    implementation 'androidx.appcompat:appcompat:1.3.0'
     implementation 'com.google.android.material:material:1.3.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
     implementation 'androidx.appcompat:appcompat:1.2.0'

app/src/main/AndroidManifest.xml

@@ -9,9 +9,9 @@
 
     <application
         android:allowBackup="true"
-        android:icon="@mipmap/ic_launcher_custom"
+        android:icon="@mipmap/vic_app_logo"
         android:label="@string/app_name"
-        android:roundIcon="@mipmap/ic_launcher_custom_round"
+        android:roundIcon="@mipmap/vic_app_logo_round"
         android:supportsRtl="true"
         android:theme="@style/Theme.VehicleInfoCheck">
         <activity android:name="com.theartofdev.edmodo.cropper.CropImageActivity"/>

app/src/main/java/com/example/vehicleinfocheck/Element.java

@@ -1,35 +1,36 @@
+//This class is not used in this project as the required methods did not work
 package com.example.vehicleinfocheck;
+//An element is a field present in the website: an input field, a button, etc.
 
 import android.util.Log;
 
-// An element is a field present in the website: an input field, a button, etc.
-// This class defines all methods pertaining to elements
+//This class defines all methods pertaining to elements
 public class Element {
-    private final String elementLocator;    // String to find an element in the website
-    private final WebScraper web;           // Instance of the WebScraper class
+    private final String elementLocator;    //String to find an element in the website
+    private final WebScraper web;           //Instance of the WebScraper class
 
     Element (WebScraper web, String elementLocator){
         this.web = web;
         this.elementLocator = elementLocator;
     }
 
     public void setText(String text){
-        String t = "javascript:" + elementLocator + ".value='" + text + "';void(0);";
-        Log.i("Logmsg",t);
-        web.run(t);
+        String task = "javascript:" + elementLocator + ".value='" + text + "';void(0);";
+        Log.i("Logmsg",task);
+        web.runAsUrl(task);
     }
 
     public void setAttribute(String attribute,String text){
-        String t = "javascript:" + elementLocator + "."+attribute+"='" + text + "';void(0);";
-        Log.i("Logmsg",t);
-        web.run(t);
+        String task = "javascript:" + elementLocator + "."+attribute+"='" + text + "';void(0);";
+        Log.i("Logmsg",task);
+        web.runAsUrl(task);
     }
 
     public void click(){
-        web.run("javascript:" + elementLocator + ".click();void(0);");
+        web.runAsUrl("javascript:" + elementLocator + ".click();void(0);");
     }
 
     public String getName(){
-        return web.run2("javascript:window.HtmlViewer.processContent(" + elementLocator + ".name);");
+        return web.runJavascript("javascript:window.HtmlViewer.processContent(" + elementLocator + ".name);");
     }
-}
+}

app/src/main/java/com/example/vehicleinfocheck/ImageActivity.java

@@ -47,8 +47,6 @@
 import org.tensorflow.lite.Tensor;
 import org.tensorflow.lite.support.image.TensorImage;
 import org.tensorflow.lite.support.tensorbuffer.TensorBuffer;
-;
-
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -70,10 +68,10 @@
 public class ImageActivity extends AppCompatActivity {
 
     public static final int CAMERA_PERM_CODE = 101;
-    public static final int CAMERA_REQUEST_CODE = 102;  //camera request code
-    public static final int GALLERY_REQUEST_CODE = 105; //gallery request code
-    ImageView selectedImage;    //import Imageview as selectedImage
-    Button cameraBtn,galleryBtn, ScanBtn;   //import buttons
+    public static final int CAMERA_REQUEST_CODE = 102;   //camera request code
+    public static final int GALLERY_REQUEST_CODE = 105;  //gallery request code
+    ImageView selectedImage;  //import Imageview as selectedImage
+    Button cameraBtn,galleryBtn, ScanBtn; //import buttons
     TextView sampleImgText;
     String currentPhotoPath;
     //String galleryPhotoPath;
@@ -97,16 +95,15 @@ public class ImageActivity extends AppCompatActivity {
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_image);
-        setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT);   //fixes orientation to PORTRAIT mode
+        setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT);  //fixes orientation to PORTRAIT mode
 
         selectedImage = findViewById(R.id.displayImageView); //finding imageview
         sampleImgText = findViewById(R.id.SampleImgMsg);
-        cameraBtn = findViewById(R.id.cameraBtn);
+        cameraBtn = findViewById(R.id.cameraBtn); 
         galleryBtn = findViewById(R.id.galleryBtn);
-        ScanBtn = findViewById(R.id.ScanBtn);
+        ScanBtn = findViewById(R.id.ScanBtn); 
 
         cameraBtn.setOnClickListener(new View.OnClickListener(){
-            //OnClickListener will be triggered when camera button is clicked
             //directs to askCameraPermissions to get Camera Permissions
             @Override
             public void onClick(View v){
@@ -115,10 +112,9 @@ public void onClick(View v){
         });
 
         galleryBtn.setOnClickListener(new View.OnClickListener() {
-            //OnClickListener will be triggered when gallery button is clicked
             @Override
             public void onClick(View v) {
-                Intent gallery = new Intent(Intent.ACTION_PICK, MediaStore.Images.Media.EXTERNAL_CONTENT_URI);//creating new intent to select photo from media storage
+                Intent gallery = new Intent(Intent.ACTION_PICK, MediaStore.Images.Media.EXTERNAL_CONTENT_URI);  //intent to select photo from media storage
                 startActivityForResult(gallery, GALLERY_REQUEST_CODE);
             }
         });
@@ -146,15 +142,13 @@ public void onClick(View v) {
             }
         });
     }
-    
-    //using checkSelfPermission method of ContextCompact to check whether permission is granted or not
+    //using checkSelfPermission method of ContextCompact checks whether permission is granted or not
     private void askCameraPermissions() {
         //checks for permission from manifest file using PackageManager.PERMISSION_GRANTED
         if(ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA) != PackageManager.PERMISSION_GRANTED){
             //permission for camera is passed within the string
             ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.CAMERA}, CAMERA_PERM_CODE);
         }else {
-            //user has given permission to the app
             dispatchTakePictureIntent();
         }
     }
@@ -163,16 +157,16 @@ private void askCameraPermissions() {
     @Override
     public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
         super.onRequestPermissionsResult(requestCode, permissions, grantResults);
-        //checking permission by comparing request code of camera with request code passed to onRequestPermissionResult
+        //checking  permission by comparing request code of camera with request code passed to onRequestPermissionResult
         if (requestCode == CAMERA_PERM_CODE) {
-            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED){//if both the conditions are true then camera permission is given
+            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED){  //camera permission given
                 dispatchTakePictureIntent();
             } else {
-                Toast.makeText(this, "Camera Permission is Required to Use camera.", Toast.LENGTH_SHORT).show();
+                Toast.makeText(this, "Camera permission is required to use camera.", Toast.LENGTH_SHORT).show();
             }
         }
     }
-    //onActivityResult method is used to display and save image
+    //onActivityResult method is used to display and save image as data of this app
     @Override
     protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
         super.onActivityResult(requestCode, resultCode, data);
@@ -207,6 +201,20 @@ protected void onActivityResult(int requestCode, int resultCode, @Nullable Inten
 
             }
         }
+        //for cropping the image
+        if (requestCode == CropImage.CROP_IMAGE_ACTIVITY_REQUEST_CODE) {
+            CropImage.ActivityResult result = CropImage.getActivityResult(data);
+            if (resultCode == RESULT_OK) {
+                assert result != null;
+                Uri resultUri = result.getUri();
+                selectedImage.setImageURI(resultUri);
+            } else if (resultCode == CropImage.CROP_IMAGE_ACTIVITY_RESULT_ERROR_CODE) {
+                assert result != null;
+                Exception error = result.getError();
+                Log.d("tag", "ERROR: " + error);
+
+            }
+        }
         if (requestCode == GALLERY_REQUEST_CODE) {
             if (resultCode == Activity.RESULT_OK && data != null) {
                 Uri contentUri = data.getData();    //creating content URI using intent data
@@ -218,40 +226,11 @@ protected void onActivityResult(int requestCode, int resultCode, @Nullable Inten
                 }
                 Log.d("tag", "Absolute Url of Image is " + Uri.fromFile(newFile)); //display absolute url of the file
                 CropImage.activity(contentUri).start(this);
-                /*galleryPhotoPath = getPath(contentUri);
-                Log.d("GALLERY IMAGE","PATH; " + galleryPhotoPath);
-                String timeStamp = new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());//creating file name using time stamp
-                String imageFileName = "JPEG_" + timeStamp + "." + getFileExt(contentUri);
-                Log.d("tag", "onActivityResult: Gallery Image Uri: " + imageFileName);*/
-                //selectedImage.setImageURI(Uri.fromFile(newFile));
                 sampleImgText.setVisibility(View.INVISIBLE);
             }
-
         }
     }
 
-    /*public String getFileExt(Uri contentUri) {
-        ContentResolver c = getContentResolver();
-        MimeTypeMap mime = MimeTypeMap.getSingleton();
-        return mime.getExtensionFromMimeType(c.getType(contentUri));
-    }
-
-    public String getPath(Uri uri) {
-        String path = null;
-        String[] projection = {MediaStore.Images.Media.DATA};
-        Cursor cursor = getContentResolver().query(uri, projection, null, null, null);
-        if (cursor != null) {
-            if (cursor.moveToFirst()) {
-                int column_index = cursor.getColumnIndexOrThrow(projection[0]);
-                path = cursor.getString(column_index);
-            }
-            cursor.close();
-        }
-        if (path == null) {
-            path = "Not found";
-        }
-        return path;
-    }*/
     public File getGalleryImage(Uri uri) throws IOException {
         InputStream in =  getContentResolver().openInputStream(uri);
         File photoFile = createImageFile();
@@ -272,7 +251,6 @@ public File getGalleryImage(Uri uri) throws IOException {
     private File createImageFile() throws IOException {
         String timeStamp = new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());  //creates time stamp
         String imageFileName = ";JPEG_" + timeStamp + "_";  //creating image file
-        //Standard directory to place our image
         File storageDir = getExternalFilesDir(Environment.DIRECTORY_PICTURES);
         //creating image file using the method of CreateTempFile
         File image = File.createTempFile(
@@ -284,6 +262,10 @@ private File createImageFile() throws IOException {
         currentPhotoPath = image.getAbsolutePath();//using AbsolutePath of image ,image can be displayed in imageview
         return image;
     }
+        currentPhotoPath = image.getAbsolutePath();
+        return image;
+    }
+
     //this method opens the camera and save our image file into the directory
     private void dispatchTakePictureIntent() {
         Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
@@ -295,6 +277,7 @@ private void dispatchTakePictureIntent() {
             try {
                 photoFile = createImageFile();  //this returns image
             } catch (IOException ex) {
+                 System.out.println(ex.getMessage());
             }
             //Continue only if the File was successfully created
             if (photoFile != null) {
@@ -519,5 +502,4 @@ public void setCharacterMap(){
         }
         Log.d("SET CHAR MAP","WORKS");
     }
-
-}
+}