Get RHEED Frame Masks

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")

# Decoded arrays keyed by absolute frame number
masks = client.get_frame_masks(
    "d290f1ee-6c54-4b01-90e6-d701748f0851",
    from_frame=0,
    to_frame=200,
    decode=True,
)
print(masks[0].shape)  # (H, W) uint8, values 0/1

import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks",
    params={"from": 0, "to": 200},
    headers={"X-API-KEY": "YOUR_API_KEY"},
)
rows = response.json()

curl "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks?from=0&to=200" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 0,
    "mask_rle": "PZ`0c0X<f0^C...",
    "mask_height": 512,
    "mask_width": 512
  },
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 1,
    "mask_rle": "Ub`0d0W<g0]C...",
    "mask_height": 512,
    "mask_width": 512
  }
]

GET

rheed

images

{data_id}

frame_masks

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")

# Decoded arrays keyed by absolute frame number
masks = client.get_frame_masks(
    "d290f1ee-6c54-4b01-90e6-d701748f0851",
    from_frame=0,
    to_frame=200,
    decode=True,
)
print(masks[0].shape)  # (H, W) uint8, values 0/1

import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks",
    params={"from": 0, "to": 200},
    headers={"X-API-KEY": "YOUR_API_KEY"},
)
rows = response.json()

curl "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks?from=0&to=200" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 0,
    "mask_rle": "PZ`0c0X<f0^C...",
    "mask_height": 512,
    "mask_width": 512
  },
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 1,
    "mask_rle": "Ub`0d0W<g0]C...",
    "mask_height": 512,
    "mask_width": 512
  }
]

Returns the binary segmentation mask for each featurized frame of a processed RHEED video, encoded using run-length encoding (RLE) in the same COCO format as the single-image mask. frame_number is the absolute frame index, keyed identically to the processed video frames and to the Frame Number axis of the RHEED timeseries, so a decoded mask overlays the matching frame of the processed video.

Coverage is sparse. Masks exist only for featurized frames: every frame for stationary videos, but only the sampled subset for rotating and per-azimuth videos. Frames without a mask are absent from the response rather than returned as null.

string

required

The data entry UUID of the RHEED video, the same ID used for the video and timeseries

integer

default:"0"

First absolute frame number to return, inclusive

integer

Last absolute frame number to return, inclusive. Omit to return every featurized frame from from onward

Response

Returns an array of mask records.

string

Data entry UUID

string

Processed data entry UUID

integer

Absolute frame index within the video

string

Run-length encoded mask data, column-major (Fortran order)

integer

Height of the mask in pixels

integer

Width of the mask in pixels

A 404 means the video has no per-frame mask artifact, either because the item is not RHEED or because it was processed before per-frame masks were persisted.

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")

# Decoded arrays keyed by absolute frame number
masks = client.get_frame_masks(
    "d290f1ee-6c54-4b01-90e6-d701748f0851",
    from_frame=0,
    to_frame=200,
    decode=True,
)
print(masks[0].shape)  # (H, W) uint8, values 0/1

import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks",
    params={"from": 0, "to": 200},
    headers={"X-API-KEY": "YOUR_API_KEY"},
)
rows = response.json()

curl "https://api.atomscale.ai/rheed/images/d290f1ee-6c54-4b01-90e6-d701748f0851/frame_masks?from=0&to=200" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 0,
    "mask_rle": "PZ`0c0X<f0^C...",
    "mask_height": 512,
    "mask_width": 512
  },
  {
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "frame_number": 1,
    "mask_rle": "Ub`0d0W<g0]C...",
    "mask_height": 512,
    "mask_width": 512
  }
]

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Metrology

Tags

Target Materials

Instruments

Response

​Response

Response