vottsuper-ct

CanvasTools editor for the vott-super project! Fork from https://github.com/microsoft/CanvasTools-for-VOTT


Keywords
vottsuper
License
ISC
Install
npm install vottsuper-ct@2.0.0

Documentation

1.7.2.2版本更新日志

添加标签编辑窗口,按E键编辑,按tab键切换标签
按alt键可以使选中框外的其他框锁定
修正图像缩放功能,能够标注一些小目标
添加画人车3D功能,可调整大小
修正鼠标停在目标区域导致下一张不能创建标注的问题
点下一张图会自动保存,当前图s或者ctl+s保存
多段线功能将原矩形拖动改为线条拖动,多边形将原矩形拖动改为多边形内部
将原有的着色改为:1.默认为线条加0.5透明的边沿;2.鼠标悬停为0.8透明矩形;3.线条选中仅显示多段线
多标签问题:由于Pascal导出只能使用一个类别,为了更加直观,以标注颜色为统一,选对应颜色的那个类别,为靠前的类别
还存在的bug: Ctrl点击锚点会删除该点,要移动任意一点才能保存

CanvasTools librarary for VoTT

CanvasTools is one of the UI modules used in the VoTT project. The library impelements the following core features:

  • Region (box) selection & manipulation
  • Filters pipeline for underlaying canvas element
  • Toolbar for all available tools

Dependencies

  • CanvasTools heavily uses the Snap.Svg library. In the webpack-eged version it is bundled with CanvasTools into one ct.js file, including also styles.
  • Current version of the library depends on some features (e.g., masks-support in SVG) that are not fully cross-browser, but targeting Electron (Chromium).

How to use

Install npm package

Install package from npm:

npm i vott-ct

The package structure:

dist/
    ct.d.ts - bundled typings
    ct.js - webpack bundle for production ({tsc->commonjs, snapsvg, styles} -> umd)
    ct.js.map - source map for ct.js
    ct.min.js -- webpack minimized bundle for production
    ct.min.js.map - source map for ct.min.js
    ct.dev.js -- webpack bundle for development (incl source map)
lib/
    css/
        canvastools.css
    icons/
        {collection of svg icons for toolbar}
    ct.d.ts - typings generated by tcs
    ct.js - AMD module generated by tcs
    ct.js.map - map file generated by tcs

Add library to the app

Add the ct.js file to your web-app (e.g., an Electron-based app).

<script src="ct.js"></script>
<!-- OR -->
<script src="ct.min.js"></script>

Copy toolbar icons from the src folder to your project.

Create a reference to the CanvasTools.

let ct = CanvasTools.CanvasTools;

Add Editor to the page

Add container elements to host SVG elements for the toolbar and the editor.

<div id="ctZone">
    <div id="toolbarzone"></div>
    <div id="selectionzone">
        <div id="editorzone"></div>
    </div>
</div>

Initiate Editor-object from the CanvasTools.

var sz = document.getElementById("editorzone");
var tz = document.getElementById("toolbarzone");

var editor = new ct.Editor(sz);
editor.addToolbar(tz, ct.Editor.FullToolbarSet, "./images/icons/");

The editor will auto-adjust to available space in provided container block. FullToolbarSet icons set is used by default and exposes all available tools. The RectToolbarSet set contains only box-creation tools. Correct the path to toolbar icons based on the structure of your project.

Add callbacks to the Editor

Add a callback for onSelectionEnd event to define what should happen when a new region is selected. Usually at the end of processing new region you want to add it actuall to the screen. Use .RM.addPointRegion to register point-based regions, and .RM.addRectRegion to register box-based regions.

// Callback for onSelectionEnd
editor.onSelectionEnd = (commit) => {
    let r = commit.boundRect;
  
    // Build a random tags collection
    let tags = generateTagDescriptor();

    // Add new region to the Editor based on selection type
    if (commit.meta !== undefined && commit.meta.point !== undefined) {
        let point = commit.meta.point;
        editor.RM.addPointRegion((incrementalRegionID++).toString(), new ct.Core.Point2D(point.x, point.y), tags);
    } else {
        editor.RM.addRectRegion((incrementalRegionID++).toString(), new ct.Core.Point2D(r.x1, r.y1), new ct.Core.Point2D(r.x2, r.y2), tags);
    }
}

// Generate random tags
let primaryTag = new ct.Core.Tag(
                        (Math.random() > 0.5) ? "Awesome" : "Brilliante",
                        Math.floor(Math.random() * 360.0));
let secondaryTag = new ct.Core.Tag(
                        (Math.random() > 0.5) ? "Yes" : "No",
                        Math.floor(Math.random() * 360.0));
let ternaryTag = new ct.Core.Tag(
                        (Math.random() > 0.5) ? "one" : "two",
                        Math.floor(Math.random() * 360.0));

function generateTagDescriptor() {
    let tags = (Math.random() < 0.3) ?
                    new ct.Core.TagsDescriptor(primaryTag, [secondaryTag, ternaryTag]):
                ((Math.random() > 0.5) ?
                    new ct.Core.TagsDescriptor(secondaryTag, [ternaryTag, primaryTag]):
                    new ct.Core.TagsDescriptor(ternaryTag, [primaryTag, secondaryTag]));

    return tags
}

Update background

Once the background image for tagging task is loaded (or a video element is ready, or a canvas element), pass it to the editor as a new content source.

let imagePath = "./../images/background-forest-v.jpg";
let image = new Image();
image.addEventListener("load", (e) => {
    editor.addContentSource(e.target);
});
image.src = imagePath;