Storing raw data, so N*int32 in size.

Run length encoding, assumption is many numbers have long runs.

0's all have a count after them.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

Can change system settings eg log level.

Can edit detected diffraction peak status AND add user defined peaks.

Can create/edit/delete Element Sets.

Can edit/delete expressions, expression groups and data modules.

Can create/edit/delete Expression Groups (formerly known as RGB Mixes).

Can edit own user account, eg notifications, name, email etc.

Can write PIQUANT settings, eg current version to run.

Can create/edit/delete ROIs.

Can upload datasets, rename them, add images.

Can create+edit tags.

Can save view state.

Can export data.

https://protobuf.dev/programming-guides/dos-donts/ says specify something at 0.

PERM_BLESS_QUANT = 6; // Can mark a quant as "blessed".

Can run quant jobs.

Can read PIQUANT settings.

Can edit users, roles, create/delete user-groups.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

Really, this is likely a client-side error but included here so it's in the enum.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

For multi-channel analysis, so as source for binary plots, etc.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

Just for viewing, as a background to scan points/other data.

Instrument provided image, eg in PIXL case, it's an MCC image.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

Any uploaded image that's not sourced from the instrument.

JPL PIXL lab Breadboard.

PIXL engineering model.

PIXL flight model, now located on planet Mars.

Stony Brook Breadboard.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

https://protobuf.dev/programming-guides/dos-donts/ says specify an unknown as 0.

Enum value maps for Experiment_Location_SpectrumCompression.

Enum value maps for Experiment_Location_SpectrumCompression.

Enum value maps for Experiment_MetaDataType.

Enum value maps for Experiment_MetaDataType.

Enum value maps for ExportDataType.

Enum value maps for ExportDataType.

Enum value maps for JobStatus_JobType.

Enum value maps for JobStatus_JobType.

Enum value maps for JobStatus_Status.

Enum value maps for JobStatus_Status.

Enum value maps for NotificationMethod.

Enum value maps for NotificationMethod.

Enum value maps for NotificationType.

Enum value maps for NotificationType.

Enum value maps for ObjectType.

Enum value maps for ObjectType.

Enum value maps for Permission.

Enum value maps for Permission.

Enum value maps for Quantification_QuantDataType.

Enum value maps for Quantification_QuantDataType.

Enum value maps for QuantOutputType.

Enum value maps for QuantOutputType.

Enum value maps for ResponseStatus.

Enum value maps for ResponseStatus.

Enum value maps for ScanDataType.

Enum value maps for ScanDataType.

Enum value maps for ScanImagePurpose.

Enum value maps for ScanImagePurpose.

Enum value maps for ScanImageSource.

Enum value maps for ScanImageSource.

Enum value maps for ScanInstrument.

Enum value maps for ScanInstrument.

Enum value maps for ScanMetaDataType.

Enum value maps for ScanMetaDataType.

Enum value maps for SpectrumType.

Enum value maps for SpectrumType.

Enum value maps for UserGroupRelationship.

Enum value maps for UserGroupRelationship.

Enum value maps for VersionField.

Enum value maps for VersionField.

requires(PIXLISE_ADMIN).

This is a response to a GET so no request body.

Defines beam locations of an individual location.

We store physical location in these.

NOT stored in DB!.

requires(EDIT_EXPRESSION).

Data Modules are "shared" by default.

requires(NONE).

requires(NONE).

If id is blank, assume its new and generate an ID to return, otherwise update & return same one requires(EDIT_EXPRESSION).

requires(PIXLISE_ADMIN).

requires(NONE).

Users can mark detected diffraction peaks as valid/invalid, this is stored in DB for those statuses.

Diffraction detection algorithm delivers detected peaks via these structures.

requires(NONE).

requires(NONE).

requires(EDIT_DIFFRACTION).

requires(EDIT_DIFFRACTION).

requires(NONE).

requires(EDIT_DIFFRACTION).

requires(NONE).

requires(EDIT_DIFFRACTION).

requires(EDIT_ELEMENT_SET).

requires(NONE).

requires(NONE).

This is a view of ElementSet, only to be used when viewing a list of element sets, not intended to be in DB.

If id is blank, assume its new and generate an ID to return, otherwise update & return same one requires(EDIT_ELEMENT_SET).

Aligned context image - describes which PMC images are defined for, and if they're trapezoid corrected.

Spectrum data, stored as specified in spectrum_compression.

Storage of pseudo-intensities.

Matched context image - list of context images which have been transformed to match a given PMC's MCC image (in aligned_context_images), for example WATSON images.

If we have pseudo-intensity data, this will contain the labels of the elements from the CSV, along with their channel start/end.

A long time after we had individual datasets as above, we decided to support combination of multiple scans into one dataset.

requires(EXPORT).

requires(EDIT_EXPRESSION).

requires(NONE).

The user is configuring an expression for their own use, but not editing it requires(EDIT_OWN_USER).

requires(NONE).

requires(EDIT_EXPRESSION_GROUP).

requires(NONE).

TODO: Paginate? requires(NONE).

If id is blank, assume its new and generate an ID to return, otherwise update & return same one requires(EDIT_EXPRESSION_GROUP).

requires(NONE).

requires(NONE).

If id is blank, assume its new and generate an ID to return, otherwise update & return same one requires(EDIT_EXPRESSION).

requires(NONE).

requires(NONE).

requires(NONE).

requires(EDIT_SCAN).

requires(NONE).

requires(NONE).

requires(NONE).

If something happens to an image - changed, deleted, metadata changed, etc this gets sent out.

Full structure of an image and all locations returned along with the scan they are relative to.

Locations relative to the image.

requires(EDIT_SCAN).

requires(EDIT_SCAN).

requires(EDIT_SCAN).

Which API instance wants to handle this job? This is only used when it's an external request and APIs realise that an unknown job got completed.

requires(QUANTIFY).

requires(NONE).

Special permissions required to be able to read logs on certain pages requires(NONE).

Contains the string log level - if invalid, sends back bad request..

When a user suspects they see a diffraction peak they can log it using this structure.

requires(NONE).

requires(NONE).

requires(QUANTIFY).

requires(NONE).

requires(NONE).

requires(NONE).

Listing all available PIQUANT configs requires(READ_PIQUANT_SETTINGS).

Getting a specific PIQUANT version requires(READ_PIQUANT_SETTINGS).

Listing all available versions of a given PIQUANT config requires(READ_PIQUANT_SETTINGS).

Gets the current version of PIQUANT container that runs in API when quant is started requires(READ_PIQUANT_SETTINGS).

Listing versions of PIQUANT container to run in API when quant is started requires(READ_PIQUANT_SETTINGS).

Sets the current version of PIQUANT container to run in API when quant is started requires(EDIT_PIQUANT_SETTINGS).

requires(NONE).

requires(EDIT_EXPRESSION).

requires(NONE).

requires(QUANTIFY).

requires(QUANTIFY).

requires(QUANTIFY).

requires(QUANTIFY).

Updates are sent until the job timeout is reached, at which point a final update will be sent saying the job has timed out.

requires(QUANTIFY).

requires(NONE).

requires(NONE).

requires(NONE).

requires(NONE).

requires(NONE).

requires(NONE).

requires(NONE).

TODO: Quants likely need to change to accommodate quantifying spectra from multiple datasets together??.

requires(QUANTIFY).

requires(EDIT_ROI).

requires(EDIT_ROI).

requires(EDIT_ROI).

requires(NONE).

The user is configuring an ROI for their own use, but not editing it requires(EDIT_OWN_USER).

requires(NONE).

requires(NONE).

If id is blank, assume its new and generate an ID to return, otherwise update & return same one requires(EDIT_ROI).

requires(PIXLISE_ADMIN).

requires(PIXLISE_ADMIN).

Editing who to auto-share a scan with requires(EDIT_SCAN).

requires(EDIT_SCAN).

requires(NONE).

requires(EDIT_SCAN).

requires(NONE).

requires(NONE).

requires(NONE).

Describes a single image that is associated with a scan.

Contains the type and how many of each For PIXL: XRF (PMC count) IMAGE (MCC count+custom image count) RGBU (0 or 2).

Allows listing scans.

requires(NONE).

This should trigger a ScanListUpd to go out requires(EDIT_SCAN).

requires(QUANTIFY).

Triggering a re-import, should publish a ScanListUpd to go out Useful really only if there is a pipeline hooked up for this kind of data that we can re-trigger for.

This should trigger a ScanListUpd to go out requires(EDIT_SCAN).

requires(EDIT_VIEW_STATE).

requires(NONE).

requires(NONE).

requires(EDIT_VIEW_STATE).

requires(NONE).

requires(NONE).

requires(NONE).

requires(NONE).

Admin-only feature, to send out a notification to all users requires(PIXLISE_ADMIN).

requires(NONE).

requires(EDIT_TAGS).

requires(PIXLISE_ADMIN).

requires(NONE).

////////////////////////////////// Add a user role to a user requires(USER_ADMIN).

Changing user roles, this should publish a UserDetailsUpd.

Intended for DB serialisation only.

////////////////////////////////// Delete a user role for a user requires(USER_ADMIN).

Changing user roles, this should publish a UserDetailsUpd.

requires(NONE).

Changing user details, this should publish a UserDetailsUpd requires(EDIT_OWN_USER).

The user group sent out of API, contains "info" items of each user/user-group that's attached to it.

////////////////////////////////////////////////////////////// Adding and deleting admins from the group Should only be accessible to group admins and sys admins requires(NONE).

////////////////////////////////////////////////////////////// Adding and deleting members from the group Should only be accessible to group admins and sys admins requires(NONE).

////////////////////////////////////////////////////////////// Adding and deleting viewers from the group Should only be accessible to group admins and sys admins requires(NONE).

////////////////////////////////////////////////////////////// Creating, deleting and renaming entire groups Should only be accessible to sys admins requires(PIXLISE_ADMIN).

The UserGroup we store in DB.

requires(NONE).

requires(NONE).

requires(PIXLISE_ADMIN).

requires(NONE).

requires(PIXLISE_ADMIN).

requires(PIXLISE_ADMIN).

requires(NONE).

User Group Info, just the basics...

requires(NONE).

requires(NONE).

A request to join a user group - stored in DB.

requires(NONE).

requires(NONE).

requires(NONE).

Allows querying if we're impersonating anyone requires(NONE).

requires(PIXLISE_ADMIN).

requires(USER_ADMIN).

NOTE: Need to ensure topic name (string key in map) is the same across all users of these messages!.

Retrieving a users notification settings (NOT the notifications themselves) requires(NONE).

Modifying notifications should publish a UserNotificationSettingsUpd requires(EDIT_OWN_USER).

////////////////////////////////// Get all user roles requires(USER_ADMIN).

////////////////////////////////// Get roles for a given user requires(USER_ADMIN).

requires(NONE).

This is a response to a GET so no request body.

requires(NONE).

requires(EDIT_VIEW_STATE).

The overall wrapper WSMessage.

requires(NONE).

These are the permissions a user can have.

This is expected to appear in all Resp messages.

Image purpose - is it just for viewing, or perhaps it provides channel data to some algorithm.

Where it came from - the instrument or some other source.