Skip to main content
GET
/
rheed
/
images
/
{data_id}
/
mask
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
image = results[0]  # RHEEDImageResult
mask = image.mask  # numpy array

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "mask_rle": "0 100 1 50 0 200 ...",
  "mask_height": 512,
  "mask_width": 512
}
Returns the automatically detected mask for a RHEED image, encoded using run-length encoding (RLE). The mask identifies relevant diffraction regions in the RHEED pattern.
​
data_id
string
required
The data entry UUID for the RHEED image

​
Response

​
data_id
string
Data entry UUID
​
processed_data_id
string
Processed data entry UUID
​
mask_rle
string
Run-length encoded mask data
​
mask_height
integer
Height of the mask in pixels
​
mask_width
integer
Width of the mask in pixels
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
image = results[0]  # RHEEDImageResult
mask = image.mask  # numpy array

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "processed_data_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "mask_rle": "0 100 1 50 0 200 ...",
  "mask_height": 512,
  "mask_width": 512
}