README

SLED

Sled is a UI for grid-based user-driven image segmentation. Applications in processing of natural history specimen collections.

Running locally

npm install

npm run serve

Navigate to http://localhost:8080/ in your browser.

Installation

With NPM

npm install @sfg/sled

For Vue.js 3

Import component

import SledComponent from '@sfg/sled'

export default {
  components: {
    SledComponent
  }
}

Typical use

<sled-component
  :vertical-lines="vlines"
  :horizontal-lines="hlines"
  :image-width="width"
  :image-height="height"
  :line-weight="lineWeight"
  :scale="scaleForScreen"
  :file-image="fileImage"
  @onComputeCells="saveCells"/>

Events

onComputedCells

Event is triggered each time when horizontal and vertical lines are added and computed to create the cells. Contains information of computed cells.

{
  "index":2,
  "upperCorner":{"x":3689.25, "y":0},
  "lowerCorner":{"x":4919, "y":1700.75},
  "row": 0,
  "column": 2
}

Also tracks a metadata label.

{ 
 "metadata": 'some label',
}

Props

fileImage

Type: String
Required: false
Default: ''

image-width

Type: Number
Required: true

image-height

Type: Number
Required: true

vertical-lines

Type: Array
Required: false
Default: []

horizontal-lines