forked from OSGeo/gdal
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathgdal_python.i
4654 lines (4111 loc) · 166 KB
/
gdal_python.i
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* $Id$
*
* python specific code for gdal bindings.
*/
%feature("autodoc");
%include "gdal_band_docs.i"
%include "gdal_dataset_docs.i"
%init %{
/* gdal_python.i %init code */
if ( GDALGetDriverCount() == 0 ) {
GDALAllRegister();
}
// Will be turned on for GDAL 4.0
// UseExceptions();
%}
%{
static int getAlignment(GDALDataType ntype)
{
switch(ntype)
{
case GDT_Unknown:
break; // shouldn't happen
case GDT_Byte:
case GDT_Int8:
return 1;
case GDT_Int16:
case GDT_UInt16:
return 2;
case GDT_Int32:
case GDT_UInt32:
case GDT_Float32:
return 4;
case GDT_Float64:
case GDT_Int64:
case GDT_UInt64:
return 8;
case GDT_CInt16:
return 2;
case GDT_CInt32:
case GDT_CFloat32:
return 4;
case GDT_CFloat64:
return 8;
case GDT_TypeCount:
break; // shouldn't happen
}
// shouldn't happen
CPLAssert(false);
return 1;
}
static bool readraster_acquirebuffer(void** buf,
void*& inputOutputBuf,
size_t buf_size,
GDALDataType ntype,
int l_bUseExceptions,
char*& data,
Py_buffer& view)
{
SWIG_PYTHON_THREAD_BEGIN_BLOCK;
if( inputOutputBuf == Py_None )
inputOutputBuf = NULL;
if( inputOutputBuf )
{
if (PyObject_GetBuffer( (PyObject*)inputOutputBuf, &view,
PyBUF_SIMPLE | PyBUF_WRITABLE) == 0)
{
if( static_cast<GUIntBig>(view.len) < buf_size )
{
PyBuffer_Release(&view);
SWIG_PYTHON_THREAD_END_BLOCK;
CPLError(CE_Failure, CPLE_AppDefined,
"buf_obj length is " CPL_FRMT_GUIB " bytes. "
"It should be at least " CPL_FRMT_GUIB,
static_cast<GUIntBig>(view.len),
static_cast<GUIntBig>(buf_size));
return false;
}
data = (char*)view.buf;
if( (reinterpret_cast<uintptr_t>(data) % getAlignment(ntype)) != 0 )
{
PyBuffer_Release(&view);
SWIG_PYTHON_THREAD_END_BLOCK;
CPLError(CE_Failure, CPLE_AppDefined,
"buffer has not the appropriate alignment");
return false;
}
}
else
{
PyErr_Clear();
SWIG_PYTHON_THREAD_END_BLOCK;
CPLError(CE_Failure, CPLE_AppDefined,
"buf_obj is not a simple writable buffer");
return false;
}
}
else
{
*buf = (void *)PyByteArray_FromStringAndSize( NULL, buf_size );
if (*buf == NULL)
{
*buf = Py_None;
if( !l_bUseExceptions )
{
PyErr_Clear();
}
SWIG_PYTHON_THREAD_END_BLOCK;
CPLError(CE_Failure, CPLE_OutOfMemory, "Cannot allocate result buffer");
return false;
}
data = PyByteArray_AsString( (PyObject *)*buf );
}
SWIG_PYTHON_THREAD_END_BLOCK;
return true;
}
static void readraster_releasebuffer(CPLErr eErr,
void** buf,
void* inputOutputBuf,
Py_buffer& view)
{
SWIG_PYTHON_THREAD_BEGIN_BLOCK;
if( inputOutputBuf )
PyBuffer_Release(&view);
if (eErr == CE_Failure)
{
if( inputOutputBuf == NULL )
Py_DECREF((PyObject*)*buf);
*buf = NULL;
}
else if( inputOutputBuf )
{
*buf = inputOutputBuf;
Py_INCREF((PyObject*)*buf);
}
SWIG_PYTHON_THREAD_END_BLOCK;
}
%}
%pythoncode %{
have_warned = 0
def deprecation_warn(module, sub_package=None, new_module=None):
global have_warned
if have_warned == 1:
return
have_warned = 1
if sub_package is None or sub_package == 'utils':
sub_package = 'osgeo_utils'
if new_module is None:
new_module = module
new_module = '{}.{}'.format(sub_package, new_module)
from warnings import warn
warn('{}.py was placed in a namespace, it is now available as {}' .format(module, new_module),
DeprecationWarning)
from osgeo.gdalconst import *
from osgeo import gdalconst
import sys
byteorders = {"little": "<",
"big": ">"}
array_modes = { gdalconst.GDT_Int16: ("%si2" % byteorders[sys.byteorder]),
gdalconst.GDT_UInt16: ("%su2" % byteorders[sys.byteorder]),
gdalconst.GDT_Int32: ("%si4" % byteorders[sys.byteorder]),
gdalconst.GDT_UInt32: ("%su4" % byteorders[sys.byteorder]),
gdalconst.GDT_Float32: ("%sf4" % byteorders[sys.byteorder]),
gdalconst.GDT_Float64: ("%sf8" % byteorders[sys.byteorder]),
gdalconst.GDT_CFloat32: ("%sf4" % byteorders[sys.byteorder]),
gdalconst.GDT_CFloat64: ("%sf8" % byteorders[sys.byteorder]),
gdalconst.GDT_Byte: ("%st8" % byteorders[sys.byteorder]),
}
def RGBFile2PCTFile( src_filename, dst_filename ):
src_ds = Open(src_filename)
if src_ds is None or src_ds == 'NULL':
return 1
ct = ColorTable()
err = ComputeMedianCutPCT(src_ds.GetRasterBand(1),
src_ds.GetRasterBand(2),
src_ds.GetRasterBand(3),
256, ct)
if err != 0:
return err
gtiff_driver = GetDriverByName('GTiff')
if gtiff_driver is None:
return 1
dst_ds = gtiff_driver.Create(dst_filename,
src_ds.RasterXSize, src_ds.RasterYSize)
dst_ds.GetRasterBand(1).SetRasterColorTable(ct)
err = DitherRGB2PCT(src_ds.GetRasterBand(1),
src_ds.GetRasterBand(2),
src_ds.GetRasterBand(3),
dst_ds.GetRasterBand(1),
ct)
dst_ds = None
src_ds = None
return 0
def listdir(path, recursionLevel = -1, options = []):
""" Iterate over a directory.
recursionLevel = -1 means unlimited level of recursion.
"""
dir = OpenDir(path, recursionLevel, options)
if not dir:
raise OSError(path + ' does not exist')
try:
while True:
entry = GetNextDirEntry(dir)
if not entry:
break
yield entry
finally:
CloseDir(dir)
%}
%{
#define MODULE_NAME "gdal"
%}
%include "python_exceptions.i"
%include "python_strings.i"
%import typemaps_python.i
/* -------------------------------------------------------------------- */
/* VSIFReadL() */
/* -------------------------------------------------------------------- */
%rename (VSIFReadL) wrapper_VSIFReadL;
%apply ( void **outPythonObject ) { (void **buf ) };
%apply Pointer NONNULL {VSILFILE* fp};
%inline %{
unsigned int wrapper_VSIFReadL( void **buf, unsigned int nMembSize, unsigned int nMembCount, VSILFILE *fp)
{
size_t buf_size = static_cast<size_t>(nMembSize) * nMembCount;
if( buf_size > 0xFFFFFFFFU )
{
CPLError(CE_Failure, CPLE_AppDefined, "Too big request");
*buf = NULL;
return 0;
}
if (buf_size == 0)
{
*buf = NULL;
return 0;
}
SWIG_PYTHON_THREAD_BEGIN_BLOCK;
*buf = (void *)PyByteArray_FromStringAndSize( NULL, buf_size );
if (*buf == NULL)
{
*buf = Py_None;
if( !GetUseExceptions() )
{
PyErr_Clear();
}
SWIG_PYTHON_THREAD_END_BLOCK;
CPLError(CE_Failure, CPLE_OutOfMemory, "Cannot allocate result buffer");
return 0;
}
PyObject* o = (PyObject*) *buf;
char *data = PyByteArray_AsString(o);
SWIG_PYTHON_THREAD_END_BLOCK;
size_t nRet = (size_t)VSIFReadL( data, nMembSize, nMembCount, fp );
if (nRet * (size_t)nMembSize < buf_size)
{
SWIG_PYTHON_THREAD_BEGIN_BLOCK;
PyByteArray_Resize(o, nRet * nMembSize);
SWIG_PYTHON_THREAD_END_BLOCK;
*buf = o;
}
return static_cast<unsigned int>(nRet);
}
%}
%clear (void **buf );
%clear VSILFILE* fp;
/* -------------------------------------------------------------------- */
/* VSIGetMemFileBuffer_unsafe() */
/* -------------------------------------------------------------------- */
%rename (VSIGetMemFileBuffer_unsafe) wrapper_VSIGetMemFileBuffer;
%typemap(in, numinputs=0) (GByte **out, vsi_l_offset *length) (GByte *out = NULL, vsi_l_offset length) {
$1 = &out;
$2 = &length;
}
%typemap(argout) (GByte **out, vsi_l_offset *length) {
if (*$1 == NULL) {
if( GetUseExceptions() ) {
PyErr_SetString(PyExc_RuntimeError, "Could not find path");
$result = NULL;
} else {
CPLError(CE_Failure, CPLE_AppDefined, "Could not find path");
$result = Py_None;
Py_INCREF($result);
}
} else {
do {
$result = PyMemoryView_FromMemory(reinterpret_cast<char *>(*$1), *$2, PyBUF_READ);
if ($result == NULL) {
if( GetUseExceptions() ) {
PyErr_SetString(PyExc_RuntimeError, "Could not allocate result buffer");
$result = NULL;
} else {
CPLError(CE_Failure, CPLE_AppDefined, "Could not allocate result buffer");
$result = Py_None;
Py_INCREF($result);
}
}
} while(0);
}
}
%inline %{
void wrapper_VSIGetMemFileBuffer(const char *utf8_path, GByte **out, vsi_l_offset *length)
{
*out = VSIGetMemFileBuffer(utf8_path, length, 0);
}
%}
%clear (GByte **out, vsi_l_offset *length);
/* -------------------------------------------------------------------- */
/* GDAL_GCP */
/* -------------------------------------------------------------------- */
%extend GDAL_GCP {
%pythoncode %{
def __str__(self):
str = '%s (%.2fP,%.2fL) -> (%.7fE,%.7fN,%.2f) %s '\
% (self.Id, self.GCPPixel, self.GCPLine,
self.GCPX, self.GCPY, self.GCPZ, self.Info )
return str
def serialize(self, with_Z=0):
base = [gdalconst.CXT_Element, 'GCP']
base.append([gdalconst.CXT_Attribute, 'Id', [gdalconst.CXT_Text, self.Id]])
pixval = '%0.15E' % self.GCPPixel
lineval = '%0.15E' % self.GCPLine
xval = '%0.15E' % self.GCPX
yval = '%0.15E' % self.GCPY
zval = '%0.15E' % self.GCPZ
base.append([gdalconst.CXT_Attribute, 'Pixel', [gdalconst.CXT_Text, pixval]])
base.append([gdalconst.CXT_Attribute, 'Line', [gdalconst.CXT_Text, lineval]])
base.append([gdalconst.CXT_Attribute, 'X', [gdalconst.CXT_Text, xval]])
base.append([gdalconst.CXT_Attribute, 'Y', [gdalconst.CXT_Text, yval]])
if with_Z:
base.append([gdalconst.CXT_Attribute, 'Z', [gdalconst.CXT_Text, zval]])
return base
%} /* pythoncode */
}
%extend GDALRasterBandShadow {
%apply ( void *inPythonObject ) { (void* inputOutputBuf) };
%apply ( void **outPythonObject ) { (void **buf ) };
%apply ( int *optional_int ) {(int*)};
%apply ( GDALDataType *optional_GDALDataType ) {(GDALDataType*)};
%apply ( GIntBig *optional_GIntBig ) {(GIntBig*)};
%feature( "kwargs" ) ReadRaster1;
CPLErr ReadRaster1( double xoff, double yoff, double xsize, double ysize,
void **buf,
int *buf_xsize = 0,
int *buf_ysize = 0,
GDALDataType *buf_type = 0,
GIntBig *buf_pixel_space = 0,
GIntBig *buf_line_space = 0,
GDALRIOResampleAlg resample_alg = GRIORA_NearestNeighbour,
GDALProgressFunc callback = NULL,
void* callback_data=NULL,
void* inputOutputBuf = NULL) {
*buf = NULL;
int nxsize = (buf_xsize==0) ? static_cast<int>(xsize) : *buf_xsize;
int nysize = (buf_ysize==0) ? static_cast<int>(ysize) : *buf_ysize;
GDALDataType ntype = (buf_type==0) ? GDALGetRasterDataType(self)
: *buf_type;
GIntBig pixel_space = (buf_pixel_space == 0) ? 0 : *buf_pixel_space;
GIntBig line_space = (buf_line_space == 0) ? 0 : *buf_line_space;
size_t buf_size = static_cast<size_t>(
ComputeBandRasterIOSize( nxsize, nysize,
GDALGetDataTypeSize( ntype ) / 8,
pixel_space, line_space, FALSE ) );
if (buf_size == 0)
{
return CE_Failure;
}
char *data;
Py_buffer view;
if( !readraster_acquirebuffer(buf, inputOutputBuf, buf_size, ntype,
GetUseExceptions(), data, view) )
{
return CE_Failure;
}
/* Should we clear the buffer in case there are hole in it ? */
if( inputOutputBuf == NULL &&
line_space != 0 && pixel_space != 0 && line_space > pixel_space * nxsize )
{
memset(data, 0, buf_size);
}
GDALRasterIOExtraArg sExtraArg;
INIT_RASTERIO_EXTRA_ARG(sExtraArg);
sExtraArg.eResampleAlg = resample_alg;
sExtraArg.pfnProgress = callback;
sExtraArg.pProgressData = callback_data;
int nXOff = (int)(xoff + 0.5);
int nYOff = (int)(yoff + 0.5);
int nXSize = (int)(xsize + 0.5);
int nYSize = (int)(ysize + 0.5);
if( fabs(xoff-nXOff) > 1e-8 || fabs(yoff-nYOff) > 1e-8 ||
fabs(xsize-nXSize) > 1e-8 || fabs(ysize-nYSize) > 1e-8 )
{
sExtraArg.bFloatingPointWindowValidity = TRUE;
sExtraArg.dfXOff = xoff;
sExtraArg.dfYOff = yoff;
sExtraArg.dfXSize = xsize;
sExtraArg.dfYSize = ysize;
}
CPLErr eErr = GDALRasterIOEx( self, GF_Read, nXOff, nYOff, nXSize, nYSize,
data, nxsize, nysize, ntype,
pixel_space, line_space, &sExtraArg );
readraster_releasebuffer(eErr, buf, inputOutputBuf, view);
return eErr;
}
%clear (void **buf );
%clear (void* inputOutputBuf);
%clear (int*);
%clear (GIntBig*);
%clear (GDALDataType *);
%apply ( void *inPythonObject ) { (void* buf_obj) };
%apply ( void **outPythonObject ) { (void **buf ) };
%feature( "kwargs" ) ReadBlock;
CPLErr ReadBlock( int xoff, int yoff, void **buf, void* buf_obj=NULL) {
int nBlockXSize, nBlockYSize;
GDALGetBlockSize(self, &nBlockXSize, &nBlockYSize);
GDALDataType ntype = GDALGetRasterDataType(self);
int nDataTypeSize = (GDALGetDataTypeSize(ntype) / 8);
size_t buf_size = static_cast<size_t>(nBlockXSize) *
nBlockYSize * nDataTypeSize;
*buf = NULL;
char *data;
Py_buffer view;
if( !readraster_acquirebuffer(buf, buf_obj, buf_size, ntype,
GetUseExceptions(), data, view) )
{
return CE_Failure;
}
CPLErr eErr = GDALReadBlock( self, xoff, yoff, data);
readraster_releasebuffer(eErr, buf, buf_obj, view);
return eErr;
}
%clear (void **buf );
%clear (void* buf_obj);
%pythoncode %{
def ReadRaster(self, xoff=0, yoff=0, xsize=None, ysize=None,
buf_xsize=None, buf_ysize=None, buf_type=None,
buf_pixel_space=None, buf_line_space=None,
resample_alg=gdalconst.GRIORA_NearestNeighbour,
callback=None,
callback_data=None,
buf_obj=None):
if xsize is None:
xsize = self.XSize
if ysize is None:
ysize = self.YSize
return _gdal.Band_ReadRaster1(self, xoff, yoff, xsize, ysize,
buf_xsize, buf_ysize, buf_type,
buf_pixel_space, buf_line_space,
resample_alg, callback, callback_data,
buf_obj)
def WriteRaster(self, xoff, yoff, xsize, ysize,
buf_string,
buf_xsize=None, buf_ysize=None, buf_type=None,
buf_pixel_space=None, buf_line_space=None ):
"""
Write the contents of a buffer to a dataset.
"""
if buf_xsize is None:
buf_xsize = xsize
if buf_ysize is None:
buf_ysize = ysize
# Redirect to numpy-friendly WriteArray() if buf_string is a numpy array
# and other arguments are compatible
if type(buf_string).__name__ == 'ndarray' and \
buf_xsize == xsize and buf_ysize == ysize and buf_type is None and \
buf_pixel_space is None and buf_line_space is None:
return self.WriteArray(buf_string, xoff=xoff, yoff=yoff)
if buf_type is None:
buf_type = self.DataType
return _gdal.Band_WriteRaster(self,
xoff, yoff, xsize, ysize,
buf_string, buf_xsize, buf_ysize, buf_type,
buf_pixel_space, buf_line_space )
def ReadAsArray(self, xoff=0, yoff=0, win_xsize=None, win_ysize=None,
buf_xsize=None, buf_ysize=None, buf_type=None, buf_obj=None,
resample_alg=gdalconst.GRIORA_NearestNeighbour,
callback=None,
callback_data=None):
"""
Read a window of this raster band into a NumPy array.
Parameters
----------
xoff : float, default=0
The pixel offset to left side of the region of the band to
be read. This would be zero to start from the left side.
yoff : float, default=0
The line offset to top side of the region of the band to
be read. This would be zero to start from the top side.
win_xsize : float, optional
The number of pixels to read in the x direction. By default,
equal to the number of columns in the raster.
win_ysize : float, optional
The number of rows to read in the y direction. By default,
equal to the number of bands in the raster.
buf_xsize : int, optional
The number of columns in the returned array. If not equal
to ``win_xsize``, the returned values will be determined
by ``resample_alg``.
buf_ysize : int, optional
The number of rows in the returned array. If not equal
to ``win_ysize``, the returned values will be determined
by ``resample_alg``.
buf_type : int, optional
The data type of the returned array
buf_obj : np.ndarray, optional
Optional buffer into which values will be read. If ``buf_obj``
is specified, then ``buf_xsize``/``buf_ysize``/``buf_type``
should generally not be specified.
resample_alg : int, default = :py:const:`gdal.GRIORA_NearestNeighbour`.
Specifies the resampling algorithm to use when the size of
the read window and the buffer are not equal.
callback : function, optional
A progress callback function
callback_data: optional
Optional data to be passed to callback function
Returns
-------
np.ndarray
Examples
--------
>>> import numpy as np
>>> ds = gdal.GetDriverByName("GTiff").Create("test.tif", 4, 4, eType=gdal.GDT_Float32)
>>> ds.WriteArray(np.arange(16).reshape(4, 4))
0
>>> band = ds.GetRasterBand(1)
>>> # Reading an entire band
>>> band.ReadAsArray()
array([[ 0., 1., 2., 3.],
[ 4., 5., 6., 7.],
[ 8., 9., 10., 11.],
[12., 13., 14., 15.]], dtype=float32)
>>> # Reading a window of a band
>>> band.ReadAsArray(xoff=2, yoff=2, win_xsize=2, win_ysize=2)
array([[10., 11.],
[14., 15.]], dtype=float32)
>>> # Reading a band into a new buffer at higher resolution
>>> band.ReadAsArray(xoff=0.5, yoff=0.5, win_xsize=2.5, win_ysize=2.5, buf_xsize=5, buf_ysize=5)
array([[ 0., 1., 1., 2., 2.],
[ 4., 5., 5., 6., 6.],
[ 4., 5., 5., 6., 6.],
[ 8., 9., 9., 10., 10.],
[ 8., 9., 9., 10., 10.]], dtype=float32)
>>> # Reading a band into an existing buffer at lower resolution
>>> band.ReadAsArray(buf_xsize=2, buf_ysize=2, buf_type=gdal.GDT_Float64, resample_alg=gdal.GRIORA_Average)
array([[ 2.5, 4.5],
[10.5, 12.5]])
>>> buf = np.zeros((2,2))
>>> band.ReadAsArray(buf_obj=buf)
array([[ 5., 7.],
[13., 15.]])
"""
from osgeo import gdal_array
return gdal_array.BandReadAsArray(self, xoff, yoff,
win_xsize, win_ysize,
buf_xsize, buf_ysize, buf_type, buf_obj,
resample_alg=resample_alg,
callback=callback,
callback_data=callback_data)
def WriteArray(self, array, xoff=0, yoff=0,
resample_alg=gdalconst.GRIORA_NearestNeighbour,
callback=None,
callback_data=None):
"""
Write the contents of a NumPy array to a Band.
Parameters
----------
array : np.ndarray
Two-dimensional array containing values to write
xoff : int, default=0
The pixel offset to left side of the region of the band to
be written. This would be zero to start from the left side.
yoff : int, default=0
The line offset to top side of the region of the band to
be written. This would be zero to start from the top side.
resample_alg : int, default = :py:const:`gdal.GRIORA_NearestNeighbour`
Resampling algorithm. Placeholder argument, not currently supported.
callback : function, optional
A progress callback function
callback_data: optional
Optional data to be passed to callback function
Returns
-------
int:
Error code, or ``gdal.CE_None`` if no error occurred.
"""
from osgeo import gdal_array
return gdal_array.BandWriteArray(self, array, xoff, yoff,
resample_alg=resample_alg,
callback=callback,
callback_data=callback_data)
def GetVirtualMemArray(self, eAccess=gdalconst.GF_Read, xoff=0, yoff=0,
xsize=None, ysize=None, bufxsize=None, bufysize=None,
datatype=None,
cache_size = 10 * 1024 * 1024, page_size_hint = 0,
options=None):
"""Return a NumPy array for the band, seen as a virtual memory mapping.
An element is accessed with array[y][x].
Any reference to the array must be dropped before the last reference to the
related dataset is also dropped.
"""
from osgeo import gdal_array
if xsize is None:
xsize = self.XSize
if ysize is None:
ysize = self.YSize
if bufxsize is None:
bufxsize = self.XSize
if bufysize is None:
bufysize = self.YSize
if datatype is None:
datatype = self.DataType
if options is None:
virtualmem = self.GetVirtualMem(eAccess, xoff, yoff, xsize, ysize, bufxsize, bufysize, datatype, cache_size, page_size_hint)
else:
virtualmem = self.GetVirtualMem(eAccess, xoff, yoff, xsize, ysize, bufxsize, bufysize, datatype, cache_size, page_size_hint, options)
return gdal_array.VirtualMemGetArray(virtualmem)
def GetVirtualMemAutoArray(self, eAccess=gdalconst.GF_Read, options=None):
"""Return a NumPy array for the band, seen as a virtual memory mapping.
An element is accessed with array[y][x].
Any reference to the array must be dropped before the last reference to the
related dataset is also dropped.
"""
from osgeo import gdal_array
if options is None:
virtualmem = self.GetVirtualMemAuto(eAccess)
else:
virtualmem = self.GetVirtualMemAuto(eAccess, options)
return gdal_array.VirtualMemGetArray( virtualmem )
def GetTiledVirtualMemArray(self, eAccess=gdalconst.GF_Read, xoff=0, yoff=0,
xsize=None, ysize=None, tilexsize=256, tileysize=256,
datatype=None,
cache_size = 10 * 1024 * 1024, options=None):
"""Return a NumPy array for the band, seen as a virtual memory mapping with
a tile organization.
An element is accessed with array[tiley][tilex][y][x].
Any reference to the array must be dropped before the last reference to the
related dataset is also dropped.
"""
from osgeo import gdal_array
if xsize is None:
xsize = self.XSize
if ysize is None:
ysize = self.YSize
if datatype is None:
datatype = self.DataType
if options is None:
virtualmem = self.GetTiledVirtualMem(eAccess, xoff, yoff, xsize, ysize, tilexsize, tileysize, datatype, cache_size)
else:
virtualmem = self.GetTiledVirtualMem(eAccess, xoff, yoff, xsize, ysize, tilexsize, tileysize, datatype, cache_size, options)
return gdal_array.VirtualMemGetArray( virtualmem )
%}
%feature("pythonappend") GetMaskBand %{
if hasattr(self, '_parent_ds') and self._parent_ds():
self._parent_ds()._add_band_ref(val)
%}
%feature("pythonappend") GetOverview %{
if hasattr(self, '_parent_ds') and self._parent_ds():
self._parent_ds()._add_band_ref(val)
%}
%feature("shadow") ComputeStatistics %{
def ComputeStatistics(self, *args, **kwargs) -> "CPLErr":
"""ComputeStatistics(Band self, bool approx_ok, callback=None, callback_data=None) -> CPLErr
Compute image statistics.
See :cpp:func:`GDALRasterBand::ComputeStatistics`.
Parameters
----------
approx_ok : bool
If ``True``, compute statistics based on overviews or a
subset of tiles.
callback : function, optional
A progress callback function
callback_data: optional
Optional data to be passed to callback function
Returns
-------
list
a list with the min, max, mean, and standard deviation of values
in the Band.
See Also
--------
:py:meth:`ComputeBandStats`
:py:meth:`ComputeRasterMinMax`
:py:meth:`GetMaximum`
:py:meth:`GetMinimum`
:py:meth:`GetStatistics`
:py:meth:`SetStatistics`
"""
if len(args) == 1:
kwargs["approx_ok"] = args[0]
args = ()
if "approx_ok" in kwargs:
# Compatibility with older signature that used int for approx_ok
if kwargs["approx_ok"] == 0:
kwargs["approx_ok"] = False
elif kwargs["approx_ok"] == 1:
kwargs["approx_ok"] = True
elif isinstance(kwargs["approx_ok"], int):
raise Exception("approx_ok value should be 0/1/False/True")
return $action(self, *args, **kwargs)
%}
%feature("shadow") GetNoDataValue %{
def GetNoDataValue(self):
"""GetNoDataValue(Band self) -> value
Fetch the nodata value for this band.
Unlike :cpp:func:`GDALRasterBand::GetNoDataValue`, this
method handles 64-bit integer data types.
Returns
-------
float/int
The nodata value, or ``None`` if it has not been set.
"""
if self.DataType == gdalconst.GDT_Int64:
return _gdal.Band_GetNoDataValueAsInt64(self)
if self.DataType == gdalconst.GDT_UInt64:
return _gdal.Band_GetNoDataValueAsUInt64(self)
return $action(self)
%}
%feature("shadow") SetNoDataValue %{
def SetNoDataValue(self, value) -> "CPLErr":
"""SetNoDataValue(Band self, value) -> CPLErr
Set the nodata value for this band.
Unlike :cpp:func:`GDALRasterBand::SetNoDataValue`, this
method handles 64-bit integer types.
Parameters
----------
value : float/int
The nodata value to set
Returns
-------
int:
:py:const:`CE_None` on success or :py:const:`CE_Failure` on failure.
"""
if self.DataType == gdalconst.GDT_Int64:
return _gdal.Band_SetNoDataValueAsInt64(self, value)
if self.DataType == gdalconst.GDT_UInt64:
return _gdal.Band_SetNoDataValueAsUInt64(self, value)
return $action(self, value)
%}
%feature("shadow") ComputeRasterMinMax %{
def ComputeRasterMinMax(self, *args, **kwargs):
"""ComputeRasterMinMax(Band self, bool approx_ok=False, bool can_return_none=False) -> (min, max) or None
Computes the minimum and maximum values for this Band.
See :cpp:func:`GDALComputeRasterMinMax`.
Parameters
----------
approx_ok : bool, default=False
If ``False``, read all pixels in the band. If ``True``, check
:py:meth:`GetMinimum`/:py:meth:`GetMaximum` or read a subsample.
can_return_none : bool, default=False
If ``True``, return ``None`` on error. Otherwise, return a tuple
with NaN values.
Returns
-------
tuple
See Also
--------
:py:meth:`ComputeBandStats`
:py:meth:`ComputeStatistics`
:py:meth:`GetMaximum`
:py:meth:`GetMinimum`
:py:meth:`GetStatistics`
:py:meth:`SetStatistics`
"""
if len(args) == 1:
kwargs["approx_ok"] = args[0]
args = ()
if "approx_ok" in kwargs:
# Compatibility with older signature that used int for approx_ok
if kwargs["approx_ok"] == 0:
kwargs["approx_ok"] = False
elif kwargs["approx_ok"] == 1:
kwargs["approx_ok"] = True
elif isinstance(kwargs["approx_ok"], int):
raise Exception("approx_ok value should be 0/1/False/True")
# can_return_null is used in other methods
if "can_return_null" in kwargs:
kwargs["can_return_none"] = kwargs["can_return_null"];
del kwargs["can_return_null"]
return $action(self, *args, **kwargs)
%}
}
%extend GDALDatasetShadow {
%feature("kwargs") ReadRaster1;
%apply ( void *inPythonObject ) { (void* inputOutputBuf) };
%apply ( GDALDataType *optional_GDALDataType ) {(GDALDataType*)};
%apply (int nList, int *pList ) { (int band_list, int *pband_list ) };
%apply ( void **outPythonObject ) { (void **buf ) };
%apply ( int *optional_int ) {(int*)};
%apply ( GIntBig *optional_GIntBig ) {(GIntBig*)};
CPLErr ReadRaster1( double xoff, double yoff, double xsize, double ysize,
void **buf,
int *buf_xsize = 0, int *buf_ysize = 0,
GDALDataType *buf_type = 0,
int band_list = 0, int *pband_list = 0,
GIntBig* buf_pixel_space = 0, GIntBig* buf_line_space = 0, GIntBig* buf_band_space = 0,
GDALRIOResampleAlg resample_alg = GRIORA_NearestNeighbour,
GDALProgressFunc callback = NULL,
void* callback_data=NULL,
void* inputOutputBuf = NULL )
{
*buf = NULL;
int nxsize = (buf_xsize==0) ? static_cast<int>(xsize) : *buf_xsize;
int nysize = (buf_ysize==0) ? static_cast<int>(ysize) : *buf_ysize;
GDALDataType ntype;
if ( buf_type != 0 ) {
ntype = *buf_type;
} else {
int lastband = GDALGetRasterCount( self ) - 1;
if (lastband < 0)
{
return CE_Failure;
}
ntype = GDALGetRasterDataType( GDALGetRasterBand( self, lastband ) );
}
GIntBig pixel_space = (buf_pixel_space == 0) ? 0 : *buf_pixel_space;
GIntBig line_space = (buf_line_space == 0) ? 0 : *buf_line_space;
GIntBig band_space = (buf_band_space == 0) ? 0 : *buf_band_space;
int ntypesize = GDALGetDataTypeSize( ntype ) / 8;
size_t buf_size = static_cast<size_t>(
ComputeDatasetRasterIOSize (nxsize, nysize, ntypesize,
band_list ? band_list :
GDALGetRasterCount(self),
pband_list, band_list,
pixel_space, line_space, band_space,
FALSE));
if (buf_size == 0)
{
return CE_Failure;
}
char *data;
Py_buffer view;
if( !readraster_acquirebuffer(buf, inputOutputBuf, buf_size, ntype,
GetUseExceptions(), data, view) )
{
return CE_Failure;
}
if( inputOutputBuf == NULL )
{
/* Should we clear the buffer in case there are hole in it ? */
if( line_space != 0 && pixel_space != 0 && line_space > pixel_space * nxsize )
{
memset(data, 0, buf_size);
}
else if( band_list > 1 && band_space != 0 )
{
if( line_space != 0 && band_space > line_space * nysize )
memset(data, 0, buf_size);
else if( pixel_space != 0 && band_space < pixel_space &&
pixel_space != (GIntBig)GDALGetRasterCount(self) * ntypesize )
memset(data, 0, buf_size);
}
}
GDALRasterIOExtraArg sExtraArg;
INIT_RASTERIO_EXTRA_ARG(sExtraArg);
sExtraArg.eResampleAlg = resample_alg;
sExtraArg.pfnProgress = callback;
sExtraArg.pProgressData = callback_data;
int nXOff = (int)(xoff + 0.5);
int nYOff = (int)(yoff + 0.5);
int nXSize = (int)(xsize + 0.5);
int nYSize = (int)(ysize + 0.5);
if( fabs(xoff-nXOff) > 1e-8 || fabs(yoff-nYOff) > 1e-8 ||
fabs(xsize-nXSize) > 1e-8 || fabs(ysize-nYSize) > 1e-8 )
{
sExtraArg.bFloatingPointWindowValidity = TRUE;
sExtraArg.dfXOff = xoff;