event#

Classes:

CheckpointEvent

An event type indicating a checkpoint in the job's execution.

Event

Base class for all event types.

ImageEvent

An event with an image and optional text.

InteractiveEvent

An event with an interactive plot and optional text.

InteractiveImgfile

An image file associated with an interactive event, along with its components.

TextEvent

An event with only text and no additional image or interactive data.

class CheckpointEvent#

An event type indicating a checkpoint in the job’s execution.

Attributes:

avail_mb

Available worker system memory at the time of the event, in MB.

cpumem_mb

CPU memory used by the job process at the time of the event, in MB.

created_at

When this object was first created.

flags

List of flags associated with this event.

id

job_uid

Job UID that this event belongs to.

meta

Metadata associated with this event.

project_uid

Project UID that this event belongs to.

type

Checkpoint events always have type 'checkpoint'.

updated_at

When this object was last modified.

avail_mb: float | None#

Available worker system memory at the time of the event, in MB.

cpumem_mb: float | None#

CPU memory used by the job process at the time of the event, in MB.

created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

flags: List[str]#

List of flags associated with this event.

id: str#
job_uid: str#

Job UID that this event belongs to.

meta: Dict[str, Any]#

Metadata associated with this event.

project_uid: str#

Project UID that this event belongs to.

type: Literal['checkpoint']#

Checkpoint events always have type ‘checkpoint’.

updated_at: datetime#

When this object was last modified.

class Event#

Base class for all event types.

Attributes:

avail_mb

Available worker system memory at the time of the event, in MB.

cpumem_mb

CPU memory used by the job process at the time of the event, in MB.

created_at

When this object was first created.

flags

List of flags associated with this event.

id

job_uid

Job UID that this event belongs to.

meta

Metadata associated with this event.

project_uid

Project UID that this event belongs to.

updated_at

When this object was last modified.

avail_mb: float | None#

Available worker system memory at the time of the event, in MB.

cpumem_mb: float | None#

CPU memory used by the job process at the time of the event, in MB.

created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

flags: List[str]#

List of flags associated with this event.

id: str#
job_uid: str#

Job UID that this event belongs to.

meta: Dict[str, Any]#

Metadata associated with this event.

project_uid: str#

Project UID that this event belongs to.

updated_at: datetime#

When this object was last modified.

class ImageEvent#

An event with an image and optional text. Used for plots.

Attributes:

avail_mb

Available worker system memory at the time of the event, in MB.

cpumem_mb

CPU memory used by the job process at the time of the event, in MB.

created_at

When this object was first created.

flags

List of flags associated with this event.

id

imgfiles

List of image assets associated with the event.

job_uid

Job UID that this event belongs to.

meta

Metadata associated with this event.

project_uid

Project UID that this event belongs to.

text

Text description of the image event.

type

Image events always have type 'image'.

updated_at

When this object was last modified.

avail_mb: float | None#

Available worker system memory at the time of the event, in MB.

cpumem_mb: float | None#

CPU memory used by the job process at the time of the event, in MB.

created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

flags: List[str]#

List of flags associated with this event.

id: str#
imgfiles: List[GridFSAsset]#

List of image assets associated with the event.

job_uid: str#

Job UID that this event belongs to.

meta: Dict[str, Any]#

Metadata associated with this event.

project_uid: str#

Project UID that this event belongs to.

text: str#

Text description of the image event.

type: Literal['image']#

Image events always have type ‘image’.

updated_at: datetime#

When this object was last modified.

class InteractiveEvent#

An event with an interactive plot and optional text. Used for 3D scatter plots.

Attributes:

avail_mb

Available worker system memory at the time of the event, in MB.

components

List of data component indices included in this interactive event.

cpumem_mb

CPU memory used by the job process at the time of the event, in MB.

created_at

When this object was first created.

datafile

in v4 the fileid field was stored as an ObjectID instead of str.

flags

List of flags associated with this event.

id

job_uid

Job UID that this event belongs to.

meta

Metadata associated with this event.

preview_imgfiles

List of preview image files associated with the interactive event.

project_uid

Project UID that this event belongs to.

subtype

Subtype of interactive event, e.g. '3dscatter'.

text

type

Interactive events always have type 'interactive'.

updated_at

When this object was last modified.

avail_mb: float | None#

Available worker system memory at the time of the event, in MB.

components: List[int]#

List of data component indices included in this interactive event.

cpumem_mb: float | None#

CPU memory used by the job process at the time of the event, in MB.

created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

datafile: GridFSAsset#

in v4 the fileid field was stored as an ObjectID instead of str. If a user needs to downgrade an migrate the fileid back to ObjectID, use the following commands:

csm icli
from bson import ObjectId
interactive_events = db.events.find({"type": "interactive"})
for event in interactive_events:
    db.events.update_one({"_id": event["_id"]}, {"$set": {"datafile.fileid": ObjectId(event["datafile"]["fileid"])}})
Type:

Legacy note

flags: List[str]#

List of flags associated with this event.

id: str#
job_uid: str#

Job UID that this event belongs to.

meta: Dict[str, Any]#

Metadata associated with this event.

preview_imgfiles: List[InteractiveImgfile]#

List of preview image files associated with the interactive event.

project_uid: str#

Project UID that this event belongs to.

subtype: str#

Subtype of interactive event, e.g. ‘3dscatter’.

text: str#
type: Literal['interactive']#

Interactive events always have type ‘interactive’.

updated_at: datetime#

When this object was last modified.

class InteractiveImgfile#

An image file associated with an interactive event, along with its components.

Attributes:

components

List of data component indices which this image file represents.

imgfiles

List of image assets.

components: List[int]#

List of data component indices which this image file represents.

imgfiles: List[GridFSAsset]#

List of image assets.

class TextEvent#

An event with only text and no additional image or interactive data. May have “text”, “warning” or “error” type.

Attributes:

avail_mb

Available worker system memory at the time of the event, in MB.

cpumem_mb

CPU memory used by the job process at the time of the event, in MB.

created_at

When this object was first created.

flags

List of flags associated with this event.

id

job_uid

Job UID that this event belongs to.

meta

Metadata associated with this event.

project_uid

Project UID that this event belongs to.

text

Text content of the event.

type

'text', 'warning', or 'error'.

updated_at

When this object was last modified.

avail_mb: float | None#

Available worker system memory at the time of the event, in MB.

cpumem_mb: float | None#

CPU memory used by the job process at the time of the event, in MB.

created_at: datetime#

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

flags: List[str]#

List of flags associated with this event.

id: str#
job_uid: str#

Job UID that this event belongs to.

meta: Dict[str, Any]#

Metadata associated with this event.

project_uid: str#

Project UID that this event belongs to.

text: str#

Text content of the event.

type: Literal['text', 'warning', 'error']#

‘text’, ‘warning’, or ‘error’.

Type:

Type of text event

updated_at: datetime#

When this object was last modified.