Skip to main content
GET
/
rheed
/
images
/
compare
/
import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/images/compare/",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={
        "data_id_1": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "data_id_2": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
    }
)
comparison = response.json()

{
  "data_id_1": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "data_id_2": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "referenced_strain": 0.42,
  "spot_count": {
    "initial": 12,
    "final": 18,
    "percent_change": 50.0
  },
  "mask_gained": {
    "mask_rle": "0 100 1 50 0 200 ...",
    "mask_height": 512,
    "mask_width": 512
  },
  "mask_lost": null
}
Compares two RHEED images and reports how the diffraction pattern changed between them, including the difference in spot count, the referenced strain, and the mask regions gained or lost.
​
data_id_1
string
required
The data entry UUID for the first (initial) RHEED image
​
data_id_2
string
required
The data entry UUID for the second (final) RHEED image

​
Response

​
data_id_1
string
Data entry UUID for the first image
​
data_id_2
string
Data entry UUID for the second image
​
referenced_strain
number
Strain of the second image referenced against the first
​
spot_count
object
Change in the number of detected diffraction spots between the two images.
​
mask_gained
object
Mask region present in the second image but not the first, encoded using run-length encoding (RLE). Null if no region was gained.
​
mask_lost
object
Mask region present in the first image but not the second, encoded using run-length encoding (RLE). Null if no region was lost.
import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/images/compare/",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={
        "data_id_1": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "data_id_2": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
    }
)
comparison = response.json()

{
  "data_id_1": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "data_id_2": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "referenced_strain": 0.42,
  "spot_count": {
    "initial": 12,
    "final": 18,
    "percent_change": 50.0
  },
  "mask_gained": {
    "mask_rle": "0 100 1 50 0 200 ...",
    "mask_height": 512,
    "mask_width": 512
  },
  "mask_lost": null
}