forked from rasterio/rasterio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGES.txt
1558 lines (1273 loc) · 61.9 KB
/
CHANGES.txt
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
Changes
=======
1.1.3 (2020-02-24)
------------------
Bug fixes:
- Raise RasterioIOError when errors occur while creating a dataset (#1796).
- Filter more categories of invalid features in rasterize (#1815).
- Fall back to use of a DummySession instead of failing when boto3 isn't
available (#1864).
- A crashing bug involving boundless reads of VRTs (#1863) has been fixed.
- The required transform argument of windows.from_bounds() was changed from a
positional arg to a keyword arg in commit 361112e but no guard against the
default value of None was added (#1857). The function now raises WindowError
if no transform is given.
- dataset_mask returned in some cases an array with dtype "int64" (#1856). This
bug was introduced in 1.1.2 and has been fixed.
1.1.2 (2019-12-18)
------------------
Bug fixes:
- Sampling of WarpedVRT datasets was broken in version in 1.1.1 (#1833) and has
been fixed.
- The missing out_dtype keyword argument has been added to
WarpedVRTReaderBase.read() (#1849).
- The missing --format option has been added to rio-calc (#1846).
- Reduce all the band masks when computing the dataset mask. Previously we had
missed the last band.
- PR #1842 makes sure that rio-calc's cleanup doesn't fail due to unbound
variables.
- The conflict between the --bbox/--feature/--collection and
--sequence/--collection option of rio-bounds (#1807) has been fixed by
removing "collection" from the possible JSON type options.
- Increase default precision for the merge tool from 7 to 10 (#1837).
- Allow rio-clip and rio-convert to overwrite output files (#1836).
- Allow src_crs parameter to fully override the source dataset's CRS (#1808).
Packaging notes:
- The wheels on PyPI now include the base (version 1.8) PROJ datum grids and
are thus a few MB larger in size.
1.1.1 (2019-11-13)
------------------
Bug fixes:
- Calling a dataset's sample method with coordinates outside the extent of a
dataset with a nodata value of None has raised a TypeError (#1822). Now, it
gives the values we would get from a boundless read of the dataset's values.
- Use new set_proj_search_path() function to set the PROJ data search path. For
GDAL versions before 3.0 this sets the PROJ_LIB environment variable. For
GDAL version 3.0 this calls OSRSetPROJSearchPaths(), which overrides
PROJ_LIB (#1823).
- Check for header.dxf file instead of pcs.csv when looking for installed GDAL
data. The latter is gone with GDAL 3.0 but the former remains (#1823).
- RGB rasters are now properly displayed by rasterio.plot.show (#1650).
Notes:
- The wheels on PyPI include GDAL 2.4.3 with a patch that addresses the
multithreading issue reported in #1828.
1.1.0 (2019-10-07)
------------------
There have been no changes since 1.1b3.
1.1b3 (2019-10-03)
------------------
Bug fixes:
- A regression in WarpedVRT creation (#1799) has been fixed. This required
implementation of GDALDatasetH reference counting in DatasetBase.stop().
1.1b2 (2019-10-02)
------------------
Bug fixes:
- When built from the official source distribution rasterio 1.1b1 would not
import due to the omission of _transform.c from the list of extension sources
in setup.py. This has been fixed.
1.1b1 (2019-10-01)
------------------
Deprecations:
- Support for Python 2 is deprecated and a warning is raised from the
rasterio.compat module. This module will be deleted in a future version.
New features:
- Added a new ``tag_namespaces()`` method datasets that returns names of
metadata namespaces that can be passed to the existing ``tags()`` method
(#1740).
- Zoom levels can be automatically computed by rio-overview (#511).
- An alternative endpoint for S3-compatible network storage can now be set when
creating an instance of AWSSession (#1779). See GDAL's documentation of its
AWS_S3_ENDPOINT configuration option for more details.
- The merge tool has a new ``method`` keyword argument that can be used to
override the default painter's algorithm. It takes an alternative method name
as a string or a callable. Please see the merge tool docstring for the
callable's signature (#1500).
- A new ``rasterio.transform.from_gcps()`` function returns the Affine matrix
that is a best fit to given ground control points (#1749).
Bug fixes:
- Handle the AWS extension mentioned in #1159. Note that this does not enable
writing directly to S3.
- A syntax error in the specification of a Python version marker for enum34 in
requirements.txt has been fixed.
- Several cases of memory leaks involving temporary in-memory datasets have
been fixed. The rasterio test suite now runs without leaving any datasets
open.
- The default mode for dataset sharing has been switch from ``sharing=True`` to
``sharing=False`` to better serve development of multithreaded applications
(#1775).
- Tests of rasterizing invalid shapes now catch the warnings about shape
skipping.
Other:
- The AUTHORS file has been updated and is now sorted by name (first name
first) or GitHub username.
1.0.28 (2019-09-09)
-------------------
- Coercion to ``int`` was forgotten in the block size guard introduced in
1.0.27 and code that passes string valued ``blockxsize`` and ``blockysize``
keyword arguments to ``rasterio.open()`` was broken (#1769). This has been
fixed in 1.0.28.
1.0.27 (2019-09-05)
-------------------
- Resolve #1744 by adding a ``dtype`` keyword argument to the WarpedVRT
constructor. It allows a user to specify the working data type for the warp
operation and output.
- All cases of deprecated affine right multiplication have been changed to be
forward compatible with affine 3.0. The rasterio tests now pass without
warnings.
- The coordinate transformer used in _base._transform() is now properly
deleted, fixing the memory leak reported in #1713.
- An unavoidable warning about 4-channel colormap entries in
DatasetWriterBase.write_colormap() has been removed.
- All deprecated imports of abstract base classes for collections have been
corrected, eliminating the warnings reported in #1742 and #1764.
- DatasetWriterBase no longer requires that GeoTIFF block sizes be smaller than
the raster size (#1760). Block sizes are however checked to ensure that they
are multiples of 16.
- DatasetBase.is_tiled has been made more reliable, fixing #1376.
- Tests have been added to demonstrate that image corruption when writing
block-wise to an image with extra large block sizes (#520) is no longer an
issue.
1.0.26 (2019-08-26)
-------------------
- Allow `nan` to be used as fill for float32 datasets in ``rasterize`` (#1761).
- A WarpedVRTs destination crs now will default to ``src_crs`` if given, else
to the crs of the source dataset (#1755).
- Prevent open's ``sharing`` keyword argument from being pass on to GDAL as a
dataset opening option for create-copy formats like JPEG and PNG (#1758).
- Allow complex datasets to be created with a specified nodata value (#1747).
- Several Python deprecation warnings have been eliminated (#1742).
- When a MemoryFile is opened in write mode, a TypeError will be raised if
integer width and height are not given, fixing #1748.
- Return False when checking equality with objects incompatible with
``CRS.from_user_input()`` (#1719)
- Support CRS.from_user_input with other CRS object with ``to_wkt()`` method
(#1718)
1.0.25 (2019-08-06)
-------------------
- In ``features.rasterize()``, a shape with an associated value of ``None`` is
now burned in using the function's ``fill`` value and no longer triggers a
TypeError (#1738).
- Instances of pytest's tmp_path fixture in tests/test_dataset.py have been
replaced by instances of the older style tmpdir fixture (#1697).
- Add support for using GDAL 3.x and PROJ 6 libraries (#1700, #1729). Please
note that new features of GDAL 3 and PROJ 6 are not intended to surface.
Geometries and coordinates returned from rasterio keep to the traditional GIS
axis order used by GDAL versions < 3. To do this, rasterio applies a new
private extension function named osr_set_traditional_axis_mapping_strategy to
every OGRSpatialReferenceH object that will be returned from methods in the
_CRS module. Please also note that the binary wheels uploaded to PyPI for
1.0.25 will include GDAL 2.4, *not* GDAL 3.0.
- We were using pytest incorrectly and pytest 5 caught us doing it. This is
now fixed in commit b9f34ee.
- A bug preventing creation of Env instances, and thus dataset opening, when
AWS credentials exist in the environment but boto3 is unavailable has been
fixed (#1708).
1.0.24 (2019-06-05)
-------------------
- By default GDAL reuses existing dataset connections when possible.
Multi-threaded programs must avoid this as must programs that re-open
datasets in a different context, such as the overview-seeking program shown
in issue #1504. The sharing keyword argument of rasterio.open() was supposed
to allow users to disable connection reuse on a case-by-case basis, but the
implementation was faulty and connection reuse persisted (#1701). This has
been fixed in PR #1704.
1.0.23 (2019-05-15)
-------------------
- Break rio-calc output into chunks of user-specified size to constrain the
amount of memory used (#1668).
- Attempts to set attributes of datasets opened in "r" mode now raise a custom
DatasetAttributeError. This exception derives from both RasterioError and
NotImplementedError, which maintains backwards compatibility (#1676).
- Block sizes are no longer guarded when creating untiled datasets (#1689).
- CRS objects are now hashable and equivalent CRS objects have the same hash
value (#1684).
- Allow AWS regions to be specified no matter the signing of requests (#1670).
- Add links to API documentation from the Python quickstart guide.
- Use "CRS.from_epsg({})" instead of "CRS.from_dict(init='epsg:{}')" as the
representation for CRS objects that are completely described by an EPSG code.
- Use GDAL's string parsing to get metadata item keys and values, which
accommodates uncommon "KEY:VALUE" forms.
1.0.22 (2019-03-20)
-------------------
- Add JPEG2000 to enums.Compression so that the compression of JP2 files can be
reported (#1654).
- Remove mock import from compat and move to test code (#1651).
1.0.21 (2019-02-28)
-------------------
- Fix for bug in implementation of the pickle protocol and added support for
Python's copy protocol (#1643).
1.0.20 (2019-02-27)
-------------------
- Fix for an unchecked NULL pointer introduced in 1.0.19 that could result in
segmentation fault on import of rasterio._env on Linux when GDAL data files
are not available (for example, with wheels as on PyPI).
1.0.19 (2019-02-26)
-------------------
- Do not set GDAL_DATA and PROJ_LIB when data files can be found at their built
in locations (#1631).
- Add linear_units property to CRS (#1638).
- Ensure that AWS_NO_SIGN_REQUESTS is sufficient for accessing public S3
datasets and that import of boto3 is not required (#1637).
- An out_dtype parameter has been added to DatasetReaderBase.read, enabling
on-the-fly casting of raster values to the desired type (#1637). This uses
the same latent feature used to get support for "int8" data.
- Restore pickle protocol for CRS, using WKT as state (#1625).
- Support for signed 8-bit integer datasets ("int8" dtype) has been added
(#1595).
1.0.18 (2019-02-07)
-------------------
- Fix a regression reported in #1623.
1.0.17 (2019-02-05)
-------------------
- Fix a regression in evaluation of CRS equality (#1620).
1.0.16 (2019-02-04)
-------------------
- A bug preventing GCPs from being created with new BufferedDatasetWriter
instances (#1600) has been fixed (#1610).
- A previously unreported bug preventing BufferedDatasetWriters from being
opened in r+ mode has been fixed.
- A regression in creating CRS objects from PROJ4 strings that include
"+wktext" (#1609) has been fixed.
- Regressions in str representations of empty CRS objects and the handling of
unreferenced datasets in rasterio._base have been fixed (#1616).
- GDAL seems to work best if GDAL_DATA is set as early as possible. Ideally it
is set when building the library or in the environment before importing
Rasterio, but for wheels we patch GDAL_DATA into os.environ when rasterio.env
is imported. This resolves #1611.
1.0.15 (2019-01-27)
-------------------
- Google cloud storage support was *not* in fact added in 1.0.14, but is
present in 1.0.15.
1.0.14 (2019-01-22)
-------------------
- The _CRS class has been refactored so that a WKT representation, rather than
PROJ4 representation, is the canonical form. This resolves issues #1397 and
#1587 specifically, and an entire category of issues discussed in
https://rasterio.groups.io/g/dev/message/68.
- Native support for Google Cloud Storage using "gs://" URLs has been added
(#1577).
- On entering a dataset context (DatasetBase.__enter__) a new anonymous GDAL
environment is created if needed and is entered. This makes `with
rasterio.open(...) as dataset:` roughly equivalent to `with
rasterio.open(...) as dataset, Env():`. This helps prevent bugs when datasets
are created and then used later or are used in different scopes.
1.0.13 (2018-12-14)
-------------------
- Fix a buffer dttype mismatch on Windows introduced in 1.0.12 (#1579).
1.0.12 (2018-12-10)
-------------------
- Rasterio's lower level I/O functions now take Py_ssize_t index arrays and
will raise exceptions for type mismatches instead of swallowing the
exceptions (#1076).
- The _boundless_vrt_doc function's background layer no longer needs an
in-memory dataset and the performance regression noted in #1499 has been
reversed. We've also found a performance improvement in masked boundless
reads in the case that the source data is entirely valid.
- The signature of the private _boundless_vrt_doc function in rasterio.vrt has
changed. Its background keyword argument now takes an int or float, a new
masked keyword argument has been added, and the function returns a unicode
str instead of ascii-encoded bytes.
- The copy and copyfiles functions of rasterio.shutil now raise an exception
when the source and destination paths identify the same dataset (#1569).
1.0.11 (2018-11-30)
-------------------
- Prevent needless warning when making boundless reads with a fill value
(#1499).
- The GDAL band cache is flushed at the top of build_overviews to fix #1497.
- Options --gdal-data and --proj-data have been added to the rio-env command so
that users of Rasterio wheels can get paths to set GDAL_DATA and PROJ_LIB
environment variables.
- The attempt to make GDAL and PROJ support file discovery and configuration
automatic within methods of the CRS class has been reverted. Users must
execute such code inside a `with Env()` block or set the GDAL_DATA and
PROJ_LIB environment variables needed by GDAL.
1.0.10 (2018-11-16)
-------------------
- Avoid segmentation fault when OSRGetAuthority* functions return null
pointers, making Rasterio more robust when reading CRS that don't map
perfectly to PROJ.
- Ensure that GDAL and PROJ support files can be found in Rasterio wheels when
we call CRS methods (#1539).
- Accomodate the Esri flavor of projection WKT (#1537).
- Add missing raster offsets and scales properties (#1527).
1.0.9 (2018-10-25)
------------------
Bug fixes:
- Delegate test of the environment for existing session credentials to the
session class to generalize credentialization of GDAL to cloud providers
other than AWS (#1520). The env.hascreds function is no longer used in
Rasterio and has been marked as deprecated.
- Switch to use of botocore Credentials.get_frozen_credentials (#1521).
- Numpy masked arrays with the normal Numpy mask sense (True == invalid) are
now supported as input for feature.shapes(). The mask keyword argument of the
function keeps to the GDAL sense of masks (nonzero == invalid) and the
documentation has been improved to communicate this (#1517).
- The defaults for WarpedVRT's `src_nodata` and `nodata` keyword arguments are
no longer None, but are markers for the default behavior: inheritance of
nodata values from the VRT's source dataset. Values of `None` for these
keyword arguments means that the VRT does not inherit from the source and has
no nodata value at all (#1503).
- WEBP has been added to the Compression enum. Exploitation of this new
compression mode will require GDAL 2.4.
- Rasterio now check for two AWS environment variables before creating a
session (#1494).
- The ensure_env_with_credentials decorator which wraps rasterio.open will no
longer clobber the credentials in a surrounding environment or seek
credentials when they already exist (#1507).
- The comparison of CRS objects to dicts and strs that we pledged to remove at
1.0 has at last been removed (#1492).
1.0.8 (2018-10-02)
------------------
Bug fixes:
- Datasets contained in MemoryFile buffers are now opened in r+ or w+ mode
instead of r or w.
- The namedtuple _asdict method is overridden in BoundingBox to work around a
bug in Python 3.4.3 (#1486, #1488). This unblocks creation of manylinux1
wheels for Python 3.4.
1.0.7 (2018-09-26)
------------------
Bug fixes:
- Use the non-resolving path form of files_inout_arg in rio-convert and
rio-shapes (#999).
- Filling the empty regions of boundless reads was too slow in some cases and
a faster solution has been found (#1480).
- Require cligj>=0.5 for compatibility with click 7.0.
- Precisely specify CLI option and argument names for click 6.x and 7.0
compatibility.
1.0.6 (2018-09-24)
------------------
Bug fixes:
- If the build_overviews method of a dataset is passed a list of factors that
specify more than one 1x1 pixel overview (#1333), Rasterio raises an
exception.
- Calling calculate_default_transform for large extents should no longer result
in the out of memory error reported in #1131. The rio-warp command should
also now run more quickly and with a smaller memory footprint.
- We have a more general fix for the problem of filling the empty regions of
boundless reads (#1471).
1.0.5 (2018-09-19)
------------------
Bug fixes:
- The fill value for boundless reads was ignored in Rasterio versions 1-1.0.4
but now applies (#1471).
- An invalid shortcut has been eliminated and Rasterio now produces a proper
mask in the boundless masked read case (#1449).
- Loss of a row or column in geometry_window() and mask() has been fixed
(#1472).
1.0.4 (2018-09-17)
------------------
Bug fixes:
- Boundless reads of datasets without a coordinate reference system have been
fixed (#1448).
- A y-directional error in disjoint_bounds (#1459) has been fixed.
- Prevent geometries from being thrown near projection singularities (#1446).
- Missing --aws-no-sign-requests and --aws-requester-pays options added to
the main rio command (#1460).
- Add missing bilinear, cubic spline, lanczos resampling modes for overviews
(#1457).
- Raise ValueError if get_writer_for_driver() is called without a driver
name.
- Windows are now frozen so that they are hashable (#1452).
Refactoring:
- Use of InMemoryRaster eliminates redundant code in the _warp module (#1427,
#816).
- Generalize sessions to support cloud providers other than AWS (#1429).
1.0.3.post1 (2018-09-07)
------------------------
This version corrects errors made in building binary wheels for 1.0.3. There
are no bug fixes or new features in this version.
1.0.3 (2018-08-01)
Bug fixes:
- A regression in GeoJSON source handling in rio-rasterize (#1425) has been
fixed.
- Rasterization of linear rings (#1431) is now supported.
- The input file handler of rio-rasterize has been changed so that it does not
reject GeoJSON files (#1425).
- Linear rings have been added as acceptable input for rio-rasterize and other
commands and functions (#1431).
1.0.2 (2018-07-27)
------------------
Bug fixes:
- The output of calculate_default_transform() can be fixed to output dimensions
as well as to output resolution (#1409).
- In using rio-warp, the --src-bounds option can now override the bounds of the
source dataset when --dimensions is used (#1419).
- Bounds of rotated rasters are now calculated correctly (#1422).
- A band indexing bug in reproject() (#1350) has been fixed (#1424).
1.0.1 (2018-07-23)
------------------
Bug fixes:
- Bounding envelopes are densified at higher precision in transform_bounds to
fix #1411.
- Add LERC compression to enums.Compression (#1412).
- The reproject() function now passes dst_alpha properly to _reproject(), which
unlocks materialization of warp destination alpha band masks (#1417).
- The --dimensions and --src-bounds options of rio-warp can be used together
as expected (#1418).
1.0.0 (2018-07-12)
------------------
There have been no changes since release candidate 5.
1.0rc5 (2018-07-09)
-------------------
- C source files are now generated using Cython 0.28.3, which gives us support
for Python 3.7 (#1404, #1405).
1.0rc4 (2018-07-05)
-------------------
- An integer overflow when multiplying the warp memory limit (#1401) has been
fixed.
1.0rc3 (2018-07-03)
-------------------
- CRS based EPSG codes can now report that code using a new `to_epsg()` method
(#1288).
- A regression in rasterio.warp.reproject has been reported (#1395), confirmed,
and fixed.
1.0rc2 (2018-06-29)
-------------------
Deprecation:
- The rasterio.vfs module has been removed.
- Reading array data or masks from datasets opened in "w" mode is prohibited.
- Property set_* methods of datasets have been removed. The appropriate
properties should be used instead. For example, ``dataset.crs = "EPSG:4326"``
instead of ``dataset.set_crs("EPSG:4326")``.
- Rasterio ignores creation options saved in the metadata of datasets
by Rasterio versions < 1.0b1.
1.0rc1 (2018-06-27)
-------------------
Bug fixes:
- Internal Env() in `rasterio.open` has been replaced with an environment
ensuring decorator (#1009). The same decorator ensures that credentials are
obtained when functions from `rasterio.shutils` are called.
- Input file arguments for all CLI commands are now parsed and validated in
a uniform manner (#999).
- Local loggers have all been changed to `getLogger(__name__)` in rasterio.rio
module (#1328).
1.0b4 (2018-06-23)
------------------
Bug fixes:
- We now raise an exception when WarpedVRT is asked to add an alpha band and
one already exists for the VRT.
1.0b3 (2018-06-21)
------------------
Bug fixes:
- The warp memory limit configuration available in gdalwarp has been added
to `reproject()` and `WarpedVRT`.
- Avoid boundless reads when sampling pixels outside a dataset's extent
(#1249).
- The logic behind rio-warp's --target-aligned-pixels has been factored into
a new `aligned_target()` function in the warp module to help resolve
#853.
- A regression in the VSI path of some zip:// URLs has been fixed (#1377).
- Transform, coordinate reference system, and ground control points are
properly set when opening a dataset in w+ mode (#1359.
1.0b2 (2018-06-19)
------------------
Breaking changes:
- `boundless=True` reads from warped VRTs are disallowed. Instead, VRTs should
be constructed so that only data bounded by their extents is read. In
exchange, boundless reads for non-VRT datasets are faster and more robust.
Upcoming deprecations:
- Comparison of CRS objects to str or dict is deprecated.
New features:
- Added `out`, `out_shape`, `window`, `resampling` keyword parameters to
the `dataset_mask` method (#1298).
- CRS.from_string can now take WKT strings as input.
Bug fixes:
- Tests have been added to confirm that reading from a WarpedVRT will use the
source dataset's masks and overviews.
- Expectations of warp tests that use resampling algorithms other than nearest
neighbor have been corrected.
- WarpedVRT.crs now returns a CRS, not a str.
- A Windows-crashing bug in the _warp module has been fixed (#1356).
1.0b1 (2018-05-25)
------------------
Breaking changes:
- The signatures of all Dataset constructors have changed: these method now
take instance of ParsedPath or UnparsedPath from rasterio.path and do not
take strings.
- The signatures of get_writer_for_path and get_writer_for_driver have
changed in the same way.
- Whether to print GeoJSON feature sequences or a GeoJSON feature collection
from rio-shapes is now controlled by a ``--sequence/--collection`` option.
A sequence is now the default (#927).
- Comparing empty ``CRS`` objects returns ``True`` (#1034).
- Deprecated window functions have been removed from the rasterio module. Their
replacements are in rasterio.windows (#1115).
- The deprecated r- mode has been removed from ``rasterio.open()`` (#1116).
- A bytearray is no longer allowed as input to the ``MemoryFile`` constructor.
Users must convert byte arrays to ``bytes before calling ``MemoryFile()``.
- Signatures of private functions and classes in _features, _warp, _io have
been changed to always take instances of Affine instead of GDAL geotransform
arrays (#796).
- Calling `rasterio.Env()` no longer sets hidden default config options
CHECK_WITH_INVERT_PROJ=True and GTIFF_IMPLICIT_JPEG_OVR=False (#1011).
- Rasterio no longer saves creation options in metadata on created datasets
(#1332).
A number of deprecated features have been removed (#1319).
- In the rasterio.open function: we have removed 'affine' as an alias for
'transform'.
- In the _base.DatasetBase class, and thereby all dataset objects: we have
removed the mask_flags and affine properties. Instead, users must use the
mask_flag_enums and transform properties.
- In the _io.DatasetReaderBase class, and thereby all dataset objects: we have
removed the read_mask method. Users must use the read_masks method.
- In the features.rasterize function: we have removed 'replace' and 'add' as
aliases for ``MergeAlg.replace`` and ``MergeAlg.add``.
- In the profiles.Profile class: we have removed 'affine' as alias for
'transform' and have removed the `__call__` method. The class is no longer
callable. Users must use the mapping protocol to copy and update profiles.
- In the windows.WindowMethodsMixin class, and thereby all dataset objects: we
have removed the 'boundless' keyword arg from the window and from_bounds
methods.
- In the windows.Window class: we have removed the num_cols and num_rows
properties, the __getitem__ method, and the from_offlen and from_ranges class
methods.
Upcoming deprecation:
- The rasterio.vfs module and its functions are being replaced by new functions
in rasterio.path.
- Reading array data or masks from datasets opened in "w" mode will be
prohibited in Rasterio 1.0. We are warning about this now (#1309).
- Property set_* methods of datasets will be deprecated in 1.0. The appropriate
properties should be used instead. For example,
``dataset.crs = "EPSG:4326"`` instead of ``dataset.set_crs("EPSG:4326")``.
- Rasterio 1.0 will ignore creation options saved in the metadata of datasets
by Rasterio versions < 1.0b1. Users can opt in to this behavior now by
setting RIO_IGNORE_CREATION_KWDS=TRUE in their environments.
New features:
- New ParsedPath and UnparsedPath classes have been added to improve input
file handling and validation. The existing parse_path and vsi_path functions
have been rewritten to use these new classes and have been moved to the new
rasterio.path module. The signature of rasterio.open has not been changed
and users of Rasterio will be unaffected.
- set_band_unit and set_band_description methods have been added to
dataset writers/updaters to support rio-edit-info (#1344).
- A tools module has been added to collect file-based functions and supporting
classes (#1300).
- ``rasterio.features.dataset_features()`` has been extracted from
rio-shapes (#1282, #1286).
Bug fixes:
- The block_shapes and files properties of datasets now return lists instead
of tuples.
- The ``--nodata`` option of rio-merge is now passed to the output file
(#1345).
- The precision keyword arguments for methods in the windows and transform
modules now default to None, which means no rounding of values by
default (#1139).
- The pixel_precision keyword arguments for methods in the windows module now
default to None (#1143).
- Rasterio functions and methods, even the private ones, now always take
instances of Affine as transform parameters (#796).
- Importing the features, fill, io, and warp modules would set the
CHECK_WITH_INVERT_PROJ=True and GTIFF_IMPLICIT_JPEG_OVR=False config options
in a hidden way. This has been fixed in #1340.
- Add Debian data directory to set of well-known paths to search (#1337).
- Pass precision parameter from ``merge`` to ``from_bounds`` (#1307).
- Added the missing w+ mode (#1309).
- Rotated datasets are now masked properly (#1240, #1278).
- Geometry collections are flattened in ``rasterize`` to work around
incidental holes created by GDAL (#1253, #1274).
- Add missing support for Python geo protocol in features module (#1268,
(#1269).
- ``mask()`` now takes the ``indexes`` keyword parameter that is common
elsewhere in the package (#1224, #1225).
- Sharing of dataset handles may be disabled for multithreaded applications
using the new `sharing` keyword argument of `rasterio.open` (#1260).
- ``WarpedVRT()`` properly sets a CRS on the internal VRT handle when
that VRT is produced by ``GDALCreateVRT()`` (#1283).
1.0a12 (2017-12-01)
-------------------
New features:
- ``rasterio.open()`` now accepts URLs with GET parameters (#1121).
- Specific drivers and options can be used in ``rasterio.open()`` (#1000,
#1158, #1196).
- ``rasterize()`` now supports GDAL's 'add' algorithm (#1195).
- GDAL version checking has been consolidated and improved (#1210).
Bug fixes:
- Pad boundless read VRTs so we don't overflow due to rounding (#1184).
- Boundless reads of WarpedVRTs are enabled by setting an effective crs
(#1188).
- Raise ValueError when invalid width/height are passed to the
``InMemoryRaster`` constructor (#1144, #1194).
- GDAL errors that are turned into Rasterio exceptions are no longer also sent
automatically to the logger. They may, of course, be logged by user code.
- Raster width and height were swapped in ``geometry_window()`` (#1200).
1.0a11 (2017-10-30)
-------------------
Breaking changes:
- ``rasterio.copy()`` moved to ``rasterio.shutil.copy() (#1173).
- ``DatasetBase.colorinterp`` is now a setter/getter that operates on
a sequence of ``ColorInterp.<enum>`` in band order (#1134).
New features:
- Addition of ``rasterio.shutil.delete()`` and ``$ rio rm`` for deleting
datasets (#929).
- Addition of ``rasterio.shutil.exists()`` for determining if a dataset
exists (#1173).
- Addition of ``rasterio.shutil.copyfiles()`` to copy files associated
with a datset from one location to another (#1173).
- Allow setting band color interpretation in a ``set_colorinterp()`` method
and in ``$ rio edit-info --colorinterp`` (#1133).
Bug fixes:
- Reprojection of numpy arrays using GCPs has never worked due to faulty code,
but has been fixed (#1166, #1171).
- A circular import situation has been resolved by moving dataset mixin classes
from ``rasterio.io`` to ``rasterio.windows`` and ``rasterio.transform``
(#1174, #1173).
- Prevent a segmentation fault in ``rasterio.features.rasterize()`` by guarding
against unsupported GeoJSON input (#1172, #1176).
1.0a10 (2017-10-09)
-------------------
Breaking changes:
- In the GeoJSON output of rio-blocks, the windows are now JSON
representations of the ``Window`` class (#1074).
- The ``rasterio.windows.Window`` class no longer derives from ``tuple``.
Comparisons like ``Window(0, 0, 1, 1) == ((0, 1), (0, 1))`` are no
longer possible. Instead, call the ``.toranges()`` method of the
former or coerce the latter using ``Window.from_ranges`` (#1074).
- The ``rasterio.windows.from_bounds`` function now always returns unbounded,
meaning uncropped, Windows. For example, if given a bounding box entirely
to the west and north of the geotransform's origin, the result will be a
Window entirely to the left and above the dataset's row and column origin.
Passing a ``boundless`` keyword argument to this function will result in a
warning.
- The ``TransformMethodsMixin.ul`` method, deprecated since 0.36, has been
removed (#1100).
New features:
- Float precision read/write windows are now supported throughout
Rasterio (#1074).
- Use of old style range tuples as windows is deprecated and warned
against (#1074).
- Addition of dataset ``block()`` method (#1077).
- Added access to subdatasets, both in the API and CLI (see `rio info
--subdatasets`) (#1127).
Bug fixes:
- We always reacquire the GIL when GDAL calls the rasterio logging error
handler (#1103, #1104).
- Initialization of an unneeded array, sometimes contributing to memory
exhaustion, has been eliminated (#1131, #1132).
- Rasterio's boundless reading has had a compositing bug. We are resolving
it by using a VRT internally and relying upon the VRT's windowing and
compositing logic (#1161).
- AWS credentials set in an ``Env`` are no longer clobbered by credentials
from a default boto3 session inside ``rasterio.open`` (#1075).
- NaN can now be used as a nodata value in ``merge`` and when setting nodata
from `rio edit-info` (#1160).
1.0a9 (2017-06-02)
------------------
Breaking changes:
- Removed `**options` argument from `rasterio.warp.transform()`. Transformer
options should be set explicitly inside the currently active
`rasterio.env.Env()`(#1010). This argument was initially added in `1.0a1`.
- The function `transform_geom()` now always splits geometries at the anti-
meridian (#1024).
- The `crs` property of a dataset is now `None` instead of `CRS()` when the
dataset's coordinate reference system is undefined (#1057).
New features:
- Enable setting and getting `GDAL_CACHEMAX` (#1042).
- Integer config option values are now properly encoded and decoded (#1042).
- A `from_wkt()` CRS constructor has been added (#1070).
- Targeting aligned pixels in rio-warp (#941).
- A new `WarpedVRT` class that surfaces GDAL's warp-on-demand VRT features. No
XML editing is required (#1071, #1029).
Bug fixes:
- `dtypes.get_minimum_dtype()` now returns proper value for uint* types
(#1064).
- Rasterio now uses `OSRRelease()` to avoid destroying shared spatial
reference system objects (#1031).
- GDAL_SKIP and GDAL_DRIVER_PATH options, when needed, are now set before
driver registration (#1001).
- A failure of reprojection to an array when source dataset bands have an
index higher than 1 has been fixed (#1056).
1.0a8 (2017-03-29)
------------------
Bug fixes:
- Secrets kept in GDAL config options could have been leaked via the Python
logger. AWS keys and tokens have always been redacted, but other options like
GDAL_HTTP_USERPWD were not. Logging of GDAL config options has been removed.
- Use of Rasterio with Python threads has not been well tested in
previous versions and a bug (#986) involving shared GDAL environment
state was found. Rasterio now uses thread local variables to track
GDAL environment state and uses the appropriate GDAL API functions to
isolate the environments of child threads from each other while
permitting inheritance from the main Python thread (#993, #996, #997).
Tests using both `ThreadPoolExecutor` and `ProcessPoolExecutor` have
been added to guard against regresion.
1.0a7 (2017-02-14)
------------------
Roses are red.
Irish say "feck."
Calling conventions
are a pain in the neck
Bug fixes:
- Use __stdcall for GDAL callbacks on Windows (#935, #951).
- Tear down Env more carefully (#968, #969), taking particular care not to
reinstate default options when a child environment is exited.
- Always close open file handles when exiting context managers returned by
`rasterio.open()` when file objects are given as arguments (#973).
- Properly append, not extend, shim module to extension list (#975).
1.0a6 (2017-02-03)
------------------
Bug fixes:
- Order of input datasets is preserved by rio-calc (#947, #965).
New features:
- `MemoryFile()` can now take a file object parameter or bytes. The file should
be opened in binary mode and its contents are read immediately into bytes.
This form of argument is for convenience only; the provided file is not
accessed in any other way.
- A `ZipMemoryFile` class derived from `MemoryFile` has been added. It is
created from a sequence of bytes representing a zip file. Its `open()` method
can take a path, allowing access to files within the zip file.
- For convenience of users, Rasterio's `open()` function now takes Python file
objects as well as filenames and URLs (#964). These file objects have their
contents read into `MemoryFile` instances within the `open()` call, so this
feature is equivalent to calling `MemoryFile(fp).open()`.
Refactoring:
- GDAL/OGR function definitions consolidated in gdal.pxi (#949).
- Shim APIs have been created to provide support for GDAL 2.0 and 2.1 features
that may be absent in a system's GDAL installation.
Packaging:
- Shim API C modules are included in source distributions.
1.0a5 (2016-12-23)
------------------
- New binary wheels using version 1.2.0 of sgillies/frs-wheel-builds. See
https://github.com/sgillies/frs-wheel-builds/blob/master/CHANGES.txt.
1.0a4 (2016-12-06)
------------------
New features:
- Geographic bounds designated by a `--geographic` option may now be
passed to `rio clip` (#932).
- The `rio edit-info` command's new `--unset-nodata` option can be used to
delete a dataset's nodata value (#510).
Bug fixes:
- Passing a `--co nodata=null` option to CLI commands will create
datasets without any nodata value set. The `--co` option name follows
GDAL's command line utilities. A `--profile` alias for this option has
also been added.
1.0a3 (2016-10-31)
------------------
New features:
- The `DatasetBase` class is now surfaced in `rasterio.io`. This is not too
promote the practice of subclassing `DatasetBase` but to help users that
would like to use type annotations (#925) or make `isinstance()` assertions.
- Ground control points may be read from and written to datasets (when the
format permits) and may be used when reprojecting arrays with `reproject()`
or on the command line with rio-warp (#203, #916). A new rio-gcps command
has been added, it can print a dataset's GCPs as GeoJSON Feature sequences
or FeatureCollections.
- A `BytesIO` like `MemoryFile` class has been added for an improved Python
interface to GDAL's in-memory filesystem (#899, #925).
- Error handlers are pushed to GDAL on entering a GDAL environment and popped
when exiting (#876, #902, #907).
- The GIL is released when calling GDAL's ChunkAndWarp() (#912).
Bug fixes:
- transform_geom() would fail when encountering geometries with z coordinate
values, but now handles them properly (#922, #923).
- show_hist() failed when nans were present in data (#913) and this has been
fixed with the use of nanmin() and nanmax() in #914.
1.0a2 (2016-10-03)
------------------
New features:
- A new `mask_flag_enums` attribute has been added to dataset objects (#881).
- Support for complex data types has been enabled (#714).
Bug fixes:
- Reduce log level when trying to identify a CRS as an EPSG code (#905).
- Acquire GIL when executing the error handler (#903).
- Raster data I/O involving ndarray views has now been corrected (#900, #901).
- Support for single band index in `sample()`, which was advertised in the
docstring but not implemented, has been added (#862).
- The rio-overview CLI command no longer opens datasets in 'r+' mode when
listing overviews (with the `--ls` option) (#885).
- Implicit JPEG overviews for JPEG-compressed GeoTIFF files have been disabled
in Rasterio's default environment, which means decimation is slower but
shows fewer JPEG compression artifacts (#884).
Refactoring:
- Data type-specific functions such as `io_uint8()` have been eliminated from
the private `_io` module and replaced by generic `io_band()`,
`io_multi_band()`, and `io_multi_mask()` functions (#901).
1.0a1 (2016-09-15)
------------------
Documentation:
- New introduction, guidance on switching from GDAL's Python bindings and much
more.
Breaking changes:
- The sense of rio-warp's `--bounds` options has been changed from source
bounds to destination bounds (#549).