File: if_carlson_rw5.rst

package info (click to toggle)
totalopenstation 0.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,784 kB
  • sloc: python: 4,123; makefile: 84; xml: 50
file content (338 lines) | stat: -rw-r--r-- 14,606 bytes parent folder | download | duplicates (3)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
.. _Carlson website: http://update.carlsonsw.com/kbase_attach/372/

.. _if_carlson_rw5:

===============================================================
:mod:`carlson_rw5` -- Carlson SurvCE Raw Data File Format (RW5)
===============================================================

.. moduleauthor:: Stefano Costa, Filip Kłosowski
.. versionadded:: 0.4

Carlson RW5 is an exchange format used by the Carlson SurvCE software.

The official documentation about the format is provided on the
`Carlson website`_.

RW5 is a rich format for raw data about the entire field operation of total
stations and even GPS.

For example::

  OC,OP111,N 16556174.237,E 942130.662,EL 16.404
  BK,OP111,BP108,BS0.00000,BC0.00000 LS,HI5.684,HR5.500
  SS,OP111,FP108,AR0.00000,ZE0.00017,SD3.3566,--FENCE1
  
At the moment, a minimal subset of the specification is supported, consisting of
the ``OC``, ``BP``, ``LS`` and ``SS`` record types.

Carlson Record Information
==========================

The format is a comma separated ASCII file containing record types, headers,
recorded data and comments. The format is based on the :ref:`tds` raw data
specification with the exception of angle sets.

Angle sets are recorded as BD, BR, FD and FR records to allow reduction of all
possible data that can be recorded by SurvCE using the “Set Collection”
routine. Essentially, these records are identical to a sideshot record. With
the exception of the aforementioned angle set records, if the :ref:`tds`
specification is modified to provide enhanced functionality, the added or
modified data will reside in comment records to avoid incompatibility with
existing software.

Each record is made of one line of text, with comma-separated fields of ASCII
text format::

  AH,DC%s,MA%s,ME%s,RA%s

The first field is a two-letter code of the type of record. All the following
fields are composed with 1- or 2- letter field codes (such as ``OP``, ``N`` or
``FP``) and numeric values called an (ENUM). The “Notes” field is introduced by
the ``--`` code and contains a description of the record.

In practice, each point has a unique number and can be referenced for various
purposes from other records.

*Sideshot* records (``SS``) reference the *Occupy point* record in the``OP``
field. 

Record types
------------

+-------------+-----------------------------------------------+-----------------------+
| Record Type | Explanation                                   | Applicable for        |
+=============+===============================================+=======================+
| ``--`` *    | Note                                          | General Raw Data      |
+-------------+-----------------------------------------------+-----------------------+
| JB*         | Job                                           |                       |
+-------------+-----------------------------------------------+-----------------------+
| MO*         | Mode Setup                                    |                       |
+-------------+-----------------------------------------------+-----------------------+
| BD*         | Backsight Direct                              | Conventional Raw Data |
+-------------+-----------------------------------------------+-----------------------+
| BK*         | Backsight                                     |                       |
+-------------+-----------------------------------------------+-----------------------+
| BR*         | Backsight Reverse                             |                       |
+-------------+-----------------------------------------------+-----------------------+
| FD*         | Foresight Direct                              |                       |
+-------------+-----------------------------------------------+-----------------------+
| FR*         | Foresight Reverse                             |                       |
+-------------+-----------------------------------------------+-----------------------+
| GPS         | GPS Position in |br|                          |                       |
|             | Lat: dd.mmss |br|                             |                       |
|             | Lon: dd.mmss - Negative for West |br|         |                       |
|             | WGS84 Ellipsoid Elevation                     |                       |
+-------------+-----------------------------------------------+-----------------------+
| GS          | Reduced local coordinate from GPS record |br| |                       |
|             | and localization data                         |                       |
+-------------+-----------------------------------------------+-----------------------+
| LS*         | Line of Sight                                 |                       |
+-------------+-----------------------------------------------+-----------------------+
| OC*         | Occupy Point                                  |                       |
+-------------+-----------------------------------------------+-----------------------+
| OF          | Off Center Shot                               |                       |
+-------------+-----------------------------------------------+-----------------------+
| SP*         | Store Point                                   |                       |
+-------------+-----------------------------------------------+-----------------------+
| TR/SS*      | Traverse / Sideshot                           |                       |
+-------------+-----------------------------------------------+-----------------------+

\* implemented type

Field headers
-------------

+--------------+--------------------------------+----------------+
| Field header | Explanation                    | Applicable for |
+--------------+--------------------------------+----------------+
| AD           | Azimuth Direction |br|         |                |
|              | 0: North |br|                  |                |
|              | 1: South                       |                |
+--------------+--------------------------------+----------------+
| AL*          | Angle-Left                     |                |
+--------------+--------------------------------+----------------+
| AR*          | Angle-Right                    |                |
+--------------+--------------------------------+----------------+
| AU*          | Angle Unit |br|                |                |
|              | 0: 360° sexagesimal |br|       |                |
|              | 1: 400 gon                     |                |
+--------------+--------------------------------+----------------+
| AZ*          | Azimuth                        |                |
+--------------+--------------------------------+----------------+
| BC*          | Back Circle                    |                |
+--------------+--------------------------------+----------------+
| BP*          | Back Point                     |                |
+--------------+--------------------------------+----------------+
| BR*          | Bearing |br|                   |                |
|              | [N123.4500W]                   |                |
+--------------+--------------------------------+----------------+
| BS           | Backsight |br|                 |                |
|              | when back point is not defined |                |
+--------------+--------------------------------+----------------+
| CE*          | Change Elevation               |                |
+--------------+--------------------------------+----------------+
| DL*          | Deflection-Left                |                |
+--------------+--------------------------------+----------------+
| DR*          | Deflection-Right               |                |
+--------------+--------------------------------+----------------+
| DT           | Local Date |br|                |                |
|              | [MM-DD-YYYY]                   |                |
+--------------+--------------------------------+----------------+
| E*           | Easting |br|                   |                |
|              | [E space]                      |                |
+--------------+--------------------------------+----------------+
| EC           | Earth Curvature |br|           |                |
|              | 0: off |br|                    |                |
|              | 1: on                          |                |
+--------------+--------------------------------+----------------+
| EL*          | Elevation                      |                |
+--------------+--------------------------------+----------------+
| EO           | EDM Offset                     |                |
+--------------+--------------------------------+----------------+
| FE           | Foresight Elevation            |                |
+--------------+--------------------------------+----------------+
| FP*          | Foresight Point                |                |
+--------------+--------------------------------+----------------+
| HD*          | Horizontal Distance            |                |
+--------------+--------------------------------+----------------+
| HI*          | Height of Instrument           |                |
+--------------+--------------------------------+----------------+
| HR*          | Height of Rod                  |                |
+--------------+--------------------------------+----------------+
| N            | Northing |br|                  |                |
|              | [N space]                      |                |
+--------------+--------------------------------+----------------+
| OC           | Occupy Point                   |                |
+--------------+--------------------------------+----------------+
| OP           | Occupy Point                   |                |
+--------------+--------------------------------+----------------+
| PN           | Point Number                   |                |
+--------------+--------------------------------+----------------+
| SD*          | Slope Distance                 |                |
+--------------+--------------------------------+----------------+
| SF           | Scale Factor                   |                |
+--------------+--------------------------------+----------------+
| TM           | Local Time |br|                |                |
|              | [HH:MM:SS]                     |                |
+--------------+--------------------------------+----------------+
| UN*          | Distance Unit |br|             |                |
|              | 0: feet |br|                   |                |
|              | 1: meter |br|                  |                |
|              | 2: US feet                     |                |
+--------------+--------------------------------+----------------+
| VA*          | Vertical Angle                 |                |
+--------------+--------------------------------+----------------+
| ZE*          | Zenith                         |                |
+--------------+--------------------------------+----------------+
| ``--``       | Note                           |                |
+--------------+--------------------------------+----------------+

\* Filed implemented

Definitions
===========

Backsight Record
----------------
:Record type: BK
:Field headers: 
   OP Occupy point |br|
   BP Back Point |br|
   BS Backsight |br|
   BC Back Circle
:Sample(s):
  ::

    BK,OP1,BP2,BS315.0000,BC0.0044

Job Record
----------
:Record type: JB
:Field headers: 
   NM Job name |br|
   DT Date |br|
   TM Time
:Sample(s):
  ::

    JB,NMSAMPLE,DT06-27-2003,TM14:21:53

Line of Sight Record
--------------------
:Record type: LS
:Field headers: 
   HI Height of Instrument |br|
   HR Height of Rod
:Sample(s):
  ::

    LS,HI5.000000,HR6.000000
    LS,HR4.000000

Mode Setup Record
-----------------
The mode setup will be recorded at the beginning of the raw data file.

:Record type: MO
:Field headers: 
   AD Azimuth direction |br|
   UN Distance unit |br|
   SF Scale factor |br|
   EC Earth Curvature |br|
   EO EDM offset |br|
   AU Angle Unit
:Sample(s):
  ::

    MO,AD0,UN0,SF1.00000000,EC1,EO0.0,AU0

Occupy Record
-------------
:Record type: OC
:Field headers: 
   PN Point number |br|
   N Northing |br|
   E Easting |br|
   EL Elevation |br|
   ``--`` Note
:Sample(s):
  ::

    OC,OP1,N 5000.00000,E 5000.00000,EL100.000,--CP

Off Center Shot Record
----------------------
:Record type: OF
:Field headers: 
   AR Angle right |br|
   ZE Zenith (actual) |br|
   SD Slope Distance
:Sample(s):
  ::

    OF,AR90.3333,ZE90.0000,SD25.550000
    OF,ZE90.3333,--Vert Angle Offset

Store Point Record
------------------
:Record type: SP
:Field headers: 
   PN Point Number |br|
   N Northing |br|
   E Easting |br|
   EL Elevation |br|
   ``--`` Note
:Sample(s):
  ::

    SP,PN100,N 5002.0000,E 5000.0000,EL100.0000,--PP

Traverse / Sideshot Record / Backsight Direct / Backsight Reverse / Foresight Direct / Foresight Reverse
--------------------------------------------------------------------------------------------------------
:Record type: TR / SS / BD / BR / FD / FR
:Field headers: 
  OP Occupy Point |br|
  FP Foresight Point |br|
  (one of the following) |br|
  - AZ Azimuth |br|
  - BR Bearing |br|
  - AR Angle-Right |br|
  - AL Angle-Left |br|
  - DR Deflection-Right |br|
  - DL Deflection-Left
  (one of the following) |br|
  - ZE Zenith |br|
  - VA Vertical angle |br|
  - CE Change Elevation |br|
  (one of the following) |br|
  - SD Slope Distance |br|
  - HD Horizontal Distance |br|
  ``--`` Note
:Sample(s):
  ::

    TR,OP1,FP4,AR90.3333,ZE90.3333,SD25.550000,--CP
    SS,OP1,FP2,AR0.0044,ZE86.0133,SD10.313750,--CP
    BD,OP1,FP2,AR0.0055,ZE86.0126,SD10.320000,--CP
    BR,OP1,FP2,AR180.0037,ZE273.5826,SD10.315000,--CP
    FD,OP1,FP3,AR57.1630,ZE89.4305,SD7.393000,--CP
    FR,OP1,FP3,AR237.1612,ZE270.1548,SD7.395000,--CP

TOPS is capable of converting raw measurement data into local coordinates, by
performing a sequential processing of all records in their order.

Known limitations
=================

Support for measurements is still incomplete, here is a list of **TODO**:
  * add all missing code
  * get comments
  * add the possibility to customize code

.. seealso::

  `Information on Carlson RW5  <http://web.carlsonsw.com/files/knowledgebase/kbase_attach/372/Info%20-%20SurvCE%20RW5%20Format.pdf>`_ |br|
  `Carlson RW5 format <http://web.carlsonsw.com/files/knowledgebase/kbase_attach/223/SurvCE%20RW5%20Format.pdf>`_ |br|
  Documentation for Carlson RW5 from Carlson knowledgebase.