Revision 26395 branches/v10/libraries/libDielmoOpenLidar/src/com/dielmo/lidar/LidarHeader.java

View differences:

LidarHeader.java
1 1
/* DielmoOpenLiDAR
2 2
 *
3
 * Copyright (C) 2008 DIELMO 3D S.L. (DIELMO) and Infrastructures  
3
 * Copyright (C) 2008 DIELMO 3D S.L. (DIELMO) and Infrastructures
4 4
 * and Transports Department of the Valencian Government (CIT)
5
 * 
5
 *
6 6
 * This program is free software; you can redistribute it and/or
7 7
 * modify it under the terms of the GNU General Public License
8 8
 * as published by the Free Software Foundation; either version 2
9 9
 * of the License, or (at your option) any later version.
10
 * 
10
 *
11 11
 * This program is distributed in the hope that it will be useful,
12 12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 14
 * GNU General Public License for more details.
15
 * 
15
 *
16 16
 * You should have received a copy of the GNU General Public License
17 17
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19 19
 * MA  02110-1301, USA.
20 20
 *
21 21
 * For more information, contact:
......
24 24
 * Plaza Vicente Andr?s Estell?s 1 Bajo E
25 25
 * 46950 Xirivella, Valencia
26 26
 * SPAIN
27
 *   
27
 *
28 28
 * +34 963137212
29 29
 * dielmo@dielmo.com
30 30
 * www.dielmo.com
31
 * 
31
 *
32 32
 * or
33
 * 
33
 *
34 34
 * Generalitat Valenciana
35 35
 * Conselleria d'Infraestructures i Transport
36 36
 * Av. Blasco Ib??ez, 50
......
44 44

  
45 45
/*
46 46
 * AUTHORS (In addition to DIELMO and CIT):
47
 *  
47
 *
48 48
 */
49 49

  
50 50
package com.dielmo.lidar;
......
54 54

  
55 55
/**
56 56
 * Interface Lidar point
57
 * 
57
 *
58 58
 * @author Oscar Garcia
59 59
 */
60 60
public interface LidarHeader{
61
	
61

  
62 62
	// max value for an unsigned int variable.
63 63
	final int UNSIGNED_INT_MAX = (int)(Math.pow(2, 32)-1);
64 64
	// max value for an unsigned short variable.
65 65
	final int UNSIGNED_SHORT_MAX = (int)(Math.pow(2, 16)-1);
66
	
67
	public static final int LAS10F0 = 0;	
66

  
67
	public static final int LAS10F0 = 0;
68 68
	public static final int LAS10F1 = 1;
69 69
	public static final int LAS11F0 = 2;
70 70
	public static final int LAS11F1 = 3;
71
	public static final int LAS12F0 = 4;	
71
	public static final int LAS12F0 = 4;
72 72
	public static final int LAS12F1 = 5;
73 73
	public static final int LAS12F2 = 6;
74 74
	public static final int LAS12F3 = 7;
75 75
	public static final int BIN20010712 = 8;
76 76
	public static final int BIN20020715 = 9;
77 77
	public static final int UNEXPECTED= 9999;
78
	
78

  
79 79
	/**
80 80
	 * Read the header file
81
	 * 
82
	 * @return true if success else return false 
81
	 *
82
	 * @return true if success else return false
83 83
	 */
84 84
	public boolean readLidarHeader();
85
	
85

  
86 86
	/**
87 87
	 * Write the header file
88
	 * 
89
	 * @return true if success else return false 
88
	 *
89
	 * @return true if success else return false
90 90
	 */
91 91
	public boolean writeLidarHeader(ByteBuffer bb);
92
	
92

  
93 93
	// GET METHODS
94 94
	/**
95 95
	 * Return Size, in bytes, of the header file
96
	 * 
96
	 *
97 97
	 *  @return header size
98 98
	 */
99 99
	public int getHdrSize();
100
	
100

  
101 101
	/**
102 102
	 * Return the total number of points records within the file
103
	 * 
103
	 *
104 104
	 * @return number of points of file
105 105
	 */
106 106
	public long getNumPointsRecord();
107
	
107

  
108 108
	/**
109 109
	 * Return Number of bytes from the beginning of the file
110 110
	 * to the first point record data.
111
	 * 
111
	 *
112 112
	 * @return offset to data
113 113
	 */
114 114
	public long getOffsetData();
115
	
115

  
116 116
	/**
117
	 * Return the x scale factor for the scale corresponding X values 
117
	 * Return the x scale factor for the scale corresponding X values
118 118
	 * within the point record.
119
	 * 
119
	 *
120 120
	 * @return X scale
121 121
	 */
122 122
	public double getXScale();
123
	
123

  
124 124
	/**
125
	 * Return the y scale factor for the scale corresponding Y values 
125
	 * Return the y scale factor for the scale corresponding Y values
126 126
	 * within the point record.
127
	 * 
127
	 *
128 128
	 * @return Y scale
129 129
	 */
130 130
	public double getYScale();
131
	
131

  
132 132
	/**
133
	 * Return the z scale factor for the scale corresponding Z values 
133
	 * Return the z scale factor for the scale corresponding Z values
134 134
	 * within the point record.
135
	 * 
135
	 *
136 136
	 * @return Z scale
137 137
	 */
138 138
	public double getZScale();
139
	
139

  
140 140
	/**
141 141
	 * Return the x offset used to set the overall offset for the point record
142 142
	 * @return X offset
143 143
	 */
144 144
	public double getXOffset();
145
	
145

  
146 146
	/**
147 147
	 * Return the y offset used to set the overall offset for the point record
148 148
	 * @return Y offset
149 149
	 */
150 150
	public double getYOffset();
151
	
151

  
152 152
	/**
153 153
	 * Return the z offset used to set the overall offset for the point record
154 154
	 * @return Z offset
155 155
	 */
156 156
	public double getZOffset();
157
	
157

  
158 158
	/**
159 159
	 * Return maximum x of coordinate extent of the file.
160
	 * 
160
	 *
161 161
	 * @return X max
162 162
	 */
163 163
	public double getMaxX();
164
	
164

  
165 165
	/**
166 166
	 * Return maximum y of coordinate extent of the file.
167
	 * 
167
	 *
168 168
	 * @return Y max
169 169
	 */
170 170
	public double getMaxY();
171
	
171

  
172 172
	/**
173 173
	 * Return maximum z of coordinate extent of the file.
174
	 * 
174
	 *
175 175
	 * @return Z max
176 176
	 */
177 177
	public double getMaxZ();
178
	
178

  
179 179
	/**
180 180
	 * Return minimum x of coordinate extent of the file.
181
	 * 
181
	 *
182 182
	 * @return X min
183 183
	 */
184 184
	public double getMinX();
185
	
185

  
186 186
	/**
187 187
	 * Return minimum y of coordinate extent of the file.
188
	 * 
188
	 *
189 189
	 * @return Y min
190 190
	 */
191 191
	public double getMinY();
192
	
192

  
193 193
	/**
194 194
	 * Return minimum z of coordinate extent of the file.
195
	 * 
195
	 *
196 196
	 * @return Z min
197 197
	 */
198 198
	public double getMinZ();
199
	
200
	
199

  
200

  
201 201
	// SET METHODS
202
	
202

  
203 203
	/**
204 204
	 * Set size of the header file
205 205
	 */
206 206
	public void setHdrSize(int newValue);
207
	
207

  
208 208
	/**
209 209
	 * Set the total number of points records within the file
210 210
	 */
211 211
	public void setNumPointsRecord(long newValue);
212
	
212

  
213 213
	/**
214 214
	 * Set number of bytes from the beginning of the file
215 215
	 * to the first point record data.
216 216
	 */
217 217
	public void setOffsetData(long newValue);
218
	
218

  
219 219
	/**
220
	 * Set the x scale factor for the scale corresponding X values 
220
	 * Set the x scale factor for the scale corresponding X values
221 221
	 * within the point record.
222 222
	 */
223 223
	public void setXScale(double newValue);
224
	
224

  
225 225
	/**
226
	 * Set the y scale factor for the scale corresponding Y values 
226
	 * Set the y scale factor for the scale corresponding Y values
227 227
	 * within the point record.
228 228
	 */
229 229
	public void setYScale(double newValue);
230
	
230

  
231 231
	/**
232
	 * Set the z scale factor for the scale corresponding Z values 
232
	 * Set the z scale factor for the scale corresponding Z values
233 233
	 * within the point record.
234 234
	 */
235 235
	public void setZScale(double newValue);
236
	
236

  
237 237
	/**
238 238
	 * Set the x offset used to set the overall offset for the point record
239 239
	 */
240 240
	public void setXOffset(double newValue);
241
	
241

  
242 242
	/**
243 243
	 * Set the y offset used to set the overall offset for the point record
244 244
	 */
245 245
	public void setYOffset(double newValue);
246
	
246

  
247 247
	/**
248 248
	 * Set the z offset used to set the overall offset for the point record
249 249
	 */
250 250
	public void setZOffset(double newValue);
251
	
251

  
252 252
	/**
253 253
	 * Set maximum x of coordinate extent of the file.
254 254
	 */
255 255
	public void setMaxX(double newValue);
256
	
256

  
257 257
	/**
258 258
	 * Set maximum y of coordinate extent of the file.
259 259
	 */
260 260
	public void setMaxY(double newValue);
261
	
261

  
262 262
	/**
263 263
	 * Set maximum z of coordinate extent of the file.
264 264
	 */
265 265
	public void setMaxZ(double newValue);
266
	
266

  
267 267
	/**
268 268
	 * Set minimum x of coordinate extent of the file.
269 269
	 */
270 270
	public void setMinX(double newValue);
271
	
271

  
272 272
	/**
273 273
	 * Set minimum y of coordinate extent of the file.
274 274
	 */
275 275
	public void setMinY(double newValue);
276
	
276

  
277 277
	/**
278 278
	 * Set minimum z of coordinate extent of the file.
279 279
	 */
280 280
	public void setMinZ(double newValue);
281
	
281

  
282 282
	/**
283 283
	 * Return the version type of Lidar Header
284
	 */ 
284
	 */
285 285
	public int getVersion();
286

  
286 287
}

Also available in: Unified diff