[Volute] r5292 - in trunk/projects/dm/STC/Trans: doc vo-dml

Volute commit messages volutecommits at g-vo.org
Wed Dec 19 20:09:27 CET 2018

Author: mdittmar
Date: Wed Dec 19 20:09:27 2018
New Revision: 5292

Log:
more description corrections

Modified:
trunk/projects/dm/STC/Trans/doc/Transforms.tex
trunk/projects/dm/STC/Trans/doc/WD-Trans-1.0.pdf
trunk/projects/dm/STC/Trans/doc/body.tex
trunk/projects/dm/STC/Trans/doc/other.bib
trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.html
trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.vo-dml.xml

Modified: trunk/projects/dm/STC/Trans/doc/Transforms.tex
==============================================================================
--- trunk/projects/dm/STC/Trans/doc/Transforms.tex	Wed Dec 19 19:44:12 2018	(r5291)
+++ trunk/projects/dm/STC/Trans/doc/Transforms.tex	Wed Dec 19 20:09:27 2018	(r5292)
@@ -31,9 +31,9 @@
\begin{document}

\begin{abstract}
-  In creating version 2 of the Space-Time Coordinate Metadata for the Virtual Observatory (STC) Data Model \citep{std:STC}, it was decided to split the content into various component models which focus on particular aspects of the previous model scope.
+  In creating version 2 of \emph{Space-Time Coordinate Metadata for the Virtual Observatory}'' (STC) \citep{std:STC} Data Model, it was decided to split the content into various component models which focus on particular aspects of the previous model scope.

-  This model describes the Transform model and covers the following concepts.
+  This model covers the WCS Transform component, and includes the following concepts:
\begin{itemize}
\item The description of mathematical operations which form the building blocks for conversions from one coordinate space to another.
\item The combination of individual operations into an arbitrarily complex Transform.
@@ -78,8 +78,8 @@
The Transform model must facilitate the combination of operations to cover an n-dimensional space from building blocks
of commonly used operations.

-For image cubes, it is common to have one axis represent the polarization state.  In this case, the pixel coordinate is not transformed
-to a continuous physical space, but to a discrete polarization state.
+Image pixel axes are not always transformed to a continuous physical space, but instead, to a space of discrete values such as Polarization states.
+This model must support transforms of this nature.

The industry standard for non-linear projections are defined in:
\begin{itemize}
@@ -87,7 +87,7 @@
\item Representations of spectral coordinates in FITS (paper III)\citep{WCSpaperIII}
\end{itemize}
This document, in no way, duplicates that work, but rather, defines model elements compatible with these specifications.  In that way,
-any implementation of these standards are automatically compatible with this model.  However, these standards do not cover the full
+any implementation of these standards is automatically compatible with this model.  However, these standards do not cover the full
range of non-linear distortions seen from today's instruments.  It is, therefore, necessary that this model be extensible to represent

@@ -109,7 +109,7 @@
\end{enumerate}

\subsection{Context and Scope}
-This document is a result of updating the \href{http://www.ivoa.net/documents/latest/STC.html}{Space-Time Coordinate Metadata for the Virtual Observatory} (STC) \citep{std:STC} model for use in VO-DML compliant models.
+This document is a result of updating the \emph{Space-Time Coordinate Metadata for the Virtual Observatory}'' (STC) \citep{std:STC} model for use in VO-DML compliant models.

The update and revision of the STC model has sub-divided the content into component
models, each covering a portion of the scope of the original model.  This has
@@ -117,13 +117,13 @@
allows for independent development of the component models, and creates smaller,
more digestible content for users.

-This document defines the WCS Transforms model, providing the metadata describions for:
+This document covers the WCS Transforms model, including:
\begin{itemize}
\item The description of mathematical operations which form the building blocks for conversions from one coordinate space to another.
\item The combination of individual operations into an arbitrarily complex Transform.
\end{itemize}

-This version of the model covers a core set of transform operations commonly used by the community.
+The scope of this version of the model covers a core set of transform operations commonly used by the community.
It is designed to be compatible with FITS WCS metadata transport, and existing implementations
like AST \citep{soft:AST}, GWCS \citep{soft:GWCS}, and wcslib \citep{soft:WCSLIB}.
It forms a foundation which can be built upon in future versions.

Modified: trunk/projects/dm/STC/Trans/doc/WD-Trans-1.0.pdf
==============================================================================
Binary file (source and/or target). No diff available.

Modified: trunk/projects/dm/STC/Trans/doc/body.tex
==============================================================================
--- trunk/projects/dm/STC/Trans/doc/body.tex	Wed Dec 19 19:44:12 2018	(r5291)
+++ trunk/projects/dm/STC/Trans/doc/body.tex	Wed Dec 19 20:09:27 2018	(r5292)
@@ -11,7 +11,7 @@

%\author{Mark Cresitello-Dittmar}

-%\author{David Bery}
+%\author{David Berry}

%\author{Steven Crawford}

@@ -56,7 +56,7 @@

\subsection{Unit}
\label{sect:Unit}
-    The Unit transform is an 1-Dimensional operation which makes no change to the inputs. ( $x' = x$ )
+    A 1-Dimensional operation which makes no change to the inputs. ( $x' = x$ )

\subsection{Shift}
\label{sect:Shift}
@@ -93,7 +93,7 @@
An M x N matrix operation. Each cell of the matrix is provided by a MatrixElement object. Missing elements should be considerd to equal 0.

\noindent \textbf{constraint} \newline
-    \indent    \textbf{detail: Matrix.Matrix.element[] maxlength = M*N }\newline
+    \indent    \textbf{detail:} Matrix.Matrix.element[] maxlength = M*N \newline

\subsubsection{Matrix.M}
@@ -112,7 +112,7 @@
\textbf{vodml-id: Matrix.element} \newline
\textbf{type: \hyperref[sect:MatrixElement]{trans:MatrixElement}} \newline
\textbf{multiplicity: 0..*} \newline
-      Collection of MatrixElements which define each cell of the matrix. The total number of elements MUST NOT exceed M*N, any missing elements result a cell with value=0.0.
+      Collection of MatrixElements which define each cell of the matrix. The total number of elements MUST NOT exceed M*N, any missing elements result in a cell with value=0.0.

\subsection{MatrixElement}
\label{sect:MatrixElement}
@@ -140,7 +140,7 @@
\label{sect:Lookup}
Defines a lookup table operation. The Lookup is comprised of a series of value pairs (LookupEntry). All members of the series MUST be of the same type.

-    Handling Enumerated data: A common useage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state. This can be handled by two means:
+    Handling Enumerated data: A common usage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state. This can be handled by two means:
\begin{enumerate}
\item define a numeric equivalent for each enumeration literal, and use NumericEntry types. Casting to the corresponding literal occurs outside of the operation.
\item your local model can define a LookupEntry extension which maps the native value directly the target EnumerationLiteral.
@@ -175,7 +175,7 @@

\subsection{StringEntry}
\label{sect:StringEntry}
-    A 1-Dimensional discrete mapping of an integer counter to a corresponding string form. Since the result is non-numeric, a Lookup table with StringEntry-s can only be used at the end of a Transform sequence.
+    A 1-Dimensional discrete mapping of an integer counter to a corresponding string form. Since the result is non-numeric, a Lookup operation with StringEntry-s can only be used at the end of a Transform sequence.

\subsubsection{StringEntry.nativeValue}
\textbf{vodml-id: StringEntry.nativeValue} \newline
@@ -321,10 +321,10 @@

\subsection{Permute}
\label{sect:Permute}
-    Permute the order and possibly number of dimensions between operations. This operation facilitates the workflow through the operation sequence. It is comprised of an ordered axismap list, defining the output axis sequence in terms of the source (input) axes. It supports the reorder, duplication, and dropping of dimensions.
+    Permute the order and possibly number of dimensions between operations. This operation facilitates the workflow through the operation sequence. It is comprised of an ordered axismap list defining the output axis sequence in terms of the source (input) axes. It supports the reorder, duplication, and dropping of dimensions.
\begin{itemize}
-    \item[Reorder Example]: We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane. Define a Permute operation with axismap list specifying sourceAxis [2,1,3]. The results feed into the next step ( 1D + 2D operations ).
-    \item[Duplicate Example]: We have 2-dimensional coordinate (x,y) feeding two Polynomial2D operations to form (x',y'). Define a Permute operation with axismap list specifying sourceAxis set [1,2,1,2]. The result feeds into the next step ( Polynomial2D + Polynomial2D operations).
+    \item[Reorder Example]: We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane. Define a Permute operation with axismap list specifying new axis order, [2,1,3]. The results feed into the next step ( 1D + 2D operations ).
+    \item[Duplicate Example]: We have 2-dimensional coordinate (x,y) feeding two Polynomial2D operations to form ($x',y'$). Define a Permute operation with axismap list specifying new axis set [1,2,1,2]. The result feeds into the next step ( Polynomial2D + Polynomial2D operations).
\item[Drop Example]: We have a 5-dimensional input feeding into a 3x3 Matrix operation. Define a Permute operation selecting the relevant axis set [1,3,5], the remaining axes, [2,4], are dropped.
\end{itemize}

Modified: trunk/projects/dm/STC/Trans/doc/other.bib
==============================================================================
--- trunk/projects/dm/STC/Trans/doc/other.bib	Wed Dec 19 19:44:12 2018	(r5291)
+++ trunk/projects/dm/STC/Trans/doc/other.bib	Wed Dec 19 20:09:27 2018	(r5292)
@@ -46,3 +46,11 @@
pages = {609},
}
+ at MISC{soft:WCSLIB,
+  author       = {{Calabretta}, M. R.},
+   title       = {WCSLib and PGSBox},
+  howpublished = {{Astrophysics Source Code Library}},
+     year      = 2011,
+    month      = Aug,
+}

Modified: trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.html
==============================================================================
--- trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.html	Wed Dec 19 19:44:12 2018	(r5291)
+++ trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.html	Wed Dec 19 20:09:27 2018	(r5292)
@@ -157,14 +157,14 @@
<tr>
<td align="right"><b>Authors</b></td>
<td> : </td>
-        <td>Arnold Rots, Mark Cresitello-Dittmar, David Bery, Steven Crawford, Nadia Dencheva, Perry Greenfield, Tim Jenness, Omar Laurino,
+        <td>Arnold Rots, Mark Cresitello-Dittmar, David Berry, Steven Crawford, Nadia Dencheva, Perry Greenfield, Tim Jenness, Omar Laurino,
Stuart Mumford, Erik Tollerud
</td>
</tr>
<tr>
<td align="right"><b>Date</b></td>
<td> : </td>
-        <td>2018-12-18T15:10:30</td>
+        <td>2018-12-19T13:45:42</td>
</tr>
<tr>
<td align="right"><b>Version</b></td>
@@ -266,11 +266,14 @@
<td class="feature-detail" colspan="1">Defines a lookup table operation.  The Lookup is comprised of a series of value pairs (LookupEntry).  All members of the series
MUST be of the same type.
Handling Enumerated data:
-            A common useage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can
-            be handled by two means.  1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting
-            to the corresponding literal occurs outside of the operation.  2) your local model can define a LookupEntry extension which
-            maps the native value directly the target EnumerationLiteral.  The details of either approach for particular enumerations
-            is considered outside the scope of this document.
+            A common usage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can
+            be handled by two means:
+            1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting to the corresponding literal
+            occurs outside of the operation.
+            2) your local model can define a LookupEntry extension which maps the native value directly the target EnumerationLiteral.
+
+
+            The details of either approach for particular enumerations is considered outside the scope of this document.

</td>
</tr>
@@ -450,7 +453,7 @@
<tr>
<td class="feature-detail">Collection of MatrixElements which define each cell of the matrix.  The total number of elements MUST NOT exceed M*N, any
-                        missing elements result a cell with value=0.0.
+                        missing elements result in a cell with value=0.0.
</td>
</tr>
<tr>
@@ -632,11 +635,12 @@
<tr>
<td class="info-title">description</td>
<td class="feature-detail" colspan="1">Permute the order and possibly number of dimensions between operations.  This operation facilitates the workflow through the
-            operation sequence.  It is comprised of an ordered axismap list, defining the output axis sequence in terms of the source
-            (input) axes.  It supports the reorder, duplication, and dropping of dimensions.
+            operation sequence.  It is comprised of an ordered axismap list defining the output axis sequence in terms of the source (input)
+            axes.  It supports the reorder, duplication, and dropping of dimensions.
Reorder Example:
We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane.  Define a Permute
-            operation with axismap list specifying sourceAxis [2,1,3].  The results feed into the next step ( 1D + 2D operations ).
+            operation with axismap list specifying the new axis order, [2,1,3].  The results feed into the next step ( 1D + 2D operations
+            ).
Duplicate Example:
We have 2-dimensional coordinate (x,y) feeding two Polynomial2D operations to form (x',y').  Define a Permute operation with
axismap list specifying sourceAxis set [1,2,1,2].  The result feeds into the next step ( Polynomial2D + Polynomial2D  operations).
@@ -2051,7 +2055,7 @@
<tr>
<td class="info-title">description</td>
<td class="feature-detail" colspan="1">A 1-Dimensional discrete mapping of an integer counter to a corresponding string form.  Since the result is non-numeric, a
-            Lookup table with StringEntry-s can only be used at the end of a Transform sequence.
+            Lookup operation with StringEntry-s can only be used at the end of a Transform sequence.
</td>
</tr>
<tr>
@@ -2320,7 +2324,7 @@
</tr>
<tr>
<td class="info-title">description</td>
-          <td class="feature-detail" colspan="1">The Unit transform is an 1-Dimensional operation which makes no change to the inputs. ( X' = X )</td>
+          <td class="feature-detail" colspan="1">A 1-Dimensional operation which makes no change to the inputs. ( X' = X )</td>
</tr>
<tr>
<td colspan="2">
@@ -2439,11 +2443,14 @@
<td class="feature-detail">Defines a lookup table operation.  The Lookup is comprised of a series of value pairs (LookupEntry).  All members of the series
MUST be of the same type.
Handling Enumerated data:
-          A common useage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can
-          be handled by two means.  1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting
-          to the corresponding literal occurs outside of the operation.  2) your local model can define a LookupEntry extension which
-          maps the native value directly the target EnumerationLiteral.  The details of either approach for particular enumerations
-          is considered outside the scope of this document.
+          A common usage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can
+          be handled by two means:
+          1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting to the corresponding literal
+          occurs outside of the operation.
+          2) your local model can define a LookupEntry extension which maps the native value directly the target EnumerationLiteral.
+
+
+          The details of either approach for particular enumerations is considered outside the scope of this document.

</td>
</tr>
@@ -2480,7 +2487,7 @@
<td class="feature-detail"><a href="#Matrix.element">Matrix.element</a></td>
<td class="feature-detail">composition</td>
<td class="feature-detail">Collection of MatrixElements which define each cell of the matrix.  The total number of elements MUST NOT exceed M*N, any
-          missing elements result a cell with value=0.0.
+          missing elements result in a cell with value=0.0.
</td>
</tr>
<tr>
@@ -2522,11 +2529,12 @@
<td class="feature-detail"><a href="#Permute">Permute</a></td>
<td class="feature-detail">objectType</td>
<td class="feature-detail">Permute the order and possibly number of dimensions between operations.  This operation facilitates the workflow through the
-          operation sequence.  It is comprised of an ordered axismap list, defining the output axis sequence in terms of the source
-          (input) axes.  It supports the reorder, duplication, and dropping of dimensions.
+          operation sequence.  It is comprised of an ordered axismap list defining the output axis sequence in terms of the source (input)
+          axes.  It supports the reorder, duplication, and dropping of dimensions.
Reorder Example:
We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane.  Define a Permute
-          operation with axismap list specifying sourceAxis [2,1,3].  The results feed into the next step ( 1D + 2D operations ).
+          operation with axismap list specifying the new axis order, [2,1,3].  The results feed into the next step ( 1D + 2D operations
+          ).
Duplicate Example:
We have 2-dimensional coordinate (x,y) feeding two Polynomial2D operations to form (x',y').  Define a Permute operation with
axismap list specifying sourceAxis set [1,2,1,2].  The result feeds into the next step ( Polynomial2D + Polynomial2D  operations).
@@ -2995,7 +3003,7 @@
<td class="feature-detail"><a href="#StringEntry">StringEntry</a></td>
<td class="feature-detail">objectType</td>
<td class="feature-detail">A 1-Dimensional discrete mapping of an integer counter to a corresponding string form.  Since the result is non-numeric, a
-          Lookup table with StringEntry-s can only be used at the end of a Transform sequence.
+          Lookup operation with StringEntry-s can only be used at the end of a Transform sequence.
</td>
</tr>
<tr>
@@ -3096,4 +3104,4 @@
</tr>
</table>
</body>
-</html>
\ No newline at end of file
+</html>

Modified: trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.vo-dml.xml
==============================================================================
--- trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.vo-dml.xml	Wed Dec 19 19:44:12 2018	(r5291)
+++ trunk/projects/dm/STC/Trans/vo-dml/STC_trans-v1.0.vo-dml.xml	Wed Dec 19 20:09:27 2018	(r5292)
@@ -7,10 +7,10 @@
</description>
<uri/>
<title>WCS Transform Model</title>
-  <author>Arnold Rots, Mark Cresitello-Dittmar, David Bery, Steven Crawford, Nadia Dencheva, Perry Greenfield, Tim Jenness, Omar Laurino, Stuart Mumford, Erik Tollerud</author>
+  <author>Arnold Rots, Mark Cresitello-Dittmar, David Berry, Steven Crawford, Nadia Dencheva, Perry Greenfield, Tim Jenness, Omar Laurino, Stuart Mumford, Erik Tollerud</author>
<version>1.0</version>
<previousVersion>0.0</previousVersion>
-  <lastModified>2018-12-18T15:10:30</lastModified>
+  <lastModified>2018-12-19T13:45:42</lastModified>
<import>
<name>ivoa</name>
<url>http://www.ivoa.net/xml/VODML/20180519/IVOA-v1.0.vo-dml.xml</url>
@@ -331,7 +331,7 @@
<objectType>
<vodml-id>Unit</vodml-id>
<name>Unit</name>
-    <description>The Unit transform is an 1-Dimensional operation which makes no change to the inputs. ( X' = X )</description>
+    <description>A 1-Dimensional operation which makes no change to the inputs. ( X' = X )</description>
<extends>
<vodml-ref>trans:TOperation</vodml-ref>
</extends>
@@ -437,7 +437,7 @@
<composition>
<vodml-id>Matrix.element</vodml-id>
<name>element</name>
-      <description>Collection of MatrixElements which define each cell of the matrix.  The total number of elements MUST NOT exceed M*N, any missing elements result a cell with value=0.0.</description>
+      <description>Collection of MatrixElements which define each cell of the matrix.  The total number of elements MUST NOT exceed M*N, any missing elements result in a cell with value=0.0.</description>
<datatype>
<vodml-ref>trans:MatrixElement</vodml-ref>
</datatype>
@@ -750,7 +750,11 @@
<name>Lookup</name>
<description>Defines a lookup table operation.  The Lookup is comprised of a series of value pairs (LookupEntry).  All members of the series MUST be of the same type.
Handling Enumerated data:
-  A common useage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can be handled by two means.  1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting to the corresponding literal occurs outside of the operation.  2) your local model can define a LookupEntry extension which maps the native value directly the target EnumerationLiteral.  The details of either approach for particular enumerations is considered outside the scope of this document.
+  A common usage of a Lookup operation is to map image pixel index to an enumeration, such as a Polarization state.  This can be handled by two means:
+    1) define a numeric equivalent for each enumeration literal, and use NumericEntry types.  Casting to the corresponding literal occurs outside of the operation.
+    2) your local model can define a LookupEntry extension which maps the native value directly the target EnumerationLiteral.
+
+The details of either approach for particular enumerations is considered outside the scope of this document.
</description>
<extends>
<vodml-ref>trans:TOperation</vodml-ref>
@@ -812,7 +816,7 @@
<objectType>
<vodml-id>StringEntry</vodml-id>
<name>StringEntry</name>
-    <description>A 1-Dimensional discrete mapping of an integer counter to a corresponding string form.  Since the result is non-numeric, a Lookup table with StringEntry-s can only be used at the end of a Transform sequence.</description>
+    <description>A 1-Dimensional discrete mapping of an integer counter to a corresponding string form.  Since the result is non-numeric, a Lookup operation with StringEntry-s can only be used at the end of a Transform sequence.</description>
<extends>
<vodml-ref>trans:LookupEntry</vodml-ref>
</extends>
@@ -845,9 +849,9 @@
<objectType>
<vodml-id>Permute</vodml-id>
<name>Permute</name>
-    <description>Permute the order and possibly number of dimensions between operations.  This operation facilitates the workflow through the operation sequence.  It is comprised of an ordered axismap list, defining the output axis sequence in terms of the source (input) axes.  It supports the reorder, duplication, and dropping of dimensions.
+    <description>Permute the order and possibly number of dimensions between operations.  This operation facilitates the workflow through the operation sequence.  It is comprised of an ordered axismap list defining the output axis sequence in terms of the source (input) axes.  It supports the reorder, duplication, and dropping of dimensions.
Reorder Example:
-   We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane.  Define a Permute operation with axismap list specifying sourceAxis [2,1,3].  The results feed into the next step ( 1D + 2D operations ).
+   We have a 3-dimensional coordinate (x,y,z) and wish to perform a 2-dimensional transform on the (x,z) plane.  Define a Permute operation with axismap list specifying the new axis order, [2,1,3].  The results feed into the next step ( 1D + 2D operations ).
Duplicate Example:
We have 2-dimensional coordinate (x,y) feeding two Polynomial2D operations to form (x',y').  Define a Permute operation with axismap list specifying sourceAxis set [1,2,1,2].  The result feeds into the next step ( Polynomial2D + Polynomial2D  operations).
Drop Example:
@@ -910,4 +914,4 @@
</attribute>
</objectType>

-</vo-dml:model>
\ No newline at end of file
+</vo-dml:model>