]> granicus.if.org Git - postgis/commitdiff
ST_SkewX, ST_SkewY, ST_SetSkew
authorRegina Obe <lr@pcorp.us>
Sat, 17 Apr 2010 00:57:52 +0000 (00:57 +0000)
committerRegina Obe <lr@pcorp.us>
Sat, 17 Apr 2010 00:57:52 +0000 (00:57 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@5561 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_wktraster.xml

index 696f06356e8665655eae19c61b9db2820945e92d..3918d8db67df2a9cc4ff5c460b1b7c32e5eaf6db 100644 (file)
@@ -879,6 +879,116 @@ FROM dummy_rast;
                        </refsection>
                </refentry>
                
+               <refentry id="RT_ST_SkewX">
+                       <refnamediv>
+                               <refname>ST_SkewX</refname>
+                               <refpurpose>Returns the georeference X skew (or rotation parameter)</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>float8 <function>ST_SkewX</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Returns the georeference X skew (or rotation parameter).  Refer to <ulink url="http://en.wikipedia.org/wiki/World_file">World File</ulink>
+                               for more details.</para>
+                               </refsection>
+                               
+                               <refsection>
+                                       <title>Examples</title>
+                               
+                                       <programlisting>SELECT rid, ST_SkewX(rast) As skewx, ST_SkewY(rast) As skewy, 
+    ST_GeoReference(rast) as georef
+FROM dummy_rast;
+
+ rid | skewx | skewy |       georef
+-----+-------+-------+--------------------
+   1 |     0 |     0 | 2.0000000000
+                     : 0.0000000000
+                     : 0.0000000000
+                     : 3.0000000000
+                     : 0.5000000000
+                     : 0.5000000000
+                     :
+   2 |     0 |     0 | 0.0500000000
+                     : 0.0000000000
+                     : 0.0000000000
+                     : -0.0500000000
+                     : 3427927.7500000000
+                     : 5793244.0000000000
+                               </programlisting>
+                       
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_GeoReference" />, <xref linkend="RT_ST_SkewY" /></para>
+                       </refsection>
+               </refentry>
+               
+               <refentry id="RT_ST_SkewY">
+                       <refnamediv>
+                               <refname>ST_SkewY</refname>
+                               <refpurpose>Returns the georeference Y skew (or rotation parameter)</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>float8 <function>ST_SkewY</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Returns the georeference Y skew (or rotation parameter).  Refer to <ulink url="http://en.wikipedia.org/wiki/World_file">World File</ulink>
+                               for more details.</para>
+                               </refsection>
+                               
+                               <refsection>
+                                       <title>Examples</title>
+                               
+                                       <programlisting>SELECT rid, ST_SkewX(rast) As skewx, ST_SkewY(rast) As skewy, 
+    ST_GeoReference(rast) as georef
+FROM dummy_rast;
+
+ rid | skewx | skewy |       georef
+-----+-------+-------+--------------------
+   1 |     0 |     0 | 2.0000000000
+                     : 0.0000000000
+                     : 0.0000000000
+                     : 3.0000000000
+                     : 0.5000000000
+                     : 0.5000000000
+                     :
+   2 |     0 |     0 | 0.0500000000
+                     : 0.0000000000
+                     : 0.0000000000
+                     : -0.0500000000
+                     : 3427927.7500000000
+                     : 5793244.0000000000
+                               </programlisting>
+                       
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_GeoReference" />, <xref linkend="RT_ST_SkewX" />, <xref linkend="RT_ST_SetSkew" /></para>
+                       </refsection>
+               </refentry>
+               
                <refentry id="RT_ST_SRID">
                        <refnamediv>
                                <refname>ST_SRID</refname>
@@ -1350,6 +1460,82 @@ WHERE rid = 2;
                                <para><xref linkend="RT_ST_PixelSizeX" />, <xref linkend="RT_ST_PixelSizeY" />, <xref linkend="RT_ST_Box2D" /></para>
                        </refsection>
                </refentry>
+
+               <refentry id="RT_ST_SetSkew">
+                       <refnamediv>
+                               <refname>ST_SetSkew</refname>
+                               <refpurpose>Sets the georeference X and Y skew (or rotation parameter).  If only one is passed in sets x and y to same number.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>raster <function>ST_SetSkew</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                       <paramdef><type>float8 </type> <parameter>skewxy</parameter></paramdef>
+                                 </funcprototype>
+                                 <funcprototype>
+                                       <funcdef>raster <function>ST_SetSkew</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                       <paramdef><type>float8 </type> <parameter>skewx</parameter></paramdef>
+                                       <paramdef><type>float8 </type> <parameter>skewy</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Sets the georeference X and Y skew (or rotation parameter).  If only one is passed in sets x and y to same number.  Refer to <ulink url="http://en.wikipedia.org/wiki/World_file">World File</ulink>
+                               for more details.</para>
+                               </refsection>
+                               
+                               <refsection>
+                                       <title>Examples</title>
+                               
+                                       <programlisting>
+-- Example 1                    
+UPDATE dummy_rast SET rast = ST_SetSkew(rast,1,2) WHERE rid = 1;
+SELECT rid, ST_SkewX(rast) As skewx, ST_SkewY(rast) As skewy, 
+    ST_GeoReference(rast) as georef
+FROM dummy_rast WHERE rid = 1;
+
+rid | skewx | skewy |    georef
+----+-------+-------+--------------
+  1 |     1 |     2 | 2.0000000000
+                    : 2.0000000000
+                    : 1.0000000000
+                    : 3.0000000000
+                    : 0.5000000000
+                    : 0.5000000000
+                    
+                               </programlisting>
+                               
+                               <programlisting>
+-- Example 2 set both to same number:
+UPDATE dummy_rast SET rast = ST_SetSkew(rast,0) WHERE rid = 1;
+SELECT rid, ST_SkewX(rast) As skewx, ST_SkewY(rast) As skewy, 
+    ST_GeoReference(rast) as georef
+FROM dummy_rast WHERE rid = 1;
+                       
+ rid | skewx | skewy |    georef
+-----+-------+-------+--------------
+   1 |     0 |     0 | 2.0000000000
+                     : 0.0000000000
+                     : 0.0000000000
+                     : 3.0000000000
+                     : 0.5000000000
+                     : 0.5000000000
+                               </programlisting>
+                       
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_GeoReference" />, <xref linkend="RT_ST_SkewY" />, <xref linkend="RT_ST_SkewY" /></para>
+                       </refsection>
+               </refentry>
                
                <refentry id="RT_ST_SetSRID">
                  <refnamediv>