CARTA Interface Control Document¶
- Date
14 August 2023
- Authors
Angus Comrie, Rob Simmonds and the CARTA development team
- Version
28.13.0
- ICD Version Integer
28
- CARTA Target
Version 4.0
Changelog¶
Version |
Date |
Description |
---|---|---|
|
30/08/18 |
Added optional field |
|
07/09/18 |
Added |
|
10/09/18 |
Changed |
|
10/09/18 |
Added optional field |
|
20/09/18 |
Added |
|
18/10/18 |
Deprecated |
|
30/11/18 |
Added details on per-cube histogram calculations |
|
07/02/19 |
Added |
|
05/03/19 |
Added target version info |
|
25/03/19 |
Removed |
|
27/03/19 |
Added |
|
28/03/19 |
Changed rotation units from radians to degrees |
|
07/05/19 |
Changed message header information, adjusted stats enum values, added double value support for spectral profile |
|
09/05/19 |
Added feature flag enums as well as event type enums. Updated animation information and sequence diagrams to include flow control |
|
14/05/19 |
Added information on tiled rendering |
|
02/07/19 |
Expanded sequence diagrams and text on tiled rendering and animation. Changed version numbering to match ICD version integer |
|
04/07/19 |
Fixed incorrect sequence diagrams for file loading |
|
15/07/19 |
Switched to byte fields instead of repeated float/double for efficiency reasons in spatial and spectral profile messages |
|
19/07/19 |
Animation ID and timestamps for ACKs |
|
23/07/19 |
Region file browser and import/export messages |
|
08/08/19 |
Region export coordinate type |
|
21/08/19 |
Added messages for retrieving and setting user preferences and layouts |
|
17/10/19 |
Added/updated messages for contour parameters and streaming |
|
25/10/19 |
Updated messages for contour streaming |
|
20/11/19 |
Added messages to resume the session and its ACK |
|
18/02/20 |
Updated messages for tiled rendering usage during animation |
|
19/05/20 |
Updated messages for scripting service information (WIP) |
|
28/05/20 |
Updated messages for catalogs |
|
04/07/20 |
Added date field to file info, reordered file types alphabetically |
|
23/07/20 |
Added sub-message for region style, replace |
|
27/07/20 |
Added spectral line request and response |
|
11/08/20 |
Non-breaking change: added map of matched frames for spectral matched animation |
|
12/08/20 |
Non-breaking change: added intensity limit field to line ID query |
|
11/12/20 |
Added |
|
08/01/21 |
Non-breaking change: added |
|
07/01/21 |
Adjusted |
|
13/04/21 |
Added |
|
23/04/21 |
Renamed |
|
26/04/21 |
Added additional fields to SaveFile for sub-image support. |
|
05/05/21 |
Added ListProgress and StopFileList messages |
|
28/06/21 |
Added DirectoryInfo message. |
|
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. |
|
23/07/21 |
Added |
|
29/07/21 |
Added |
|
30/07/21 |
Added the stokes to SetStatsRequirements, HistogramConfig, and RegionHistogramData messages. Removed the channel from Histogram. |
|
12/10/21 |
Added |
|
11/11/21 |
Added |
|
06/12/21 |
Added PvRequest, PvResponse, PvProgress, and StopPvCalc messages for PV generator. |
|
13/01/22 |
Removed |
|
01/03/22 |
Added |
|
19/04/22 |
Added |
|
21/04/22 |
Added FittingRequest and FittingResponse messages for image fitting. |
|
27/04/22 |
Added |
|
05/05/22 |
Added SetVectorOverlayParameters and VectorOverlayTileData messages. Moved TileData to |
|
09/05/22 |
Added |
|
07/06/22 |
Removed spectral line request/response and Splatalogue ping/pong messages. |
|
17/06/22 |
Added |
|
08/09/22 |
Added |
|
30/11/22 |
Added |
|
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. |
|
10/01/23 |
Added axes numbers to FileInfoExtended message for dealing with swapped axes image cubes. |
|
17/03/23 |
Added additional fields to FittingResponse for image fitting background offset as a free parameter. |
|
23/03/23 |
Added annotation regions to RegionType and added additional style parameters in AnnotationStyle to RegionStyle. |
|
14/04/23 |
Added number of bins and pixel bounds to HistogramConfig in SetHistogramRequirements message. Added HistogramConfig to RegionHistogramData message. |
|
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. |
|
18/05/23 |
Added |
|
20/06/23 |
Added |
|
15/08/23 |
Added |
|
23/08/23 |
Added integrated flux to FittingResponse message. |
Versioning¶
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.
Contents:
- 1. Introduction
- 2. Context
- 3. Behaviour
- 4. Layer descriptions
- 5. Protocol buffer reference
- 5.1. Messages
- 5.1.1. AddRequiredTiles
- 5.1.2. AnimationFlowControl
- 5.1.3. CatalogFileInfoRequest
- 5.1.4. CatalogFileInfoResponse
- 5.1.5. CatalogFilterRequest
- 5.1.6. CatalogFilterResponse
- 5.1.7. CatalogListRequest
- 5.1.8. CatalogListResponse
- 5.1.9. CloseCatalogFile
- 5.1.10. CloseFile
- 5.1.11. ClosePvPreview
- 5.1.12. ConcatStokesFiles
- 5.1.13. ConcatStokesFilesAck
- 5.1.14. ContourImageData
- 5.1.15. ContourSet
- 5.1.16. ErrorData
- 5.1.17. ExportRegion
- 5.1.18. ExportRegionAck
- 5.1.19. FileInfoRequest
- 5.1.20. FileInfoResponse
- 5.1.21. FileListRequest
- 5.1.22. FileListResponse
- 5.1.23. FittingProgress
- 5.1.24. FittingRequest
- 5.1.25. FittingResponse
- 5.1.26. ImageProperties
- 5.1.27. ImportRegion
- 5.1.28. ImportRegionAck
- 5.1.29. MomentProgress
- 5.1.30. MomentRequest
- 5.1.31. MomentResponse
- 5.1.32. OpenCatalogFile
- 5.1.33. OpenCatalogFileAck
- 5.1.34. OpenFile
- 5.1.35. OpenFileAck
- 5.1.36. PvPreviewData
- 5.1.37. PvProgress
- 5.1.38. PvRequest
- 5.1.39. PvResponse
- 5.1.40. RasterTileData
- 5.1.41. RasterTileSync
- 5.1.42. RegionFileInfoRequest
- 5.1.43. RegionFileInfoResponse
- 5.1.44. RegionHistogramData
- 5.1.45. RegionListRequest
- 5.1.46. RegionListResponse
- 5.1.47. RegionStatsData
- 5.1.48. RegisterViewer
- 5.1.49. RegisterViewerAck
- 5.1.50. RemoveRegion
- 5.1.51. RemoveRequiredTiles
- 5.1.52. ResumeSession
- 5.1.53. ResumeSessionAck
- 5.1.54. SaveFile
- 5.1.55. SaveFileAck
- 5.1.56. ScriptingRequest
- 5.1.57. ScriptingResponse
- 5.1.58. SetContourParameters
- 5.1.59. SetCursor
- 5.1.60. SetHistogramRequirements
- 5.1.61. SetImageChannels
- 5.1.62. SetRegion
- 5.1.63. SetRegionAck
- 5.1.64. SetSpatialRequirements
- 5.1.65. SetSpectralRequirements
- 5.1.66. SetStatsRequirements
- 5.1.67. SetVectorOverlayParameters
- 5.1.68. SpatialConfig
- 5.1.69. SpatialProfileData
- 5.1.70. SpectralConfig
- 5.1.71. SpectralProfileData
- 5.1.72. StartAnimation
- 5.1.73. StartAnimationAck
- 5.1.74. StatsConfig
- 5.1.75. StokesFile
- 5.1.76. StopAnimation
- 5.1.77. StopFileList
- 5.1.78. StopFitting
- 5.1.79. StopMomentCalc
- 5.1.80. StopPvCalc
- 5.1.81. StopPvPreview
- 5.1.82. VectorOverlayTileData
- 5.2. Sub-messages
- 5.2.1. AnimationFrame
- 5.2.2. AnnotationStyle
- 5.2.3. AxesNumbers
- 5.2.4. Beam
- 5.2.5. CatalogFileInfo
- 5.2.6. CatalogHeader
- 5.2.7. CatalogImageBounds
- 5.2.8. ColumnData
- 5.2.9. Coosys
- 5.2.10. DirectoryInfo
- 5.2.11. DoubleBounds
- 5.2.12. DoublePoint
- 5.2.13. FileInfo
- 5.2.14. FileInfoExtended
- 5.2.15. FilterConfig
- 5.2.16. FloatBounds
- 5.2.17. GaussianComponent
- 5.2.18. HeaderEntry
- 5.2.19. Histogram
- 5.2.20. HistogramConfig
- 5.2.21. ImageBounds
- 5.2.22. IntBounds
- 5.2.23. LineProfileAxis
- 5.2.24. ListProgress
- 5.2.25. MatchedFrameList
- 5.2.26. Point
- 5.2.27. PvPreviewSettings
- 5.2.28. RegionInfo
- 5.2.29. RegionStyle
- 5.2.30. SpatialProfile
- 5.2.31. SpectralProfile
- 5.2.32. StatisticsValue
- 5.2.33. TileData
- 5.3. Enums
- 5.3.1. CatalogFileType
- 5.3.2. ClientFeatureFlags
- 5.3.3. ColumnType
- 5.3.4. ComparisonOperator
- 5.3.5. CompressionType
- 5.3.6. CoordinateType
- 5.3.7. EntryType
- 5.3.8. ErrorSeverity
- 5.3.9. EventType
- 5.3.10. FileFeatureFlags
- 5.3.11. FileListFilterMode
- 5.3.12. FileListType
- 5.3.13. FileType
- 5.3.14. FittingSolverType
- 5.3.15. Moment
- 5.3.16. MomentAxis
- 5.3.17. MomentMask
- 5.3.18. PointAnnotationShape
- 5.3.19. PolarizationType
- 5.3.20. ProfileAxisType
- 5.3.21. RegionType
- 5.3.22. RenderMode
- 5.3.23. ServerFeatureFlags
- 5.3.24. SessionType
- 5.3.25. SmoothingMode
- 5.3.26. SortingType
- 5.3.27. StatsType
- 5.3.28. TextAnnotationPosition
- 5.1. Messages