6. Changelog

Versioning information

• Major version change (1.2.3 -> 2.0.0): this is a breaking change.

• Minor version change (1.2.3 -> 1.3.0): this is added functionality which is optional and non-breaking.

• Patch (1.2.3 -> 1.2.4): this is a change which does not affect functionality (e.g. a typo fix in a comment, or a changed field name).

Some legacy changelog entries may not follow this approach. Only changes to the protocol buffer source files should be recorded here; changes only to this documentation do not require a version bump.

CARTA version 6

Version	Date	Description
30.2.0	08/12/25	Added vector_overlay_settings to ImageProperties message to update vector overlay after session resume.

CARTA version 5

Version	Date	Description
30.1.1	18/06/25	Modified descriptions of FileListResponse, FileInfo, and DirectoryInfo for addressing the new behavior of AllFiles mode.
30.1.0	05/05/25	Added threshold_option to SetVectorOverlayParameters message.
30.0.0	23/10/24	Added optional channel_range and current_range to SetImageChannels message, optional current_tiles to AddRequiredTiles message, and new message ChannelMapFlowControl to support channel map view.
29.1.0	27/08/24	Added rest_freq to MomentRequest message.
29.0.0	26/06/24	Added overwrite to SaveFile and ExportRegion messages.
28.15.0	23/05/24	Added RemoteFileRequest and RemoteFileResponse messages.
28.14.0	27/10/23	Adjusted file ID generation.

CARTA version 4

Version	Date	Description
28.13.0	23/08/23	Added integrated flux to FittingResponse message.
28.12.0	15/08/23	Added sync_id and tile_count to RasterTileSync and RasterTileData messages.
28.11.0	20/06/23	Added support_aips_beam to FileInfoRequest, OpenFile, and ImageProperties messages.
28.10.0	18/05/23	Added lel_expr to ImageProperties message.
28.9.0	28/04/23	Added sub-message PvPreviewSettings to PvRequest and message PvPreviewData to PvResponse for generating a PV preview image. Added StopPvPreview to cancel preview image and ClosePvPreview to release preview resources.
28.8.0	14/04/23	Added number of bins and pixel bounds to HistogramConfig in SetHistogramRequirements message. Added HistogramConfig to RegionHistogramData message.
28.7.0	23/03/23	Added annotation regions to RegionType and added additional style parameters in AnnotationStyle to RegionStyle.
28.6.0	17/03/23	Added additional fields to FittingResponse for image fitting background offset as a free parameter.
28.5.0	10/01/23	Added axes numbers to FileInfoExtended message for dealing with swapped axes image cubes.
28.4.0	05/12/22	Added additional fields to FittingRequest and FittingResponse for generating model and residual images. Added FittingProgress and StopFitting messages for updating progress and canceling tasks.
28.3.0	30/11/22	Added keep to MomentRequest message.
28.2.0	08/09/22	Added spectral_range, reverse, and keep to PvRequest message.

CARTA version 3

Version	Date	Description
28.1.0	17/06/22	Added region_id and fov_info to FittingRequest message.
28.0.0	07/06/22	Removed spectral line request/response and Splatalogue ping/pong messages.
27.3.0	09/05/22	Added width to SetSpatialRequirements and LineProfileAxis to SpatialProfile.
27.2.0	05/05/22	Added SetVectorOverlayParameters and VectorOverlayTileData messages. Moved TileData to shared.
27.1.0	27/04/22	Added Ptotal, Plinear, PFtotal, PFlinear, and Pangle to PolarizationType enum. Added stokes_indices to StartAnimation message.
27.0.0	21/04/22	Added FittingRequest and FittingResponse messages for image fitting.
26.2.0	19/04/22	Added rest_freq to SaveFile message.
26.1.0	01/03/22	Added lel_expr to OpenFile message.
26.0.0	13/01/22	Removed grpc_port from RegisterViewerAck message. Renamed GRPC_SCRIPTING to SCRIPTING in ServerFeatureFlags. Removed all references to gRPC in docs.
25.0.0	06/12/21	Added PvRequest, PvResponse, PvProgress, and StopPvCalc messages for PV generator.
24.2.0	11/11/21	Added filter_mode to FileListRequest, CatalogListRequest and RegionListRequest messages; Added Unknown to CatalogFileType.
24.1.0	12/10/21	Added platform_strings to RegisterViewerAck message.
24.0.0	30/07/21	Added the stokes to SetStatsRequirements, HistogramConfig, and RegionHistogramData messages. Removed the channel from Histogram.
23.1.1	29/07/21	Added return_path to ScriptingRequest message.
23.1.0	23/07/21	Added SplataloguePing and SplataloguePong messages.
23.0.0	28/06/21	Added SpatialConfig submessage with fields for spatial profile mip and range, and added mip field to SpatialProfile. Updated comments for SpatialConfig and SpectralConfig.
22.0.0	28/06/21	Added DirectoryInfo message.

CARTA version 2

Version	Date	Description
21.0.0	05/05/21	Added ListProgress and StopFileList messages
20.2.0	26/04/21	Added additional fields to SaveFile for sub-image support.
20.1.0	23/04/21	Renamed REGION_WRITE_ACCESS to READ_ONLY in ServerFeatureFlags.
20.0.0	13/04/21	Added ConcatStokesFiles messages
19.0.0	07/01/21	Adjusted FileInfoResponse to include map of extended file info messages
18.1.0	08/01/21	Non-breaking change: added beam_table (of type Beam) to OpenFileAck.
18.0.0	11/12/20	Added extrema enum value to StatsType. Removed deprecated messages: SetUserLayout, SetUserLayoutAck, SetUserPreferences, SetUserPreferencesAck, and SetRegionRequirements.

CARTA version 1.4

Version	Date	Description
17.2.0	12/08/20	Non-breaking change: added intensity limit field to line ID query
17.1.0	11/08/20	Non-breaking change: added map of matched frames for spectral matched animation
17.0	27/07/20	Added spectral line request and response
16.0.0	23/07/20	Added sub-message for region style, replace RegionProperties with map
15.0.0	04/07/20	Added date field to file info, reordered file types alphabetically
14.0.0	28/05/20	Updated messages for catalogs
13.0.0	19/05/20	Updated messages for scripting service information (WIP)

CARTA version 1.3

Version	Date	Description
12.0.0	18/02/20	Updated messages for tiled rendering usage during animation
11.0.0	20/11/19	Added messages to resume the session and its ACK
10.0.0	25/10/19	Updated messages for contour streaming
9.0.0	17/10/19	Added/updated messages for contour parameters and streaming
8.0.0	21/08/19	Added messages for retrieving and setting user preferences and layouts

CARTA version 1.2

Version	Date	Description
7.0.1	08/08/19	Region export coordinate type
7.0.0	23/07/19	Region file browser and import/export messages
6.0.0	19/07/19	Animation ID and timestamps for ACKs
5.0.0	15/07/19	Switched to byte fields instead of repeated float/double for efficiency reasons in spatial and spectral profile messages
4.0.1	04/07/19	Fixed incorrect sequence diagrams for file loading
4.0.0	02/07/19	Expanded sequence diagrams and text on tiled rendering and animation. Changed version numbering to match ICD version integer
0.2.2	14/05/19	Added information on tiled rendering
0.2.1	09/05/19	Added feature flag enums as well as event type enums. Updated animation information and sequence diagrams to include flow control
0.2.0	07/05/19	Changed message header information, adjusted stats enum values, added double value support for spectral profile
0.1.18	28/03/19	Changed rotation units from radians to degrees

CARTA version 1.1

Version	Date	Description
0.1.17	27/03/19	Added NumPixels and NanCount stats types
0.1.16	25/03/19	Removed stokes, channel_min and channel_max fields from SET_REGION, and changed StatisticsValue value field to a double type.
0.1.15	05/03/19	Added target version info
0.1.14	07/02/19	Added $BASE folder placeholder

CARTA version 1.0

Version	Date	Description
0.1.13	30/11/18	Added details on per-cube histogram calculations
0.1.12	18/10/18	Deprecated channel_vals field in SPECTRAL_PROFILE_DATA
0.1.11	20/09/18	Added file_id field to SET_REGION and fixed control points typo
0.1.10	10/09/18	Added optional field spatial_requirements to the SET_CURSOR message
0.1.9	10/09/18	Changed computed_entries map to an array of HeaderEntry messages
0.1.8	07/09/18	Added computed_entries map to the File Info Extended message
0.1.7	30/08/18	Added optional field channel_histogram_data to the image view message