-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
timelapse.py
3240 lines (2808 loc) · 124 KB
/
timelapse.py
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
"""Module for creating timelapse from various Earth Engine ImageCollection.
"""
import datetime
import io
import os
import shutil
import ee
from .common import *
def add_overlay(
collection, overlay_data, color="black", width=1, opacity=1.0, region=None
):
"""Adds an overlay to an image collection.
Args:
collection (ee.ImageCollection): The image collection to add the overlay to.
overlay_data (str | ee.Geometry | ee.FeatureCollection): The overlay data to add to the image collection. It can be an HTTP URL to a GeoJSON file.
color (str, optional): The color of the overlay. Defaults to 'black'.
width (int, optional): The width of the overlay. Defaults to 1.
opacity (float, optional): The opacity of the overlay. Defaults to 1.0.
region (ee.Geometry | ee.FeatureCollection, optional): The region of interest to add the overlay to. Defaults to None.
Returns:
ee.ImageCollection: An ImageCollection with the overlay added.
"""
# Some common administrative boundaries.
public_assets = ["continents", "countries", "us_states", "china"]
if not isinstance(collection, ee.ImageCollection):
raise Exception("The collection must be an ee.ImageCollection.")
if not isinstance(overlay_data, ee.FeatureCollection):
if isinstance(overlay_data, str):
try:
if overlay_data.lower() in public_assets:
overlay_data = ee.FeatureCollection(
f"users/giswqs/public/{overlay_data.lower()}"
)
elif overlay_data.startswith("http") and overlay_data.endswith(
".geojson"
):
overlay_data = geojson_to_ee(overlay_data)
else:
overlay_data = ee.FeatureCollection(overlay_data)
except Exception as e:
print(
"The overlay_data must be a valid ee.FeatureCollection, a valid ee.FeatureCollection asset id, or http url to a geojson file."
)
raise Exception(e)
elif isinstance(overlay_data, ee.Feature):
overlay_data = ee.FeatureCollection([overlay_data])
elif isinstance(overlay_data, ee.Geometry):
overlay_data = ee.FeatureCollection([ee.Feature(overlay_data)])
else:
raise Exception(
"The overlay_data must be a valid ee.FeatureCollection or a valid ee.FeatureCollection asset id."
)
try:
if region is not None:
overlay_data = overlay_data.filterBounds(region)
empty = ee.Image().byte()
image = empty.paint(
**{
"featureCollection": overlay_data,
"color": 1,
"width": width,
}
).visualize(**{"palette": check_color(color), "opacity": opacity})
blend_col = collection.map(
lambda img: img.blend(image).set(
"system:time_start", img.get("system:time_start")
)
)
return blend_col
except Exception as e:
print("Error in add_overlay:")
raise Exception(e)
def make_gif(images, out_gif, ext="jpg", fps=10, loop=0, mp4=False, clean_up=False):
"""Creates a gif from a list of images.
Args:
images (list | str): The list of images or input directory to create the gif from.
out_gif (str): File path to the output gif.
ext (str, optional): The extension of the images. Defaults to 'jpg'.
fps (int, optional): The frames per second of the gif. Defaults to 10.
loop (int, optional): The number of times to loop the gif. Defaults to 0.
mp4 (bool, optional): Whether to convert the gif to mp4. Defaults to False.
"""
import glob
from PIL import Image
if isinstance(images, str) and os.path.isdir(images):
images = list(glob.glob(os.path.join(images, f"*.{ext}")))
if len(images) == 0:
raise ValueError("No images found in the input directory.")
elif not isinstance(images, list):
raise ValueError("images must be a list or a path to the image directory.")
images.sort()
frames = [Image.open(image) for image in images]
frame_one = frames[0]
frame_one.save(
out_gif,
format="GIF",
append_images=frames,
save_all=True,
duration=int(1000 / fps),
loop=loop,
)
if mp4:
if not is_tool("ffmpeg"):
print("ffmpeg is not installed on your computer.")
return
if os.path.exists(out_gif):
out_mp4 = out_gif.replace(".gif", ".mp4")
cmd = f"ffmpeg -i {out_gif} -vcodec libx264 -crf 25 -pix_fmt yuv420p {out_mp4}"
os.system(cmd)
if not os.path.exists(out_mp4):
raise Exception(f"Failed to create mp4 file.")
if clean_up:
for image in images:
os.remove(image)
def gif_to_mp4(in_gif, out_mp4):
"""Converts a gif to mp4.
Args:
in_gif (str): The input gif file.
out_mp4 (str): The output mp4 file.
"""
from PIL import Image
if not os.path.exists(in_gif):
raise FileNotFoundError(f"{in_gif} does not exist.")
out_mp4 = os.path.abspath(out_mp4)
if not out_mp4.endswith(".mp4"):
out_mp4 = out_mp4 + ".mp4"
if not os.path.exists(os.path.dirname(out_mp4)):
os.makedirs(os.path.dirname(out_mp4))
if not is_tool("ffmpeg"):
print("ffmpeg is not installed on your computer.")
return
width, height = Image.open(in_gif).size
if width % 2 == 0 and height % 2 == 0:
cmd = f"ffmpeg -i {in_gif} -vcodec libx264 -crf 25 -pix_fmt yuv420p {out_mp4}"
os.system(cmd)
else:
width += width % 2
height += height % 2
cmd = f"ffmpeg -i {in_gif} -vf scale={width}:{height} -vcodec libx264 -crf 25 -pix_fmt yuv420p {out_mp4}"
os.system(cmd)
if not os.path.exists(out_mp4):
raise Exception(f"Failed to create mp4 file.")
def merge_gifs(in_gifs, out_gif):
"""Merge multiple gifs into one.
Args:
in_gifs (str | list): The input gifs as a list or a directory path.
out_gif (str): The output gif.
Raises:
Exception: Raise exception when gifsicle is not installed.
"""
import glob
try:
if isinstance(in_gifs, str) and os.path.isdir(in_gifs):
in_gifs = glob.glob(os.path.join(in_gifs, "*.gif"))
elif not isinstance(in_gifs, list):
raise Exception("in_gifs must be a list.")
in_gifs = " ".join(in_gifs)
cmd = f"gifsicle {in_gifs} > {out_gif}"
os.system(cmd)
except Exception as e:
print(
"gifsicle is not installed. Run 'sudo apt-get install -y gifsicle' to install it."
)
print(e)
def add_text_to_gif(
in_gif,
out_gif,
xy=None,
text_sequence=None,
font_type="arial.ttf",
font_size=20,
font_color="#000000",
add_progress_bar=True,
progress_bar_color="white",
progress_bar_height=5,
duration=100,
loop=0,
):
"""Adds animated text to a GIF image.
Args:
in_gif (str): The file path to the input GIF image.
out_gif (str): The file path to the output GIF image.
xy (tuple, optional): Top left corner of the text. It can be formatted like this: (10, 10) or ('15%', '25%'). Defaults to None.
text_sequence (int, str, list, optional): Text to be drawn. It can be an integer number, a string, or a list of strings. Defaults to None.
font_type (str, optional): Font type. Defaults to "arial.ttf".
font_size (int, optional): Font size. Defaults to 20.
font_color (str, optional): Font color. It can be a string (e.g., 'red'), rgb tuple (e.g., (255, 127, 0)), or hex code (e.g., '#ff00ff'). Defaults to '#000000'.
add_progress_bar (bool, optional): Whether to add a progress bar at the bottom of the GIF. Defaults to True.
progress_bar_color (str, optional): Color for the progress bar. Defaults to 'white'.
progress_bar_height (int, optional): Height of the progress bar. Defaults to 5.
duration (int, optional): controls how long each frame will be displayed for, in milliseconds. It is the inverse of the frame rate. Setting it to 100 milliseconds gives 10 frames per second. You can decrease the duration to give a smoother animation.. Defaults to 100.
loop (int, optional): controls how many times the animation repeats. The default, 1, means that the animation will play once and then stop (displaying the last frame). A value of 0 means that the animation will repeat forever. Defaults to 0.
"""
# import io
import warnings
import pkg_resources
from PIL import Image, ImageDraw, ImageFont, ImageSequence
warnings.simplefilter("ignore")
pkg_dir = os.path.dirname(pkg_resources.resource_filename("geemap", "geemap.py"))
default_font = os.path.join(pkg_dir, "data/fonts/arial.ttf")
in_gif = os.path.abspath(in_gif)
out_gif = os.path.abspath(out_gif)
if not os.path.exists(in_gif):
print("The input gif file does not exist.")
return
if not os.path.exists(os.path.dirname(out_gif)):
os.makedirs(os.path.dirname(out_gif))
if font_type == "arial.ttf":
font = ImageFont.truetype(default_font, font_size)
elif font_type == "alibaba.otf":
default_font = os.path.join(pkg_dir, "data/fonts/alibaba.otf")
font = ImageFont.truetype(default_font, font_size)
else:
try:
font_list = system_fonts(show_full_path=True)
font_names = [os.path.basename(f) for f in font_list]
if (font_type in font_list) or (font_type in font_names):
font = ImageFont.truetype(font_type, font_size)
else:
print(
"The specified font type could not be found on your system. Using the default font instead."
)
font = ImageFont.truetype(default_font, font_size)
except Exception as e:
print(e)
font = ImageFont.truetype(default_font, font_size)
color = check_color(font_color)
progress_bar_color = check_color(progress_bar_color)
try:
image = Image.open(in_gif)
except Exception as e:
print("An error occurred while opening the gif.")
print(e)
return
count = image.n_frames
W, H = image.size
progress_bar_widths = [i * 1.0 / count * W for i in range(1, count + 1)]
progress_bar_shapes = [
[(0, H - progress_bar_height), (x, H)] for x in progress_bar_widths
]
if xy is None:
# default text location is 5% width and 5% height of the image.
xy = (int(0.05 * W), int(0.05 * H))
elif (xy is not None) and (not isinstance(xy, tuple)) and (len(xy) == 2):
print("xy must be a tuple, e.g., (10, 10), ('10%', '10%')")
return
elif all(isinstance(item, int) for item in xy) and (len(xy) == 2):
x, y = xy
if (x > 0) and (x < W) and (y > 0) and (y < H):
pass
else:
print(
f"xy is out of bounds. x must be within [0, {W}], and y must be within [0, {H}]"
)
return
elif all(isinstance(item, str) for item in xy) and (len(xy) == 2):
x, y = xy
if ("%" in x) and ("%" in y):
try:
x = int(float(x.replace("%", "")) / 100.0 * W)
y = int(float(y.replace("%", "")) / 100.0 * H)
xy = (x, y)
except Exception:
raise Exception(
"The specified xy is invalid. It must be formatted like this ('10%', '10%')"
)
else:
print(
"The specified xy is invalid. It must be formatted like this: (10, 10) or ('10%', '10%')"
)
return
if text_sequence is None:
text = [str(x) for x in range(1, count + 1)]
elif isinstance(text_sequence, int):
text = [str(x) for x in range(text_sequence, text_sequence + count + 1)]
elif isinstance(text_sequence, str):
try:
text_sequence = int(text_sequence)
text = [str(x) for x in range(text_sequence, text_sequence + count + 1)]
except Exception:
text = [text_sequence] * count
elif isinstance(text_sequence, list) and len(text_sequence) != count:
print(
f"The length of the text sequence must be equal to the number ({count}) of frames in the gif."
)
return
else:
text = [str(x) for x in text_sequence]
try:
frames = []
# Loop over each frame in the animated image
for index, frame in enumerate(ImageSequence.Iterator(image)):
# Draw the text on the frame
frame = frame.convert("RGB")
draw = ImageDraw.Draw(frame)
# w, h = draw.textsize(text[index])
draw.text(xy, text[index], font=font, fill=color)
if add_progress_bar:
draw.rectangle(progress_bar_shapes[index], fill=progress_bar_color)
del draw
b = io.BytesIO()
frame.save(b, format="GIF")
frame = Image.open(b)
frames.append(frame)
# https://www.pythoninformer.com/python-libraries/pillow/creating-animated-gif/
# Save the frames as a new image
frames[0].save(
out_gif,
save_all=True,
append_images=frames[1:],
duration=duration,
loop=loop,
optimize=True,
)
except Exception as e:
print(e)
def add_image_to_gif(
in_gif, out_gif, in_image, xy=None, image_size=(80, 80), circle_mask=False
):
"""Adds an image logo to a GIF image.
Args:
in_gif (str): Input file path to the GIF image.
out_gif (str): Output file path to the GIF image.
in_image (str): Input file path to the image.
xy (tuple, optional): Top left corner of the text. It can be formatted like this: (10, 10) or ('15%', '25%'). Defaults to None.
image_size (tuple, optional): Resize image. Defaults to (80, 80).
circle_mask (bool, optional): Whether to apply a circle mask to the image. This only works with non-png images. Defaults to False.
"""
# import io
import warnings
from PIL import Image, ImageDraw, ImageSequence
warnings.simplefilter("ignore")
in_gif = os.path.abspath(in_gif)
is_url = False
if in_image.startswith("http"):
is_url = True
if not os.path.exists(in_gif):
print("The input gif file does not exist.")
return
if (not is_url) and (not os.path.exists(in_image)):
print("The provided logo file does not exist.")
return
if not os.path.exists(os.path.dirname(out_gif)):
os.makedirs(os.path.dirname(out_gif))
try:
image = Image.open(in_gif)
except Exception as e:
print("An error occurred while opening the image.")
print(e)
return
logo_raw_image = None
try:
if in_image.startswith("http"):
logo_raw_image = open_image_from_url(in_image)
else:
in_image = os.path.abspath(in_image)
logo_raw_image = Image.open(in_image)
except Exception as e:
print(e)
logo_raw_size = logo_raw_image.size
image_size = min(logo_raw_size[0], image_size[0]), min(
logo_raw_size[1], image_size[1]
)
logo_image = logo_raw_image.convert("RGBA")
logo_image.thumbnail(image_size, Image.ANTIALIAS)
W, H = image.size
mask_im = None
if circle_mask:
mask_im = Image.new("L", image_size, 0)
draw = ImageDraw.Draw(mask_im)
draw.ellipse((0, 0, image_size[0], image_size[1]), fill=255)
if has_transparency(logo_raw_image):
mask_im = logo_image.copy()
if xy is None:
# default logo location is 5% width and 5% height of the image.
xy = (int(0.05 * W), int(0.05 * H))
elif (xy is not None) and (not isinstance(xy, tuple)) and (len(xy) == 2):
print("xy must be a tuple, e.g., (10, 10), ('10%', '10%')")
return
elif all(isinstance(item, int) for item in xy) and (len(xy) == 2):
x, y = xy
if (x > 0) and (x < W) and (y > 0) and (y < H):
pass
else:
print(
"xy is out of bounds. x must be within [0, {}], and y must be within [0, {}]".format(
W, H
)
)
return
elif all(isinstance(item, str) for item in xy) and (len(xy) == 2):
x, y = xy
if ("%" in x) and ("%" in y):
try:
x = int(float(x.replace("%", "")) / 100.0 * W)
y = int(float(y.replace("%", "")) / 100.0 * H)
xy = (x, y)
except Exception:
raise Exception(
"The specified xy is invalid. It must be formatted like this ('10%', '10%')"
)
else:
raise Exception(
"The specified xy is invalid. It must be formatted like this: (10, 10) or ('10%', '10%')"
)
try:
frames = []
for _, frame in enumerate(ImageSequence.Iterator(image)):
frame = frame.convert("RGBA")
frame.paste(logo_image, xy, mask_im)
b = io.BytesIO()
frame.save(b, format="GIF")
frame = Image.open(b)
frames.append(frame)
frames[0].save(out_gif, save_all=True, append_images=frames[1:])
except Exception as e:
print(e)
def reduce_gif_size(in_gif, out_gif=None):
"""Reduces a GIF image using ffmpeg.
Args:
in_gif (str): The input file path to the GIF image.
out_gif (str, optional): The output file path to the GIF image. Defaults to None.
"""
import ffmpeg
import warnings
warnings.filterwarnings("ignore")
if not is_tool("ffmpeg"):
print("ffmpeg is not installed on your computer.")
return
if not os.path.exists(in_gif):
print("The input gif file does not exist.")
return
if out_gif is None:
out_gif = in_gif
elif not os.path.exists(os.path.dirname(out_gif)):
os.makedirs(os.path.dirname(out_gif))
if in_gif == out_gif:
tmp_gif = in_gif.replace(".gif", "_tmp.gif")
shutil.copyfile(in_gif, tmp_gif)
stream = ffmpeg.input(tmp_gif)
stream = ffmpeg.output(stream, in_gif).overwrite_output()
ffmpeg.run(stream)
os.remove(tmp_gif)
else:
stream = ffmpeg.input(in_gif)
stream = ffmpeg.output(stream, out_gif).overwrite_output()
ffmpeg.run(stream)
def create_timeseries(
collection,
start_date,
end_date,
region=None,
bands=None,
frequency="year",
reducer="median",
drop_empty=True,
date_format=None,
):
"""Creates a timeseries from a collection of images by a specified frequency and reducer.
Args:
collection (str | ee.ImageCollection): The collection of images to create a timeseries from. It can be a string representing the collection ID or an ee.ImageCollection object.
start_date (str): The start date of the timeseries. It must be formatted like this: 'YYYY-MM-dd'.
end_date (str): The end date of the timeseries. It must be formatted like this: 'YYYY-MM-dd'.
region (ee.Geometry, optional): The region to use to filter the collection of images. It must be an ee.Geometry object. Defaults to None.
bands (list, optional): The list of bands to use to create the timeseries. It must be a list of strings. Defaults to None.
frequency (str, optional): The frequency of the timeseries. It must be one of the following: 'year', 'month', 'day', 'hour', 'minute', 'second'. Defaults to 'year'.
reducer (str, optional): The reducer to use to reduce the collection of images to a single value. It can be one of the following: 'median', 'mean', 'min', 'max', 'variance', 'sum'. Defaults to 'median'.
drop_empty (bool, optional): Whether to drop empty images from the timeseries. Defaults to True.
date_format (str, optional): A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html. Defaults to 'YYYY-MM-dd'.
Returns:
ee.ImageCollection: The timeseries.
"""
if not isinstance(collection, ee.ImageCollection):
if isinstance(collection, str):
collection = ee.ImageCollection(collection)
else:
raise Exception(
"The collection must be an ee.ImageCollection object or asset id."
)
if bands is not None:
collection = collection.select(bands)
else:
bands = collection.first().bandNames()
feq_dict = {
"year": "YYYY",
"month": "YYYY-MM",
"quarter": "YYYY-MM",
"week": "YYYY-MM-dd",
"day": "YYYY-MM-dd",
"hour": "YYYY-MM-dd HH",
"minute": "YYYY-MM-dd HH:mm",
"second": "YYYY-MM-dd HH:mm:ss",
}
if date_format is None:
date_format = feq_dict[frequency]
dates = date_sequence(start_date, end_date, frequency, date_format)
try:
reducer = eval(f"ee.Reducer.{reducer}()")
except Exception as e:
print("The provided reducer is invalid.")
raise Exception(e)
def create_image(date):
start = ee.Date(date)
if frequency == "quarter":
end = start.advance(3, "month")
else:
end = start.advance(1, frequency)
if region is None:
sub_col = collection.filterDate(start, end)
image = sub_col.reduce(reducer)
else:
sub_col = collection.filterDate(start, end).filterBounds(region)
image = sub_col.reduce(reducer).clip(region)
return image.set(
{
"system:time_start": ee.Date(date).millis(),
"system:date": ee.Date(date).format(date_format),
"empty": sub_col.size().eq(0),
}
).rename(bands)
try:
images = ee.ImageCollection(dates.map(create_image))
if drop_empty:
return images.filterMetadata("empty", "equals", 0)
else:
return images
except Exception as e:
raise Exception(e)
def create_timelapse(
collection,
start_date,
end_date,
region=None,
bands=None,
frequency="year",
reducer="median",
date_format=None,
out_gif=None,
palette=None,
vis_params=None,
dimensions=768,
frames_per_second=10,
crs="EPSG:3857",
overlay_data=None,
overlay_color="black",
overlay_width=1,
overlay_opacity=1.0,
title=None,
title_xy=("2%", "90%"),
add_text=True,
text_xy=("2%", "2%"),
text_sequence=None,
font_type="arial.ttf",
font_size=20,
font_color="white",
add_progress_bar=True,
progress_bar_color="white",
progress_bar_height=5,
loop=0,
mp4=False,
):
"""Create a timelapse from any ee.ImageCollection.
Args:
collection (str | ee.ImageCollection): The collection of images to create a timeseries from. It can be a string representing the collection ID or an ee.ImageCollection object.
start_date (str): The start date of the timeseries. It must be formatted like this: 'YYYY-MM-dd'.
end_date (str): The end date of the timeseries. It must be formatted like this: 'YYYY-MM-dd'.
region (ee.Geometry, optional): The region to use to filter the collection of images. It must be an ee.Geometry object. Defaults to None.
bands (list, optional): A list of band names to use in the timelapse. Defaults to None.
frequency (str, optional): The frequency of the timeseries. It must be one of the following: 'year', 'month', 'day', 'hour', 'minute', 'second'. Defaults to 'year'.
reducer (str, optional): The reducer to use to reduce the collection of images to a single value. It can be one of the following: 'median', 'mean', 'min', 'max', 'variance', 'sum'. Defaults to 'median'.
drop_empty (bool, optional): Whether to drop empty images from the timeseries. Defaults to True.
date_format (str, optional): A pattern, as described at http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html. Defaults to 'YYYY-MM-dd'.
out_gif (str): The output gif file path. Defaults to None.
palette (list, optional): A list of colors to render a single-band image in the timelapse. Defaults to None.
vis_params (dict, optional): A dictionary of visualization parameters to use in the timelapse. Defaults to None. See more at https://developers.google.com/earth-engine/guides/image_visualization.
dimensions (int, optional): a number or pair of numbers in format WIDTHxHEIGHT) Maximum dimensions of the thumbnail to render, in pixels. If only one number is passed, it is used as the maximum, and the other dimension is computed by proportional scaling. Defaults to 768.
frames_per_second (int, optional): Animation speed. Defaults to 10.
crs (str, optional): The coordinate reference system to use. Defaults to "EPSG:3857".
overlay_data (int, str, list, optional): Administrative boundary to be drawn on the timelapse. Defaults to None.
overlay_color (str, optional): Color for the overlay data. Can be any color name or hex color code. Defaults to 'black'.
overlay_width (int, optional): Width of the overlay. Defaults to 1.
overlay_opacity (float, optional): Opacity of the overlay. Defaults to 1.0.
title (str, optional): The title of the timelapse. Defaults to None.
title_xy (tuple, optional): Lower left corner of the title. It can be formatted like this: (10, 10) or ('15%', '25%'). Defaults to None.
add_text (bool, optional): Whether to add animated text to the timelapse. Defaults to True.
title_xy (tuple, optional): Lower left corner of the text sequency. It can be formatted like this: (10, 10) or ('15%', '25%'). Defaults to None.
text_sequence (int, str, list, optional): Text to be drawn. It can be an integer number, a string, or a list of strings. Defaults to None.
font_type (str, optional): Font type. Defaults to "arial.ttf".
font_size (int, optional): Font size. Defaults to 20.
font_color (str, optional): Font color. It can be a string (e.g., 'red'), rgb tuple (e.g., (255, 127, 0)), or hex code (e.g., '#ff00ff'). Defaults to '#000000'.
add_progress_bar (bool, optional): Whether to add a progress bar at the bottom of the GIF. Defaults to True.
progress_bar_color (str, optional): Color for the progress bar. Defaults to 'white'.
progress_bar_height (int, optional): Height of the progress bar. Defaults to 5.
loop (int, optional): Controls how many times the animation repeats. The default, 1, means that the animation will play once and then stop (displaying the last frame). A value of 0 means that the animation will repeat forever. Defaults to 0.
mp4 (bool, optional): Whether to create an mp4 file. Defaults to False.
Returns:
str: File path to the timelapse gif.
"""
import geemap.colormaps as cm
if not isinstance(collection, ee.ImageCollection):
if isinstance(collection, str):
collection = ee.ImageCollection(collection)
else:
raise Exception(
"The collection must be an ee.ImageCollection object or asset id."
)
col = create_timeseries(
collection,
start_date,
end_date,
region=region,
bands=bands,
frequency=frequency,
reducer=reducer,
drop_empty=True,
date_format=date_format,
)
# rename the bands to remove the '_reducer' characters from the band names.
col = col.map(
lambda img: img.rename(
img.bandNames().map(lambda name: ee.String(name).replace(f"_{reducer}", ""))
)
)
if out_gif is None:
out_gif = temp_file_path(".gif")
else:
out_gif = os.path.abspath(out_gif)
if not os.path.exists(os.path.dirname(out_gif)):
os.makedirs(os.path.dirname(out_gif))
out_dir = os.path.dirname(out_gif)
if bands is None:
names = col.first().bandNames().getInfo()
if len(names) < 3:
bands = [names[0]]
else:
bands = names[:3][::-1]
elif isinstance(bands, str):
bands = [bands]
elif not isinstance(bands, list):
raise Exception("The bands must be a string or a list of strings.")
if isinstance(palette, str):
palette = cm.get_palette(palette, 15)
elif isinstance(palette, list) or isinstance(palette, tuple):
pass
elif palette is not None:
raise Exception("The palette must be a string or a list of strings.")
if vis_params is None:
img = col.first().select(bands)
scale = collection.first().select(0).projection().nominalScale().multiply(10)
min_value = min(
image_min_value(img, region=region, scale=scale).getInfo().values()
)
max_value = max(
image_max_value(img, region=region, scale=scale).getInfo().values()
)
vis_params = {"bands": bands, "min": min_value, "max": max_value}
if len(bands) == 1:
if palette is not None:
vis_params["palette"] = palette
else:
vis_params["palette"] = cm.palettes.ndvi
elif isinstance(vis_params, dict):
if "bands" not in vis_params:
vis_params["bands"] = bands
if "min" not in vis_params:
img = col.first().select(bands)
scale = (
collection.first().select(0).projection().nominalScale().multiply(10)
)
vis_params["min"] = min(
image_min_value(img, region=region, scale=scale).getInfo().values()
)
if "max" not in vis_params:
img = col.first().select(bands)
scale = (
collection.first().select(0).projection().nominalScale().multiply(10)
)
vis_params["max"] = max(
image_max_value(img, region=region, scale=scale).getInfo().values()
)
if palette is None and (len(bands) == 1) and ("palette" not in vis_params):
vis_params["palette"] = cm.palettes.ndvi
elif palette is not None and ("palette" not in vis_params):
vis_params["palette"] = palette
if len(bands) > 1 and "palette" in vis_params:
del vis_params["palette"]
else:
raise Exception("The vis_params must be a dictionary.")
col = col.select(bands).map(
lambda img: img.visualize(**vis_params).set(
{
"system:time_start": img.get("system:time_start"),
"system:date": img.get("system:date"),
}
)
)
if overlay_data is not None:
col = add_overlay(
col, overlay_data, overlay_color, overlay_width, overlay_opacity
)
video_args = {}
video_args["dimensions"] = dimensions
video_args["region"] = region
video_args["framesPerSecond"] = frames_per_second
video_args["crs"] = crs
video_args["min"] = 0
video_args["max"] = 255
# if crs is not None:
# video_args["crs"] = crs
if "palette" in vis_params or len(bands) > 1:
video_args["bands"] = ["vis-red", "vis-green", "vis-blue"]
else:
video_args["bands"] = ["vis-gray"]
if dimensions > 768:
count = col.size().getInfo()
basename = os.path.basename(out_gif)[:-4]
names = [
os.path.join(
out_dir, f"{basename}_{str(i+1).zfill(int(len(str(count))))}.jpg"
)
for i in range(count)
]
get_image_collection_thumbnails(
col,
out_dir,
vis_params={
"min": 0,
"max": 255,
"bands": video_args["bands"],
},
dimensions=dimensions,
names=names,
)
make_gif(
names,
out_gif,
fps=frames_per_second,
loop=loop,
mp4=False,
clean_up=True,
)
else:
download_ee_video(col, video_args, out_gif)
if title is not None and isinstance(title, str):
add_text_to_gif(
out_gif,
out_gif,
xy=title_xy,
text_sequence=title,
font_type=font_type,
font_size=font_size,
font_color=font_color,
add_progress_bar=add_progress_bar,
progress_bar_color=progress_bar_color,
progress_bar_height=progress_bar_height,
duration=1000 / frames_per_second,
loop=loop,
)
if add_text:
if text_sequence is None:
text_sequence = col.aggregate_array("system:date").getInfo()
add_text_to_gif(
out_gif,
out_gif,
xy=text_xy,
text_sequence=text_sequence,
font_type=font_type,
font_size=font_size,
font_color=font_color,
add_progress_bar=add_progress_bar,
progress_bar_color=progress_bar_color,
progress_bar_height=progress_bar_height,
duration=1000 / frames_per_second,
loop=loop,
)
if os.path.exists(out_gif):
reduce_gif_size(out_gif)
if mp4:
out_mp4 = out_gif.replace(".gif", ".mp4")
gif_to_mp4(out_gif, out_mp4)
return out_gif
def naip_timeseries(roi=None, start_year=2003, end_year=2021, RGBN=False):
"""Creates NAIP annual timeseries
Args:
roi (object, optional): An ee.Geometry representing the region of interest. Defaults to None.
start_year (int, optional): Starting year for the timeseries. Defaults to 2003.
end_year (int, optional): Ending year for the timeseries. Defaults to 2021.
RGBN (bool, optional): Whether to retrieve 4-band NAIP imagery only.
Returns:
object: An ee.ImageCollection representing annual NAIP imagery.
"""
try:
def get_annual_NAIP(year):
try:
collection = ee.ImageCollection("USDA/NAIP/DOQQ")
if roi is not None:
collection = collection.filterBounds(roi)
start_date = ee.Date.fromYMD(year, 1, 1)
end_date = ee.Date.fromYMD(year, 12, 31)
naip = collection.filterDate(start_date, end_date)
if RGBN:
naip = naip.filter(ee.Filter.listContains("system:band_names", "N"))
if roi is not None:
if isinstance(roi, ee.Geometry):
image = ee.Image(ee.ImageCollection(naip).mosaic().clip(roi))
elif isinstance(roi, ee.FeatureCollection):
image = ee.Image(
ee.ImageCollection(naip).mosaic().clipToCollection(roi)
)
else:
image = ee.Image(ee.ImageCollection(naip).mosaic())
return image.set(
{
"system:time_start": ee.Date(start_date).millis(),
"system:time_end": ee.Date(end_date).millis(),
"empty": naip.size().eq(0),
}
)
except Exception as e:
raise Exception(e)
years = ee.List.sequence(start_year, end_year)
collection = ee.ImageCollection(years.map(get_annual_NAIP))
return collection.filterMetadata("empty", "equals", 0)
except Exception as e:
raise Exception(e)
def naip_timelapse(
region,
start_year=2003,
end_year=2021,
out_gif=None,
bands=None,
palette=None,
vis_params=None,
dimensions=768,
frames_per_second=3,
crs="EPSG:3857",
overlay_data=None,
overlay_color="black",
overlay_width=1,
overlay_opacity=1.0,
title=None,
title_xy=("2%", "90%"),
add_text=True,
text_xy=("2%", "2%"),
text_sequence=None,
font_type="arial.ttf",
font_size=20,
font_color="white",
add_progress_bar=True,
progress_bar_color="white",
progress_bar_height=5,
loop=0,
mp4=False,
):
"""Create a timelapse from NAIP imagery.
Args:
region (ee.Geometry): The region to use to filter the collection of images. It must be an ee.Geometry object. Defaults to None.
start_year (int | str, optional): The start year of the timeseries. It must be formatted like this: 'YYYY'. Defaults to 2003.
end_year (int | str, optional): The end year of the timeseries. It must be formatted like this: 'YYYY'. Defaults to 2021.
out_gif (str): The output gif file path. Defaults to None.
bands (list, optional): A list of band names to use in the timelapse. Defaults to None.
palette (list, optional): A list of colors to render a single-band image in the timelapse. Defaults to None.
vis_params (dict, optional): A dictionary of visualization parameters to use in the timelapse. Defaults to None. See more at https://developers.google.com/earth-engine/guides/image_visualization.
dimensions (int, optional): a number or pair of numbers in format WIDTHxHEIGHT) Maximum dimensions of the thumbnail to render, in pixels. If only one number is passed, it is used as the maximum, and the other dimension is computed by proportional scaling. Defaults to 768.