Skip to content

docs: BROS-157: Add Bitmask docs + update schema.json #7882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/source/tags/bitmask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Bitmask
type: tags
order: 401
meta_title: Bitmask Tag for Image Segmentation Labeling
meta_description: Customize Label Studio with bitmask pixel-wise tags for image segmentation labeling for machine learning and data science projects.
---

The `Bitmask` tag for pixel-wise image segmentation tasks is used in the area where you want to apply a mask or use a brush to draw a region on the image.

`Bitmask` operates on pixel level and outputs a Base64 encoded PNG data URL image with black pixels on transparent background.

Export data example: `data-url:image/png;[base64-encoded-string]`

**Note:** You need to set `smoothing="false"` on the Image tag to be able to work with individual pixels;

<video class="Video astro-OQEP7KKB" loop="" playsinline="" autoplay="" muted="">
<source src="https://cdn.sanity.io/files/mzff2hy8/production/4812f66851a7fd4836e729bc7ccb7e510823af5d.mp4" type="video/mp4" class="astro-OQEP7KKB">
</video>

Use with the following data types: image.

{% insertmd includes/tags/bitmask.md %}

### Example

Basic image segmentation labeling configuration:

```xml
<View>
<Bitmask name="bitmask" toName="image" />
<Labels name="labels" toName="image">
<Label value="Person" />
<Label value="Animal" />
</Labels>
<Image name="image" value="$image" />
</View>
```
37 changes: 37 additions & 0 deletions docs/source/tags/bitmasklabels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: BitmaskLabels
type: tags
order: 402
meta_title: Bitmask Label Tag for Pixel-Wise Image Segmentation Labeling
meta_description: Customize Label Studio with bitmask pixel-wise label tags for image segmentation labeling for machine learning and data science projects.
---

The `BitmaskLabels` tag for pixel-wise image segmentation tasks is used in the area where you want to apply a mask or use a brush to draw a region on the image.

`BitmaskLabels` operates on pixel level and outputs a Base64 encoded PNG data URL image with black pixels on transparent background.

Export data example: `data-url:image/png;[base64-encoded-string]`

**Note:** You need to set `smoothing="false"` on the Image tag to be able to work with individual pixels;

<video class="Video astro-OQEP7KKB" loop="" playsinline="" autoplay="" muted="">
<source src="https://cdn.sanity.io/files/mzff2hy8/production/4812f66851a7fd4836e729bc7ccb7e510823af5d.mp4" type="video/mp4" class="astro-OQEP7KKB">
</video>

Use with the following data types: image.

{% insertmd includes/tags/bitmasklabels.md %}

### Example

Basic image segmentation labeling configuration

```html
<View>
<BitmaskLabels name="labels" toName="image">
<Label value="Person" />
<Label value="Animal" />
</BitmaskLabels>
<Image name="image" value="$image" />
</View>
```
Loading
Loading