Skip to main content
GET
/
optical
/
timeseries
/
{data_id}
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
optical = results[0]  # OpticalResult
print(optical.timeseries_data)
{
  "series": [
    {
      "relative_time_seconds": 0.0,
      "unix_timestamp_ms": 1705312200000,
      "frame_number": 0,
      "perimeter_px": 245.3,
      "circularity": 0.87,
      "edge_roughness": 0.12,
      "hausdorff_px": 3.5
    },
    {
      "relative_time_seconds": 1.0,
      "unix_timestamp_ms": 1705312201000,
      "frame_number": 30,
      "perimeter_px": 248.1,
      "circularity": 0.85,
      "edge_roughness": 0.14,
      "hausdorff_px": 3.8
    }
  ]
}
Returns processed timeseries data from optical image analysis during growth. Each data point corresponds to a video frame and may include computed morphology metrics such as perimeter, circularity, and edge roughness.
data_id
string
required
The data entry UUID for the optical measurement
return_null_if_missing
boolean
default:"false"
If true, returns null instead of an error when no timeseries data exists for this entry

Response

series
array
Array of per-frame measurement data points
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
optical = results[0]  # OpticalResult
print(optical.timeseries_data)
{
  "series": [
    {
      "relative_time_seconds": 0.0,
      "unix_timestamp_ms": 1705312200000,
      "frame_number": 0,
      "perimeter_px": 245.3,
      "circularity": 0.87,
      "edge_roughness": 0.12,
      "hausdorff_px": 3.5
    },
    {
      "relative_time_seconds": 1.0,
      "unix_timestamp_ms": 1705312201000,
      "frame_number": 30,
      "perimeter_px": 248.1,
      "circularity": 0.85,
      "edge_roughness": 0.14,
      "hausdorff_px": 3.8
    }
  ]
}