File: reference_old.xml

package info (click to toggle)
postgis 1.5.3-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 17,296 kB
  • sloc: sql: 77,621; ansic: 59,025; xml: 18,553; sh: 11,043; java: 6,061; perl: 2,133; makefile: 981; yacc: 299; python: 192
file content (241 lines) | stat: -rw-r--r-- 6,936 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<?xml version="1.0" encoding="UTF-8"?>
<chapter>
  <title>PostGIS Reference</title>

  <para>The functions given below are the ones which a user of PostGIS is
  likely to need. There are other functions which are required support
  functions to the PostGIS objects which are not of use to a general
  user.</para>

  <note>
    <para>PostGIS has begun a transition from the existing naming convention
    to an SQL-MM-centric convention. As a result, most of the functions that
    you know and love have been renamed using the standard spatial type (ST)
    prefix. Previous functions are still available, though are not listed in
    this document where updated functions are equivalent. These will be
    deprecated in a future release.</para>
  </note>

  <sect1>
    <title>OpenGIS Functions</title>

    <sect2>
      <title>Geometry Constructors</title>

      <variablelist>

        <varlistentry id="ST_PolyFromWKB">
          <term>ST_PolyFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
            suite</para>

            <para>throws an error if WKB is not a POLYGON</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ST_PolygonFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>from the conformance suite</para>

            <para>throws an error if WKB is not a POLYGON</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ST_MPointFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
            suite</para>

            <para>throws an error if WKB is not a MULTIPOINT</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ST_MLineFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
            suite</para>

            <para>throws an error if WKB is not a MULTILINESTRING</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ST_MPolyFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
            suite</para>

            <para>throws an error if WKB is not a MULTIPOLYGON</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>ST_GeomCollFromWKB(bytea,[&lt;srid&gt;])</term>

          <listitem>
            <para>Makes a Geometry from WKB with the given SRID. If SRID is
            not give, it defaults to -1.</para>

            <para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
            suite</para>

            <para>throws an error if WKB is not a GEOMETRYCOLLECTION</para>
          </listitem>
        </varlistentry>
	</variablelist>

    </sect2>
  </sect1>

  <sect1>
    <title>SQL-MM Functions</title>

    <para>This is a listing of the SQL-MM defined functions that PostGIS
    currently supports. The implementations of these functions follow the
    ArcSDE implementation, and thus deviate somewhat from the spec. These
    deviations will be noted.</para>

    <para>As of version 1.2.0, these functions have been implemented by
    wrapping existing PostGIS functions. As a result, full support for curved
    geometries may not be in place for many functions.</para>

    <note>
      <para>SQL-MM defines the default SRID of all geometry constructors as 0.
      PostGIS uses a default SRID of -1.</para>
    </note>

    <variablelist>  
      <varlistentry>
        <term>ST_MLineFromWKB</term>

        <listitem>
          <para>Return a specified ST_MultiLineString value.</para>

          <para>SQL-MM 3: 9.4.5</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ST_MPointFromWKB</term>

        <listitem>
          <para>Return a specified ST_MultiPoint value.</para>

          <para>SQL-MM 3: 9.2.5</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ST_MPolyFromWKB</term>

        <listitem>
          <para>Return a specified ST_MultiPolygon value.</para>

          <para>SQL-MM 3: 9.6.5</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ST_PolyFromWKB</term>

        <listitem>
          <para>Return a specified ST_Polygon value.</para>

          <para>SQL-MM 3: 8.3.7</para>
        </listitem>
      </varlistentry>
	 </variablelist>
  </sect1>

  <sect1>
    <title>ArcSDE Functions</title>

    <para>Additional functions have been added to improve support for an
    ArcSDE style interface.</para>

    <variablelist>
      <varlistentry>
        <term>SE_EnvelopesIntersect</term>

        <listitem>
          <para>Returns t (TRUE) if the envelopes of two geometries intersect;
          otherwise, it returns f (FALSE).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_Is3d</term>

        <listitem>
          <para>Test if a geometry value has z coordinate values.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_IsMeasured</term>

        <listitem>
          <para>Test if a geometry value has m coordinate values.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_LocateAlong</term>

        <listitem>
          <para>Return a derived geometry collection value with elements that
          match the specified measur.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_LocateBetween</term>

        <listitem>
          <para>Return a derived geometry collection value with elements that
          match the specified range of measures inclusively.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_M</term>

        <listitem>
          <para>Returns the m coordinate value of an ST_Point value.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SE_Z</term>

        <listitem>
          <para>Returns the z coordinate value of an ST_Point value</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>
</chapter>