5.1. Messages¶

5.1.1. AddRequiredTiles¶

ADD_REQUIRED_TILES Provides a list of tiles that are required for the specified file

Field	Type	Label	Description
file_id	sfixed32		The file ID that the view corresponds to
tiles	sfixed32	repeated	The list of tiles required, in encoded coordinate
compression_type	CompressionType		The compression algorithm used
compression_quality	float		Compression quality switch

5.1.2. AnimationFlowControl¶

Source file: control/animation.proto

ANIMATION_FLOW_CONTROL Used for informing the backend of which frames have been received

Field	Type	Description
file_id	sfixed32
received_frame	AnimationFrame	The latest flow control frame received
animation_id	sfixed32	The animation ID that the flow control message belongs to
timestamp	sfixed64	Timestamp at which the frame was received

5.1.3. CatalogFileInfoRequest¶

Source file: request/catalog_file_info.proto

Field	Type	Label	Description
directory	string
name	string

5.1.4. CatalogFileInfoResponse¶

Source file: request/catalog_file_info.proto

Field	Type	Label
success	bool
message	string
file_info	CatalogFileInfo
headers	CatalogHeader	repeated

5.1.5. CatalogFilterRequest¶

Source file: stream/catalog_filter.proto

Field	Type	Label
file_id	sfixed32
column_indices	int32	repeated
filter_configs	FilterConfig	repeated
subset_data_size	sfixed32
subset_start_index	sfixed32
image_bounds	CatalogImageBounds
image_file_id	sfixed32
region_id	sfixed32
sort_column	string
sorting_type	SortingType

5.1.6. CatalogFilterResponse¶

Source file: stream/catalog_filter.proto

Field	Type	Label
file_id	sfixed32
image_file_id	sfixed32
region_id	sfixed32
columns	map<key: fixed32, value: ColumnData>	repeated
subset_data_size	sfixed32
subset_end_index	sfixed32
progress	float
filter_data_size	sfixed32
request_end_index	sfixed32

5.1.7. CatalogListRequest¶

Source file: request/catalog_list.proto

Field	Type	Label	Description
directory	string
filter_mode	FileListFilterMode		Filter mode to use when showing the file list

5.1.8. CatalogListResponse¶

Source file: request/catalog_list.proto

Field	Type	Label
success	bool
message	string
directory	string
parent	string
files	CatalogFileInfo	repeated
subdirectories	DirectoryInfo	repeated
cancel	bool

5.1.9. CloseCatalogFile¶

Source file: control/open_catalog_file.proto

Field	Type	Label	Description
file_id	sfixed32

5.1.10. CloseFile¶

Source file: control/close_file.proto

CLOSE_FILE: Instructs the backend to close a file with a given file ID

Field	Type	Label	Description
file_id	sfixed32		Which “file” slot to close

5.1.11. ClosePvPreview¶

Source file: control/stop_pv_calc.proto

Field	Type	Label	Description
preview_id	sfixed32		Close the PV preview for the preview viewer id

5.1.12. ConcatStokesFiles¶

Source file: control/concat_stokes_files.proto

CONCAT_STOKES_FILES: Requests to concatenate individual stokes images as one and open it. Backend responds with CONCAT_STOKES_FILES_ACK

Field	Type	Label	Description
stokes_files	StokesFile	repeated	Stokes files to be concatenated
file_id	sfixed32		File ID for the concatenate image
render_mode	RenderMode		The render mode to use. Additional modes will be added in subsequent versions.

5.1.13. ConcatStokesFilesAck¶

Source file: control/concat_stokes_files.proto

Field	Type	Description
success	bool	Concatenation is successful or not
message	string	Error message if not successful
open_file_ack	OpenFileAck	Open file acknowledgement for the concatenate file

5.1.14. ContourImageData¶

Source file: stream/contour_image.proto

CONTOUR_IMAGE_DATA: Data for an image rendered in contour mode.

Field	Type	Label	Description
file_id	sfixed32		The file ID that the contour image corresponds to
reference_file_id	fixed32		The file ID of the reference image that the contour vertices are mapped to
image_bounds	ImageBounds		The bounding box in the XY plane corresponding to the image data in pixel coordinates
channel	sfixed32		The image channel used to generate the contours
stokes	sfixed32		The image stokes parameter used to generate the contours
contour_sets	ContourSet	repeated	Each contour set consists of the contour level value, as well as a list of coordinates. The start_indices list is used to determine how to subdivide the coordinates list into separate poly-lines when rendering.
progress	double		Progress of the contour sets being sent. If this is zero, the message is assumed to contain the entire contour sets

5.1.15. ContourSet¶

Source file: stream/contour_image.proto

Field	Type	Label	Description
level	double
decimation_factor	int32
raw_coordinates	bytes
raw_start_indices	bytes
uncompressed_coordinates_size	int32

5.1.16. ErrorData¶

Source file: stream/error.proto

ERROR_DATA: Stream of error/warning/info data. This stream is used to present the frontend with additional information on the state of the backend, and is not used in place of returning success=false on requests or commands.

Field	Type	Label	Description
severity	ErrorSeverity		The severity of the error. Critical errors are reserved for errors that would normally require the user to restart the program or reload the page
tags	string	repeated	A list of strings describing the error type, that the frontend can interpret and react to. For example, “file_io” or “memory”.
message	string		The error message
data	string		Accompanying error data. For example, if an error has the “file_io” tag, the frontend would expect the data field to contain the file ID of the offending file.

5.1.17. ExportRegion¶

Source file: control/export_region.proto

EXPORT_REGION: Requests exporting the specified regions to a file on the server. If directory and file are blank, return file contents for export on client. Backend responds with EXPORT_REGION_ACK

Field	Type	Label	Description
type	FileType		Required file type
coord_type	CoordinateType		Required coordinate type pixel/world
file_id	sfixed32		File id for the coordinate system to use
region_styles	map<key: sfixed32, value: RegionStyle>	repeated	Region ids and style params to export
directory	string		Optional directory name of server file
file	string		Optional file name of server file

5.1.18. ExportRegionAck¶

Source file: control/export_region.proto

EXPORT_REGION_ACK Response for EXPORT_REGION to indicate success and file contents if on client.

Field	Type	Label	Description
success	bool		Defines whether EXPORT_REGION was successful
message	string		Error message (if applicable)
contents	string	repeated	File contents for client export (one line per string)

5.1.19. FileInfoRequest¶

Source file: request/file_info.proto

FILE_INFO_REQUEST: Requests the file info for a specific file. Backend responds with FILE_INFO_RESPONSE

Field	Type	Description
directory	string	Required directory name
file	string	Required file name
hdu	string	Required HDU name (if applicable). If left empty, the first HDU is selected

5.1.20. FileInfoResponse¶

Source file: request/file_info.proto

FILE_INFO_RESPONSE Response for FILE_INFO_REQUEST. Gives information on the requested file

Field	Type	Label	Description
success	bool		Defines whether the FILE_INFO_REQUEST was successful
message	string		Error message (if applicable)
file_info	FileInfo		Basic file info (type, size)
file_info_extended	map<key: string, value: FileInfoExtended>	repeated	Extended file info (WCS, header info)

5.1.21. FileListRequest¶

Source file: request/file_list.proto

FILE_LIST_REQUEST: Requests the list of available files for a given directory. Backend responds with FILE_LIST_RESPONSE

Field	Type	Label	Description
directory	string		Required directory name
filter_mode	FileListFilterMode		Filter mode to use when showing the file list

5.1.22. FileListResponse¶

Source file: request/file_list.proto

FILE_LIST_RESPONSE Response for FILE_LIST_REQUEST. Gives a list of available files (and their types), as well as subdirectories

Field	Type	Label	Description
success	bool		Defines whether the FILE_LIST_REQUEST was successful
message	string		Error message (if applicable)
directory	string		Directory of listing
parent	string		Directory parent (null/empty if top-level)
files	FileInfo	repeated	List of available image files, with file type information and size information.
subdirectories	DirectoryInfo	repeated	List of available subdirectories, with number of items and modified date
cancel	bool

5.1.23. FittingProgress¶

Source file: request/fitting_request.proto

FITTING_PROGRESS: Updates the progress of the requested fitting.

Field	Type	Label	Description
file_id	sfixed32		File ID of the image to be fit
progress	float		Progess of the fitting procedure, ranging from 0 to 1

5.1.24. FittingRequest¶

Source file: request/fitting_request.proto

FITTING_REQUEST: Requests 2D Gaussian image fitting with given initial values. Backend responds with FITTING_RESPONSE

Field	Type	Label	Description
file_id	sfixed32		File ID of the image to be fit
initial_values	GaussianComponent	repeated	Initial values for 2D Gaussian fitting
fixed_params	bool	repeated	Whether each parameter (in the order of center, amplitude, FWHM, and p.a., and with background offset at the end) should be fixed when fitting
region_id	sfixed32		Region ID. Apply field of view if the id is 0; apply the entire image if the id is -1
fov_info	RegionInfo		Field of view parameters
create_model_image	bool		Whether to create a model image of the fitting result
create_residual_image	bool		Whether to create a residual image of the fitting result
offset	double		Background level offset
solver	FittingSolverType		Solver of the linear least squares system in the fitting

5.1.25. FittingResponse¶

Source file: request/fitting_request.proto

FITTING_RESPONSE: Response for FITTING_REQUEST. Gives results and log of 2D Gaussian image fitting.

Field	Type	Label	Description
success	bool		Defines whether FITTING_REQUEST was successful
message	string		Error message (if applicable)
result_values	GaussianComponent	repeated	Fitting result: values of the fitted parameters
result_errors	GaussianComponent	repeated	Fitting result: errors of the fitted parameters
log	string		Fitting log
model_image	OpenFileAck		Fitting result: model image
residual_image	OpenFileAck		Fitting result: residual image
offset_value	double		Fitting result: background level offset
offset_error	double		Fitting result: error of background level offset

5.1.26. ImageProperties¶

Source file: control/resume_session.proto

Field	Type	Label
directory	string
file	string
lel_expr	bool
hdu	string
file_id	sfixed32
render_mode	RenderMode
channel	sfixed32
stokes	sfixed32
regions	map<key: sfixed32, value: RegionInfo>	repeated
contour_settings	SetContourParameters
stokes_files	StokesFile	repeated

5.1.27. ImportRegion¶

Source file: control/import_region.proto

IMPORT_REGION: Requests the opening and applying of a specific region file. Backend responds with IMPORT_REGION_ACK

Field	Type	Label	Description
group_id	sfixed32		Required WCS group id (may be a single file id)
type	FileType		Required file type
directory	string		Optional directory name of server file
file	string		Optional file name of server file
contents	string	repeated	Optional file contents of client file (1 line per string)

5.1.28. ImportRegionAck¶

Source file: control/import_region.proto

IMPORT_REGION_ACK Response for IMPORT_REGION. Also supplies region properties

Field	Type	Label	Description
success	bool		Defines whether IMPORT_REGION was successful
message	string		Error message (if applicable)
regions	map<key: sfixed32, value: RegionInfo>	repeated	Map region id to parameters
region_styles	map<key: sfixed32, value: RegionStyle>	repeated	Map region id to style parameters

5.1.29. MomentProgress¶

Source file: request/moment_request.proto

Field	Type	Label	Description
file_id	sfixed32
progress	float

5.1.30. MomentRequest¶

Source file: request/moment_request.proto

Field	Type	Label
file_id	sfixed32
moments	Moment	repeated
axis	MomentAxis
region_id	sfixed32
spectral_range	IntBounds
mask	MomentMask
pixel_range	FloatBounds
keep	bool

5.1.31. MomentResponse¶

Source file: request/moment_request.proto

Field	Type	Label
success	bool
message	string
open_file_acks	OpenFileAck	repeated
cancel	bool

5.1.32. OpenCatalogFile¶

Source file: control/open_catalog_file.proto

Field	Type	Label	Description
directory	string
name	string
file_id	sfixed32
preview_data_size	sfixed32

5.1.33. OpenCatalogFileAck¶

Source file: control/open_catalog_file.proto

Field	Type	Label
success	bool
message	string
file_id	sfixed32
file_info	CatalogFileInfo
data_size	sfixed32
headers	CatalogHeader	repeated
preview_data	map<key: fixed32, value: ColumnData>	repeated

5.1.34. OpenFile¶

Source file: control/open_file.proto

OPEN_FILE: Requests the opening of a specific file. Backend responds with OPEN_FILE_ACK

Field	Type	Description
directory	string	Required directory name
file	string	File name or LEL expression
hdu	string	Which HDU to load (if applicable). If left blank, the first HDU will be used
file_id	sfixed32	Which “file” slot to load the file into (when viewing multiple files)
render_mode	RenderMode	The render mode to use. Additional modes will be added in subsequent versions.
lel_expr	bool	Defines whether file is LEL expression

5.1.35. OpenFileAck¶

Source file: control/open_file.proto

OPEN_FILE_ACK Response for OPEN_FILE. Also supplies file information

Field	Type	Label	Description
success	bool		Defines whether OPEN_FILE was successful
file_id	sfixed32		Which file slot the file was loaded into (when viewing multiple files)
message	string		Error message (if applicable)
file_info	FileInfo		Basic file info (type, size)
file_info_extended	FileInfoExtended		Extended file info (WCS, header info)
file_feature_flags	fixed32		Optional bitflags specifying feature flags of the file being opened.
beam_table	Beam	repeated	Beam table for multiple-beam images

5.1.36. PvPreviewData¶

Source file: stream/pv_preview.proto

Data stream for PV preview image

Field	Type	Description
preview_id	sfixed32	Preview ID for the PV preview viewer
image_info	FileInfoExtended	Image extended file info
image_data	bytes	Image data. For uncompressed data, this is converted into FP32, while for compressed data, this is passed to the compression library for decompression.
nan_encodings	bytes	Run-length encodings of NaN values used to restore the NaN values after decompression.
width	sfixed32	Dimensions of data
height	sfixed32
compression_type	CompressionType	The compression algorithm used
compression_quality	float	Compression quality switch
histogram_bounds	FloatBounds	Histogram min/max, for rendering
histogram	Histogram	Histogram, to tune rendering

5.1.37. PvProgress¶

Source file: request/pv_request.proto

Field	Type	Description
file_id	sfixed32	File ID of the source image for the PV generator
preview_id	sfixed32	Preview ID of the PV preview viewer
progress	float	Progress indicator, ranging from 0 to 1

5.1.38. PvRequest¶

Source file: request/pv_request.proto

Field	Type	Description
file_id	sfixed32	File ID of the source image
region_id	sfixed32	Region ID of the PV cut in the source image
width	sfixed32	Averaging width along PV cut
spectral_range	IntBounds	Range of channels to be used in velocity axis
reverse	bool	Flag whether to generate [Spatial, Spectral] image or reverse
keep	bool	Flag whether to keep or replace previously-generated images
preview_settings	PvPreviewSettings	Parameters for preview mode

5.1.39. PvResponse¶

Source file: request/pv_request.proto

Field	Type	Description
success	bool	Defines whether PV_REQUEST was successful
message	string	Error message (if applicable)
open_file_ack	OpenFileAck	PV generator result: generated PV image
preview_data	PvPreviewData	PV preview result: generated PV image
cancel	bool	Defines whether PV_REQUEST was canceled

5.1.40. RasterTileData¶

Source file: stream/raster_tile.proto

Field	Type	Label	Description
file_id	sfixed32		The file ID that the raster image corresponds to
channel	sfixed32		The image channel (z-coordinate)
stokes	sfixed32		The image stokes coordinate
compression_type	CompressionType		The compression algorithm used.
compression_quality	float		Compression quality switch
animation_id	sfixed32		The ID of the animation (if any)
tiles	TileData	repeated	List of tile data

5.1.41. RasterTileSync¶

Source file: stream/raster_tile.proto

Field	Type	Description
file_id	sfixed32	The file ID that the raster image corresponds to
channel	sfixed32	The image channel (z-coordinate)
stokes	sfixed32	The image stokes coordinate
animation_id	sfixed32	The ID of the animation (if any)
end_sync	bool	Is this a start or end sync message?

5.1.42. RegionFileInfoRequest¶

Source file: request/region_file_info.proto

REGION_FILE_INFO_REQUEST: Requests contents for a specific region file on the server Backend responds with REGION_FILE_INFO_RESPONSE

Field	Type	Label	Description
directory	string		Required directory name
file	string		Required file name

5.1.43. RegionFileInfoResponse¶

Source file: request/region_file_info.proto

REGION_FILE_INFO_RESPONSE Response for REGION_FILE_INFO_REQUEST. Gives information on the requested file

Field	Type	Label	Description
success	bool		Defines whether the REGION_INFO_REQUEST was successful
message	string		Error message (if applicable)
file_info	FileInfo		Basic info about region file
contents	string	repeated	Contents of file; each string is a line

5.1.44. RegionHistogramData¶

Source file: stream/region_histogram.proto

REGION_HISTOGRAM_DATA: Stats data for a specific region

Field	Type	Description
file_id	sfixed32	The file ID that the histogram corresponds to
region_id	sfixed32	The region ID corresponding to the histogram. If the histogram corresponds to the entire current 2D image, the region ID has a value of -1.
channel	sfixed32	The image channel corresponding to the histogram
stokes	sfixed32	The image stokes corresponding to the histogram
histograms	Histogram	Array of histograms of the current file, region, channel and stokes
progress	float	Progress indicator, in the case of partial histogram results being sent
config	HistogramConfig	Histogram configuration from the frontend

5.1.45. RegionListRequest¶

Source file: request/region_list.proto

REGION_LIST_REQUEST: Requests the list of available region files for a given directory. Backend responds with REGION_LIST_RESPONSE

Field	Type	Label	Description
directory	string		Required directory name
filter_mode	FileListFilterMode		Filter mode to use when showing the file list

5.1.46. RegionListResponse¶

Source file: request/region_list.proto

REGION_LIST_RESPONSE Response for REGION_LIST_REQUEST. Gives a list of available region files (and their types), as well as subdirectories

Field	Type	Label	Description
success	bool		Defines whether the REGION_LIST_REQUEST was successful
message	string		Error message (if applicable)
directory	string		Directory of listing
parent	string		Directory parent (null/empty if top-level)
files	FileInfo	repeated	List of available image files, with file type information and size information.
subdirectories	DirectoryInfo	repeated	List of available subdirectories, with number of items and modified date
cancel	bool

5.1.47. RegionStatsData¶

Source file: stream/region_stats.proto

REGION_STATS_DATA: Stats data for a specific region

Field	Type	Label	Description
file_id	sfixed32		The file ID that the profile corresponds to
region_id	sfixed32		The region_id corresponding to this profile. If the statistics data corresponds to the entire current 2D image, the region ID has a value of -1.
channel	sfixed32		The image channel used to generate the statistics
stokes	sfixed32		The image stokes parameter used to generate the profiles
statistics	StatisticsValue	repeated	Array of statistics values, each corresponding to a particular measurement, such as max, min, mean, etc

5.1.48. RegisterViewer¶

Source file: control/register_viewer.proto

REGISTER_VIEWER: Registers the viewer with the backend. Responds with REGISTER_VIEWER_ACK

Field	Type	Description
session_id	fixed32	Unique session ID parameter (can be generated using UUID libraries). Passing in an existing session ID can be used for resuming sessions
api_key	string	Optional user-specific API key to be used for basic authentication. Could be an encrypted JWT for secure authentication.
client_feature_flags	fixed32	Optional feature bitflag specifying client-side feature set

5.1.49. RegisterViewerAck¶

Source file: control/register_viewer.proto

REGISTER_VIEWER_ACK Acknowledgement response for REGISTER_VIEWER. Informs the frontend whether the session was correctly.

Field	Type	Label	Description
session_id	fixed32		Unique session ID
success	bool		Defines whether the REGISTER_VIEWER command was successful
message	string		Error message (if applicable)
session_type	SessionType		Defines the type of session established
server_feature_flags	fixed32		Optional feature bitflag specifying server-side feature set
user_preferences	map<key: string, value: string>	repeated	Map of user preferences retrieved from the server database. If this is empty and the server does not have the USER_PREFERENCES feature flag set, then the user preferences are read from localStorage instead.
user_layouts	map<key: string, value: string>	repeated	Map of user layouts retrieved from the server database
platform_strings	map<key: string, value: string>	repeated	Map of server-generated platform information strings

5.1.50. RemoveRegion¶

Source file: control/region.proto

REMOVE_REGION: Removes a region

Field	Type	Label	Description
region_id	sfixed32		Unique region ID of the region to be removed

5.1.51. RemoveRequiredTiles¶

Source file: control/tiles.proto

REMOVE_REQUIRED_TILES Provides a list of tiles that are required for the specified file

Field	Type	Label	Description
file_id	sfixed32		The file ID that the view corresponds to
tiles	sfixed32	repeated	The list of tiles required, in encoded coordinate

5.1.52. ResumeSession¶

Source file: control/resume_session.proto

Field	Type	Label	Description
images	ImageProperties	repeated
catalog_files	OpenCatalogFile	repeated

5.1.53. ResumeSessionAck¶

Source file: control/resume_session.proto

Field	Type	Label	Description
success	bool
message	string

5.1.54. SaveFile¶

Source file: request/save_file.proto

Field	Type	Label	Description
file_id	sfixed32
output_file_directory	string
output_file_name	string
output_file_type	FileType		The format of a new image file
region_id	sfixed32
channels	sfixed32	repeated	Set image channels: [start, end, stride]
stokes	sfixed32	repeated	Set image stokes: [start, end, stride]
keep_degenerate	bool
rest_freq	double		Set the rest frequency (Hz) of the image

5.1.55. SaveFileAck¶

Source file: request/save_file.proto

Field	Type	Label	Description
file_id	sfixed32
success	bool
message	string

5.1.56. ScriptingRequest¶

Source file: request/scripting.proto

Field	Type	Description
scripting_request_id	sfixed32	Used to connect a single scripting request to its response
target	string	the path of the target object. e.g. activeFrame.renderConfig
action	string	the name of the function to call. e.g. setColorMap
parameters	string	JSON array of parameters. e.g. ‘[“viridis”]’
async	bool	flag indicating whether the frontend should execute this asynchronously, or only return once the call is complete
return_path	string	optional string indicating the path of the response sub-object to return. If this is empty, the entire response will be returned.

5.1.57. ScriptingResponse¶

Source file: request/scripting.proto

Field	Type	Description
scripting_request_id	sfixed32	should match the incoming request ID
success	bool	indicates whether the call was correctly executed
message	string	optional error message
response	string	JSON-parsable response. e.g. “true”, or the base64-encoded string

5.1.58. SetContourParameters¶

Source file: control/contour.proto

SET_CONTOUR_PARAMETERS Sets the contour parameters for a file

Field	Type	Label	Description
file_id	fixed32		The file ID that the contour corresponds to
reference_file_id	fixed32		The file ID of the reference image that the contour vertices should be mapped to
image_bounds	ImageBounds		The XY bounds corresponding to the image data in pixel coordinates
levels	double	repeated	Contour levels
smoothing_mode	SmoothingMode		Pre-contouring smoothing mode
smoothing_factor	int32		Contour smoothness factor. For block averaging, this is the block width For Gaussian smoothing, this defines both the Gaussian width, and the kernel size
decimation_factor	int32		Decimation factor, indicates to what 1/Nth of a pixel the contour vertices should be rounded to
compression_level	int32		Zstd compression level
contour_chunk_size	int32		Size of contour chunks, in number of vertices. If this is set to zero, partial contour results are not used

5.1.59. SetCursor¶

Source file: control/set_cursor.proto

SET_CURSOR: Sets the current cursor position in image space coordinates. The cursor defines a special case of a region, with a single control point.

Field	Type	Description
file_id	sfixed32	Which file slot the cursor is moving over
point	Point	XY-coordinates of cursor in image space
spatial_requirements	SetSpatialRequirements	Optional accompanying spatial requirements message to be processed prior to cursor update

5.1.60. SetHistogramRequirements¶

Source file: control/region_requirements.proto

SET_HISTOGRAM_REQUIREMENTS: Sets which histogram data needs to be streamed to the frontend when the region is updated

Field	Type	Label	Description
file_id	sfixed32		Which file slot the requirements describe
region_id	sfixed32		ID of the region that is having requirements defined. If a region ID of -1 is given, this corresponds to the entire 2D image.
histograms	HistogramConfig	repeated	List of required histograms, along with the number of bins. If the channel is -1, the current channel is used. If the channel is -2, the histogram is constructed over all channels. If the number of bins is less than zero, an automatic bin size is used, based on the number of values.

5.1.61. SetImageChannels¶

Source file: control/set_image_channels.proto

SET_IMAGE_CHANNELS Sets the current image channel and Stokes parameter

Field	Type	Description
file_id	sfixed32	The file ID that the view corresponds to
channel	sfixed32	The image channel (Z-coordinate)
stokes	sfixed32	The image stokes parameter
required_tiles	AddRequiredTiles	Required tiles when changing channels

5.1.62. SetRegion¶

Source file: control/region.proto

SET_REGION: Creates or updates a region. Backend responds with SET_REGION_ACK

Field	Type	Description
file_id	sfixed32	File slot of the reference image
region_id	sfixed32	Unique region ID. <=0 if a new region is being created.
region_info	RegionInfo	Region parameters
preview_region	bool	Update region for pv preview only

5.1.63. SetRegionAck¶

Source file: control/region.proto

SET_REGION_ACK: Response for SET_REGION

Field	Type	Description
success	bool	Defines whether SET_REGION was successful
message	string	Error message (if applicable)
region_id	sfixed32	The unique region ID. If the region is updated, this will be the same as the region ID specified in SET_REGION. If a new region is being created, the ID of the new region will be passed back.

5.1.64. SetSpatialRequirements¶

Source file: control/region_requirements.proto

SET_SPATIAL_REQUIREMENTS: Sets which information needs to be streamed to the frontend when the region is updated

Field	Type	Label	Description
file_id	sfixed32		Which file slot the requirements describe
region_id	sfixed32		ID of the region that is having requirements defined. If a region ID of 0 is given, this corresponds to the point region defined by the cursor position.
spatial_profiles	SpatialConfig	repeated	List of spatial profiles needed.

5.1.65. SetSpectralRequirements¶

Source file: control/region_requirements.proto

SET_SPECTRAL_REQUIREMENTS: Sets which spectral profile data needs to be streamed to the frontend when the region is updated

Field	Type	Label	Description
file_id	sfixed32		Which file slot the requirements describe
region_id	sfixed32		ID of the region that is having requirements defined. If a region ID of 0 is given, this corresponds to the point region defined by the cursor position.
spectral_profiles	SpectralConfig	repeated	List of spectral profiles needed, along with which stats types are needed for each profile.

5.1.66. SetStatsRequirements¶

Source file: control/region_requirements.proto

SET_STATS_REQUIREMENTS: Sets which stats data needs to be streamed to the frontend when the region is updated

Field	Type	Label	Description
file_id	sfixed32		Which file slot the requirements describe
region_id	sfixed32		ID of the region that is having requirements defined. If a region ID of -1 is given, this corresponds to the entire 2D image.
stats_configs	StatsConfig	repeated	List of required stats

5.1.67. SetVectorOverlayParameters¶

Source file: control/vector_overlay.proto

SET_VECTOR_OVERLAY_PARAMETERS Sets the overlay parameters for a file

Field	Type	Description
file_id	fixed32	The file ID that the overlay corresponds to
image_bounds	ImageBounds	The XY bounds corresponding to the image data in pixel coordinates. Currently unused
smoothing_factor	fixed32	Block smoothing factor to use. Must be an even integer, corresponds to the `mip` coordinate.
fractional	bool	Whether to use fractional polarization intensity
threshold	double	Threshold value to use. If this is set to NaN, no threshold is applied.
debiasing	bool	Whether to use debiasing
q_error	double	Stokes Q error when debiasing
u_error	double	Stokes U error when debiasing
stokes_intensity	sfixed32	The Stokes coordinate to use when generating vector intensity. If this is < 0, uniform intensity is used. If both this and `stokes_angle` are < 0, the overlay requirement is cleared
stokes_angle	sfixed32	The Stokes coordinate to use when generating vector angle. If this is < 0, uniform angle is used (e.g. when rendering block markers)
compression_type	CompressionType	The compression algorithm to use.
compression_quality	float	Compression quality switch

5.1.68. SpatialConfig¶

Source file: control/region_requirements.proto

Field	Type	Description
coordinate	string	The required spatial coordinate (“x” or “y”).
start	sfixed32	The start of the required range (inclusive). If the start and end are the same (i.e. the range is empty), the default of 0 is used.
end	sfixed32	The end of the required range (exclusive). If the start and end are the same (i.e. the range is empty), the height or width of the image is used.
mip	sfixed32	The maximum required mip. The backend must return data of at least this resolution, but may return a higher resolution. If this is unset or 0, the full-resolution data is used.
width	sfixed32	Width of line region for line profile. Not used for point region.

5.1.69. SpatialProfileData¶

Source file: stream/spatial_profile.proto

SPATIAL_PROFILE_DATA: Data for spatial profile set for a specific file

Field	Type	Label	Description
file_id	sfixed32		The file ID that the profile corresponds to
region_id	sfixed32		The region_id corresponding to this profile. If the profile corresponds to the cursor position, the region ID is zero.
x	sfixed32		The pixel X-coordinate of the profile set
y	sfixed32		The pixel Y-coordinate of the profile set
channel	sfixed32		The image channel used to generate the profiles
stokes	sfixed32		The image stokes parameter used to generate the profiles
value	float		The value of the image at the given coordinates
profiles	SpatialProfile	repeated	Spatial profiles for each required profile type

5.1.70. SpectralConfig¶

Source file: control/region_requirements.proto

Field	Type	Label	Description
coordinate	string		The required spectral coordinate (“z”), optionally preceded by a polarization parameter. If no polarization parameter is present, or if the coordinate is empty, the active polarization parameter is used.
stats_types	StatsType	repeated	The required stats type. If the region is a point region, this field is ignored.

5.1.71. SpectralProfileData¶

Source file: stream/spectral_profile.proto

SPECTRAL_PROFILE_DATA: Data for spectral profile set for a specific file

Field	Type	Label	Description
file_id	sfixed32		The file ID that the profile corresponds to
region_id	sfixed32		The region ID that the stats data corresponds to. If the profile corresponds to the cursor position, the region ID has a value of 0.
stokes	sfixed32		The image stokes parameter used to generate the profiles
progress	float		Progress indicator, in the case of partial profile results being sent. If the profile calculations are time-consuming, regular updates should be sent to the frontend. If the data is complete, progress >= 1.
profiles	SpectralProfile	repeated	Spatial profiles for each required profile type

5.1.72. StartAnimation¶

Source file: control/animation.proto

START_ANIMATION: Starts an animation, as defined by the start, stop and step definitions. Backend responds with START_ANIMATION_ACK

Field	Type	Label	Description
file_id	sfixed32		Which file slot the animation describes.
first_frame	AnimationFrame		The lower bound of the animation when looping.
start_frame	AnimationFrame		The starting point of the animation.
last_frame	AnimationFrame		The upper bound of the animation.
delta_frame	AnimationFrame		The frame change step for the animation. For example, a delta frame of {channel=1, stokes=0} would step through each channel in the file.
frame_rate	sfixed32		Frame rate per second
looping	bool		Whether to loop the animation indefinitely.
reverse	bool		Whether to reverse the animation direction when endFrame is reached.
required_tiles	AddRequiredTiles		Required tiles when changing channels
matched_frames	map<key: sfixed32, value: MatchedFrameList>	repeated
stokes_indices	sfixed32	repeated	Required stokes frames with respect to stokes types

5.1.73. StartAnimationAck¶

Source file: control/animation.proto

START_ANIMATION_ACK Response for START_ANIMATION

Field	Type	Description
success	bool	Defines whether START_ANIMATION was successful
message	string	Error message (if applicable)
animation_id	sfixed32	The animation ID of the new animation

5.1.74. StatsConfig¶

Source file: control/region_requirements.proto

Field	Type	Label	Description
coordinate	string
stats_types	StatsType	repeated

5.1.75. StokesFile¶

Source file: control/concat_stokes_files.proto

Field	Type	Description
directory	string	Required directory name
file	string	Required file name
hdu	string	Which HDU to load (if applicable). If left blank, the first HDU will be used
polarization_type	PolarizationType	Polarization type

5.1.76. StopAnimation¶

Source file: control/animation.proto

STOP_ANIMATION Stops the playing animation

Field	Type	Label	Description
file_id	sfixed32		Which file slot the animation describes.
end_frame	AnimationFrame		The ending point of the animation.

5.1.77. StopFileList¶

Source file: request/file_list.proto

Field	Type	Label	Description
file_list_type	FileListType

5.1.78. StopFitting¶

Source file: request/fitting_request.proto

STOP_FITTING: Cancels the requested fitting.

Field	Type	Label	Description
file_id	sfixed32		Stop image fitting with respect to the image file id

5.1.79. StopMomentCalc¶

Source file: control/stop_moment_calc.proto

Field	Type	Label	Description
file_id	sfixed32		Stop the moment calculation with respect to the image file id

5.1.80. StopPvCalc¶

Source file: control/stop_pv_calc.proto

Field	Type	Label	Description
file_id	sfixed32		Stop the PV image calculation for the image file id

5.1.81. StopPvPreview¶

Source file: control/stop_pv_calc.proto

Field	Type	Label	Description
preview_id	sfixed32		Stop the PV preview for the preview viewer id

5.1.82. VectorOverlayTileData¶

Source file: stream/vector_overlay_tile.proto

Field	Type	Label	Description
file_id	sfixed32		The file ID that the vector overlay image corresponds to
channel	sfixed32		The image channel (z-coordinate)
stokes_intensity	sfixed32		The Stokes coordinate that was used to generate vector intensity. If this is < 0, uniform intensity is used
stokes_angle	sfixed32		The Stokes coordinate that was used to generate vector angle. If this is < 0, uniform angle is used (e.g. when rendering block markers)
compression_type	CompressionType		The compression algorithm used.
compression_quality	float		Compression quality switch
intensity_tiles	TileData	repeated	List of tile data for vector intensity. The length of this list must match that of `angle_tiles`, or be zero
angle_tiles	TileData	repeated	List of tile data for vector angle. The length of this list must match that of `intensity_tiles`, or be zero
progress	double		Progress of the vector overlay being sent. If this is zero, the message is assumed to contain the entire contour sets