Sub-messages

AnimationFrame

Source file: shared/defs.proto

Field	Type	Label	Description
channel	sfixed32
stokes	sfixed32

AnnotationStyle

Source file: shared/defs.proto

Field	Type	Label	Description
point_shape	PointAnnotationShape		Point annotation shape
point_width	sfixed32		Point annotation width
text_label0	string		Text annotation text / Compass annotation north label
text_label1	string		Compass annotation east label
coordinate_system	string		Compass and Ruler coordinate sytem
is_north_arrow	bool		Compass annotation north arrowhead
is_east_arrow	bool		Compass annotation east arrowhead
text_position	TextAnnotationPosition		Text annotation position
font_style	string		Font style (bold, italic, bold_italic)
font	string		Font (Times / Helvetica / Courier)
font_size	sfixed32		Font size for Text, Compass, Ruler

AxesNumbers

Source file: shared/defs.proto

Field	Type	Label	Description
spatial_x	sfixed32		Spatial X axis number
spatial_y	sfixed32		Spatial Y axis number
spectral	sfixed32		Spectral axis number
stokes	sfixed32		Stokes axis number
depth	sfixed32		Depth axis is non-render axis that is not stokes (if any)

Beam

Source file: shared/defs.proto

describe each beam for multi-beam images

Field	Type	Label	Description
channel	sfixed32
stokes	sfixed32
major_axis	float
minor_axis	float
pa	float

CatalogFileInfo

Source file: shared/defs.proto

Field	Type	Label	Description
name	string
type	CatalogFileType
file_size	sfixed64
description	string
coosys	Coosys	repeated
date	sfixed64

CatalogHeader

Source file: shared/defs.proto

Field	Type	Label	Description
name	string
data_type	ColumnType
column_index	sfixed32
description	string
units	string

CatalogImageBounds

Source file: shared/defs.proto

Field	Type	Label	Description
x_column_name	string
y_column_name	string
image_bounds	ImageBounds

ColumnData

Source file: shared/defs.proto

Field	Type	Label	Description
data_type	ColumnType
string_data	string	repeated	All data types other than string sent as binary
binary_data	bytes		binary data will get converted to a TypedArray

Coosys

Source file: shared/defs.proto

Field	Type	Label	Description
equinox	string
epoch	string
system	string

DirectoryInfo

Source file: shared/defs.proto

Directory info message structure, sub-message of FileListResponse

Field	Type	Label	Description
name	string		Directory name
item_count	sfixed32		Number of items in the directory. This field is always unused (and left as zero) if FileListFilterMode is AllFiles.
date	sfixed64		Modification date

DoubleBounds

Source file: shared/defs.proto

Field	Type	Label	Description
min	double
max	double

DoublePoint

Source file: shared/defs.proto

Field	Type	Label	Description
x	double
y	double

FileInfo

Source file: shared/defs.proto

File info message structure, sub-message of FileListResponse

Field	Type	Label	Description
name	string		File name
type	FileType		File type. This field may be unused (and set to UNKNOWN) if FileListFilterMode is AllFiles
size	sfixed64		File size
HDU_list	string	repeated	HDU list
date	sfixed64		Modification date

FileInfoExtended

Source file: shared/defs.proto

Field	Type	Label	Description
dimensions	sfixed32		Number of dimensions of the image file
width	sfixed32		Width of the XY plane
height	sfixed32		Height of the XY plane
depth	sfixed32		Number of channels
stokes	sfixed32		Number of Stokes parameters
stokes_vals	string	repeated	List of Stokes parameters contained in the file (if applicable). For files that do not explicitly specify Stokes files, this will be blank.
header_entries	HeaderEntry	repeated	Header entries from header string or attributes
computed_entries	HeaderEntry	repeated
axes_numbers	AxesNumbers		Axes numbers for directions, spectral, and stokes

FilterConfig

Source file: shared/defs.proto

Field	Type	Label	Description
column_name	string
comparison_operator	ComparisonOperator
value	double
secondary_value	double
sub_string	string

FloatBounds

Source file: shared/defs.proto

Field	Type	Label	Description
min	float
max	float

GaussianComponent

Source file: shared/defs.proto

parameters of a 2D Gaussian component for image fitting

Field	Type	Label	Description
center	DoublePoint		x/y coordinate of the center in pixels
amp	double		amplitude of the component
fwhm	DoublePoint		full width at half maximum along x/y coordinate in pixels
pa	double		position angle in degrees

HeaderEntry

Source file: shared/defs.proto

Field	Type	Label	Description
name	string
value	string
entry_type	EntryType
numeric_value	double
comment	string

Histogram

Source file: shared/defs.proto

Field	Type	Label	Description
num_bins	sfixed32
bin_width	double
first_bin_center	double
bins	sfixed32	repeated
mean	double
std_dev	double

HistogramConfig

Source file: shared/defs.proto

Field	Type	Label	Description
coordinate	string
channel	sfixed32
fixed_num_bins	bool
num_bins	sfixed32
fixed_bounds	bool
bounds	DoubleBounds

ImageBounds

Source file: shared/defs.proto

Field	Type	Label	Description
x_min	sfixed32
x_max	sfixed32
y_min	sfixed32
y_max	sfixed32

IntBounds

Source file: shared/defs.proto

Field	Type	Label	Description
min	sfixed32
max	sfixed32

LineProfileAxis

Source file: shared/defs.proto

Field	Type	Label	Description
axis_type	ProfileAxisType
crpix	float
crval	float
cdelt	float
unit	string

ListProgress

Source file: shared/defs.proto

Field	Type	Label	Description
file_list_type	FileListType
percentage	float
checked_count	sfixed32
total_count	sfixed32

MatchedFrameList

Source file: shared/defs.proto

Field	Type	Label	Description
frame_numbers	float	repeated

Point

Source file: shared/defs.proto

Field	Type	Label	Description
x	float
y	float

PvPreviewSettings

Source file: shared/defs.proto

Preview parameters of a PV_REQUEST

Field	Type	Label	Description
preview_id	sfixed32		Preview ID for the PV preview viewer
region_id	sfixed32		Region ID for the subimage in the xy plane
rebin_xy	sfixed32		Downsampling in xy axes
rebin_z	sfixed32		Downsampling in z axis
compression_type	CompressionType		The compression algorithm to use
image_compression_quality	float		Compression quality from frontend performance preferences
animation_compression_quality	float

RegionInfo

Source file: shared/defs.proto

Field	Type	Label	Description
region_type	RegionType		The type of region described by the control points. The meaning of the control points will differ, depending on the type of region being defined.
control_points	Point	repeated	Control points for the region
rotation	float		(Only applicable for ellipse and rectangle) Rotation of the region in the xy plane (radians).

RegionStyle

Source file: shared/defs.proto

Field	Type	Label	Description
name	string		The name of the region, displayed as an annotation label.
color	string		Color as a name (“blue”), RGB string, or hex string
line_width	sfixed32		Width in pixels
dash_list	sfixed32	repeated	Dash length: on, off
annotation_style	AnnotationStyle		Annotation Styles

SpatialProfile

Source file: shared/defs.proto

Field	Type	Label	Description
start	sfixed32
end	sfixed32
raw_values_fp32	bytes
coordinate	string
mip	sfixed32
line_axis	LineProfileAxis

SpectralProfile

Source file: shared/defs.proto

Field	Type	Label	Description
coordinate	string
stats_type	StatsType
raw_values_fp32	bytes
raw_values_fp64	bytes

StatisticsValue

Source file: shared/defs.proto

Field	Type	Label	Description
stats_type	StatsType
value	double

TileData

Source file: shared/defs.proto

Field	Type	Label	Description
layer	sfixed32		Tile layer coordinate. If this is < 0, the mip value is used for coordinates instead
x	sfixed32		Tile x coordinate
y	sfixed32		Tile y coordinate
width	sfixed32		Width of the tile data. If this is left as zero, the default tile size should be used
height	sfixed32		Height of the tile data. If this is left as zero, the default tile size should be used
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. These values are used to restore the NaN values after decompression.
mip	sfixed32		Mip coordinate. Ignored if layer >= 0