5.2. Sub-messages¶
5.2.1. AnimationFrame¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
channel |
sfixed32 |
||
stokes |
sfixed32 |
5.2.2. AnnotationStyle¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
point_shape |
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 |
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 |
5.2.3. 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) |
5.2.4. 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 |
5.2.5. CatalogFileInfo¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
name |
string |
||
type |
|||
file_size |
sfixed64 |
||
description |
string |
||
coosys |
repeated |
||
date |
sfixed64 |
5.2.6. CatalogHeader¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
name |
string |
||
data_type |
|||
column_index |
sfixed32 |
||
description |
string |
||
units |
string |
5.2.7. CatalogImageBounds¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
x_column_name |
string |
||
y_column_name |
string |
||
image_bounds |
5.2.8. ColumnData¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
data_type |
|||
string_data |
string |
repeated |
All data types other than string sent as binary |
binary_data |
bytes |
binary data will get converted to a TypedArray |
5.2.9. Coosys¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
equinox |
string |
||
epoch |
string |
||
system |
string |
5.2.10. DirectoryInfo¶
Source file: shared/defs.proto
Directory info message structure (internal use only)
Field |
Type |
Label |
Description |
---|---|---|---|
name |
string |
||
item_count |
sfixed32 |
||
date |
sfixed64 |
5.2.11. DoubleBounds¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
min |
double |
||
max |
double |
5.2.13. FileInfo¶
Source file: shared/defs.proto
File info message structure (internal use only)
Field |
Type |
Label |
Description |
---|---|---|---|
name |
string |
||
type |
|||
size |
sfixed64 |
||
HDU_list |
string |
repeated |
|
date |
sfixed64 |
5.2.14. 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 |
repeated |
Header entries from header string or attributes |
|
computed_entries |
repeated |
||
axes_numbers |
Axes numbers for directions, spectral, and stokes |
5.2.15. FilterConfig¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
column_name |
string |
||
comparison_operator |
|||
value |
double |
||
secondary_value |
double |
||
sub_string |
string |
5.2.16. FloatBounds¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
min |
float |
||
max |
float |
5.2.17. GaussianComponent¶
Source file: shared/defs.proto
parameters of a 2D Gaussian component for image fitting
Field |
Type |
Label |
Description |
---|---|---|---|
center |
x/y coordinate of the center in pixels |
||
amp |
double |
amplitude of the component |
|
fwhm |
full width at half maximum along x/y coordinate in pixels |
||
pa |
double |
position angle in degrees |
5.2.18. HeaderEntry¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
name |
string |
||
value |
string |
||
entry_type |
|||
numeric_value |
double |
||
comment |
string |
5.2.19. 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 |
5.2.20. 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 |
5.2.21. ImageBounds¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
x_min |
sfixed32 |
||
x_max |
sfixed32 |
||
y_min |
sfixed32 |
||
y_max |
sfixed32 |
5.2.22. IntBounds¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
min |
sfixed32 |
||
max |
sfixed32 |
5.2.23. LineProfileAxis¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
axis_type |
|||
crpix |
float |
||
crval |
float |
||
cdelt |
float |
||
unit |
string |
5.2.24. ListProgress¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
file_list_type |
|||
percentage |
float |
||
checked_count |
sfixed32 |
||
total_count |
sfixed32 |
5.2.25. MatchedFrameList¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
frame_numbers |
float |
repeated |
5.2.27. 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 |
The compression algorithm to use |
||
image_compression_quality |
float |
Compression quality from frontend performance preferences |
|
animation_compression_quality |
float |
5.2.28. RegionInfo¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
region_type |
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 |
repeated |
Control points for the region |
|
rotation |
float |
(Only applicable for ellipse and rectangle) Rotation of the region in the xy plane (radians). |
5.2.29. 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 |
Annotation Styles |
5.2.30. SpatialProfile¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
start |
sfixed32 |
||
end |
sfixed32 |
||
raw_values_fp32 |
bytes |
||
coordinate |
string |
||
mip |
sfixed32 |
||
line_axis |
5.2.31. SpectralProfile¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
coordinate |
string |
||
stats_type |
|||
raw_values_fp32 |
bytes |
||
raw_values_fp64 |
bytes |
5.2.32. StatisticsValue¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
stats_type |
|||
value |
double |
5.2.33. TileData¶
Source file: shared/defs.proto
Field |
Type |
Label |
Description |
---|---|---|---|
layer |
sfixed32 |
Tile layer coordinate. If this is < 0, the |
|
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 |