st_box2d, st_envelope (note regular Postgis changed st_box2d to just box2d old st_box...

git-svn-id: http://svn.osgeo.org/postgis/trunk@5489 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/reference_wktraster.xml b/doc/reference_wktraster.xml
index 0eec874da42b6ff34e723d22c6857f7abc068c58..5547354fa442ef8eeb74181f4e799367313849fa 100644 (file)
--- a/doc/reference_wktraster.xml
+++ b/doc/reference_wktraster.xml
@@ -179,6 +179,98 @@ WHERE rid = 2;
                        </refsection>
                </refentry>
                
+               <refentry id="RT_ST_Box2D">
+                       <refnamediv>
+                               <refname>ST_Box2D</refname>
+                               <refpurpose>Returns the box 2d representation of the enclosing box of the raster</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>box2d<function>ST_Box2D</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Returns the box representing the extent of the raster.</para>
+                               <para>The polygon is defined by the corner points of the bounding box
+                       ((<varname>MINX</varname>, <varname>MINY</varname>),
+                       (<varname>MAXX</varname>, <varname>MAXY</varname>))</para>
+                       </refsection>
+                               
+                       <refsection>
+                               <title>Examples</title>
+                       
+                               <programlisting>SELECT rid, ST_Box2D(rast) As rastbox
+FROM dummy_rast;
+
+rid |        rastbox
+----+-------------------------------------------------
+1   | BOX(0.5 0.5,20.5 60.5)
+2   | BOX(3427927.75 5793243.5,3427928 5793244)
+                       </programlisting>
+                       
+                       </refsection>
+
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_Envelope" /></para>
+                       </refsection>
+               </refentry>
+               
+               <refentry id="RT_ST_Envelope">
+                       <refnamediv>
+                               <refname>ST_Envelope</refname>
+                               <refpurpose>Returns the polygon representation of the extent of the raster.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>geometry <function>ST_Envelope</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                 </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Returns the polygon representation of the extent of the raster in spatial coordinate units defiend by srid. It is a float8 minimum bounding box represented as a polygon. </para>
+                               <para>The polygon is defined by the corner points of the bounding box
+                       ((<varname>MINX</varname>, <varname>MINY</varname>),
+                       (<varname>MINX</varname>, <varname>MAXY</varname>),
+                       (<varname>MAXX</varname>, <varname>MAXY</varname>),
+                       (<varname>MAXX</varname>, <varname>MINY</varname>),
+                       (<varname>MINX</varname>, <varname>MINY</varname>))</para>
+                               </refsection>
+                               
+                               <refsection>
+                                       <title>Examples</title>
+                               
+                                       <programlisting>SELECT rid, ST_AsText(ST_Envelope(rast)) As envgeomwkt
+FROM dummy_rast;
+
+ rid |                                         envgeomwkt
+-----+--------------------------------------------------------------------
+   1 | POLYGON((0 0,20 0,20 60,0 60,0 0))
+   2 | POLYGON((3427927 5793243,3427928 5793243,
+               3427928 5793244,3427927 5793244, 3427927 5793243))
+                               </programlisting>
+                       
+                       </refsection>
+
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="ST_Envelope" />, <xref linkend="ST_AsText" />, <xref linkend="RT_ST_SRID" /></para>
+                       </refsection>
+               </refentry>
+               
                <refentry id="RT_ST_GeoReference">
                        <refnamediv>
                                <refname>ST_GeoReference</refname>