Skip to content

Latest commit

 

History

History
110 lines (91 loc) · 4.41 KB

README.md

File metadata and controls

110 lines (91 loc) · 4.41 KB
Raw

ImageLabelView

简体中文 | My Blog(Chinese)

A view for data-labeling(a tool for machine learning).

1 2

Install

Step 1. Add it in your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.SirLYC:ImageLabelView:{latest version}'
}

Use

You can check sample code here

Step1. Add to your layout

Step2. Set a LabelCreator The labelCreator is used when you draw a new label. It can create a new label via its createLabel() method. First, you need to implement a

ImageLabelView#LabelCreator.

There is a simple implementation in sample code for rect label:

label.labelCreator = object : ImageLabelView.LabelCreator {
            override fun createLabel(): RectLabel {
                return RectLabel()
            }
        }

Remember to set it to set it to ImageLabelView's labelCreator.

You can create any type of Label which may return different kinds of data.

Step3. Set an image to the view

Set a bitmap to the ImageLabelView, and it will start to show this phone like a imageView with center inside mode. The bitmap can be null, which will let the view clear old labels...

val bitmap: Bitmap? = ... // download or read from disk
label.setBitmap(bitmap)

Step4. Do your job in different mode

When a nonnull bitmap is present, there are 4 modes to operate a image.

  • PREVIEW
    This is default mode. Everytime a new bitmap is set to this view, the mode will change to it. In this mode, you can move or scale the image to the perfect position and size for labelling.
  • DRAW
    In this mode, you can draw a new label. Take rectangle for example. When your finger touch the screen and move, there will be a rectangle right on the image whose left and top is your start posintion and right and bottom is your end position. After your finger up, the view will immediately change to SELECT mode.
  • UPDATE
    In this mode, you can resize or change label's position. Take rectangle for example, you can drag a regtangle' vertext or a egde to resize it, or move the whole of the rectange (when your finger down right in the rectangle).
  • SELECT
    When click or long press, a rectangle at your finger's position will be selected (if drawing end, the new-created label will be selected automatically.). When a label is selected, you can get it by
label.selectingLabel()

At this time, you may let user to input or do other things to change the message of the label or just delete it.

Step5. Export your data Just get the label and call it's getData() or get its message property!

Todo/Fix

  • fix multi-selection problem when tap once
  • fix state loss after config changes (such as screen orientation, languages...)
  • circle label
  • triangle label
  • other polygon label...

License

MIT License

Copyright (c) 2019 Liu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.