theaiscope / gdd-app

Global Disease Database – Android app to gather images for disease detection

GDD-app

How to contribute

• Pick a task from our kanban board on trello
• Make sure the tests pass on Bitrise.
• Open a Pull Request, or ask to be added to the repository and commit directly to master

Setting up the development environment

Requirements:

1. Java 17
2. Android Studio
3. Android SDK

Steps:

1. Install Android Studio: https://developer.android.com/studio/ or brew cask install android-studio
2. Clone the repository to your computer
3. Open Android Studio, select “Import”, and select the location where you’ve cloned the app
4. [OPTIONAL] Copy properties/secrets.sample.properties to properties/secrets.properties and replace the placeholders
5. Make sure the build succeeds - follow the instructions in the “build window”, e.g. to install the Android SDK and accept licenses
6. Run the app on an emulator: Follow the app tutorial (https://developer.android.com/training/basics/firstapp/running-app) ‘s section Run on an emulator

Learning Resources

kotlin:
https://kotlinlang.org/docs/reference/android-overview.html

android:
https://developer.android.com/training/basics/firstapp/creating-project
https://antonioleiva.com/free-guide/
https://www.raywenderlich.com/library?domain_ids%5B%5D=2

Good Android tutorials:
https://www.raywenderlich.com/library?domain_ids%5B%5D=2

Android course:
https://developer.android.com/courses

Further documentation

Find more documentation in the doc folder, for example:

• Application architecture
• UI Design
• Architecture Decision Records

gdd-app's Issues

Add zoom ability in the image capture screen

The user should be able to zoom in/out using gestures (pinch in / pinch out) as far as the camera hardware makes it possible.

Fix image manipulation gestures on the masking screen

Current behaviour

• Zooming in/out is possible while in drawing mode or erasing mode
• While in zoom mode, zooming in/out doesn't follow the movement of the fingers, the image jumping around unpredictably

Expected behaviour

• Zooming in/out is NOT possible while in drawing mode or erasing mode, but only when in Zoom mode
• While in zoom mode, zooming in/out follows the movement of the fingers, or in other words, zoom on the pinched area

Downscale images larger than the maximum bitmap size

In the mask layer, we are loading a large bitmap that comes from the camera. However, on some devices, this bitmap exceeds the maximum size that can be loaded in a canvas. For example, on a Redmi 6A device, the picture is 3120x4160 in size, whereas the maximum bitmap can be 4096x4096.
As a solution, downscale the image so that it fits in the constraints.

See https://stackoverflow.com/questions/7428996/hw-accelerated-activity-how-to-get-opengl-texture-size-limit

Add functionality to the exit button in the picture taking flow

Clicking the top-left exit button on any of the three screens of the picture taking flow (Capture, Mask/Highlight and Metadata) should display a confirmation modal dialog as in this Invision screen. The positive option will exit the flow to the homepage.

Improve caching of Bitmaps by adding an in-memory LRU cache

Right now, thumbnails that appear on the metadata screen are cached on disk, using the decodeSampledBitmapAndCache() method from the BitmapReader class. This could be improved further by adding an intermediate layer of caching, in-memory LRU cache, implemented using the androidx.collection.LruCache class from AndroidX.

This cache could also be used for the blank Bitmap that currently gets created every time a mask is saved, here:

GDD-app/app/src/main/java/net/aiscope/gdd_app/ui/mask/MaskActivity.kt

Line 199 in 20117b4

Bitmap.createBitmap(maskBitmap.width, maskBitmap.height, maskBitmap.config)

An additional requirement would be for this in-memory cache to react to low memory conditions. This can be achieved by overriding the onTrimMemory() method in the Application class, and depending on the level, evict an adequate number of bitmaps, using the trimToSize() method.

Relevant Android guide: https://developer.android.com/topic/performance/graphics/cache-bitmap#memory-cache

Explore using KTX Graphics extensions

Explore making use of the KTX Graphics extensions library, to make the code around graphics nicer.

A good article on the topic can be found here: https://blog.stylingandroid.com/ktx-graphics/

Explore use of RGB_565 format instead of ARGB_8888 for displaying images in the app

Inspired by https://proandroiddev.com/measure-and-optimize-bitmap-size-using-glide-or-picasso-3273b4a569cd

How about if use RGB_565 format instead of ARGB_8888 for loading the images in the app (we could still save the full quality image in the dataset)? The difference in quality would probably be barely noticeable, but it would use half of the memory.

Add lint and fix issues

What the title says.

Integrate Detekt into the project

Integrate https://github.com/arturbosch/detekt and fix detected code smells.