Mark/add axes numbers (#77)

* Add axes numbers in the file info extended message * Modify the message AxesNumbers * Modify the changelog and the index * Revert the version number and rename variables for directional axes as spatial axes
CARTAvis · Mar 22, 2023 · aeb52e8 · aeb52e8
1 parent c02470a
commit aeb52e8
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 2 deletions.
diff --git a/docs/src/changelog.rst.txt b/docs/src/changelog.rst.txt
@@ -189,6 +189,9 @@ Changelog
    * - ``28.4.0``
      - 05/12/22
      - Added additional fields to :carta:ref:`FittingRequest` and :carta:ref:`FittingResponse` for generating model and residual images. Added :carta:ref:`FittingProgress` and :carta:ref:`StopFitting` messages for updaing progress and canceling tasks.
+   * - ``28.5.0``
+     - 10/01/23
+     - Added axes numbers to :carta:ref:`FileInfoExtended` message for dealing with swapped axes image cubes.
 
 Versioning
 ----------

diff --git a/docs/src/defs.rst.txt b/docs/src/defs.rst.txt
@@ -27,6 +27,47 @@ Source file: `shared/defs.proto <https://github.com/CARTAvis/carta-protobuf/blob
      - 
      - 
 
+.. carta:class:: carta-sub axesnumbers
+
+.. _axesnumbers:
+
+AxesNumbers
+~~~~~~~~~~~
+
+Source file: `shared/defs.proto <https://github.com/CARTAvis/carta-protobuf/blob/dev/shared/defs.proto>`_
+
+
+
+.. list-table::
+   :widths: 20 20 20 40
+   :header-rows: 1
+   :class: 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)
+
 .. carta:class:: carta-sub beam
 
 .. _beam:
@@ -437,6 +478,10 @@ Source file: `shared/defs.proto <https://github.com/CARTAvis/carta-protobuf/blob
      - :carta:refc:`HeaderEntry`
      - repeated
      - 
+   * - axes_numbers
+     - :carta:refc:`AxesNumbers`
+     - 
+     - Axes numbers for directions, spectral, and stokes
 
 .. carta:class:: carta-sub filterconfig
 

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -1,9 +1,9 @@
 CARTA Interface Control Document
 ================================
 
-:Date: 05 December 2022
+:Date: 10 January 2022
 :Authors: Angus Comrie, Rob Simmonds and the CARTA development team
-:Version: 28.4.0
+:Version: 28.5.0
 :ICD Version Integer: 28
 :CARTA Target: Version 4.0
 

diff --git a/shared/defs.proto b/shared/defs.proto
@@ -49,6 +49,8 @@ message FileInfoExtended {
     // Header entries from header string or attributes
     repeated HeaderEntry header_entries = 7;
     repeated HeaderEntry computed_entries = 8;
+    // Axes numbers for directions, spectral, and stokes
+    AxesNumbers axes_numbers = 9;
 }
 
 message HeaderEntry {
@@ -59,6 +61,19 @@ message HeaderEntry {
     string comment = 5;
 }
 
+message AxesNumbers {
+    // Spatial X axis number
+    sfixed32 spatial_x = 1;
+    // Spatial Y axis number
+    sfixed32 spatial_y = 2;
+    // Spectral axis number
+    sfixed32 spectral = 3;
+    // Stokes axis number
+    sfixed32 stokes = 4;
+    // Depth axis is non-render axis that is not stokes (if any)
+    sfixed32 depth = 5;
+}
+
 message IntBounds {
     sfixed32 min = 1;
     sfixed32 max = 2;