[refactor] remove unused code from tms2geotiff.py

src/io/tms2geotiff.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 """
-download geo-referenced raster tiles images.
+Download geo-referenced raster tiles images.
 Modified from https://github.com/gumblex/tms2geotiff/
 
 BSD 2-Clause License
@@ -31,21 +29,19 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
+import concurrent.futures
 import io
-import os
-import re
+import itertools
 import math
-import time
+import re
 import sqlite3
-import argparse
-import itertools
-import concurrent.futures
+import time
 
 from PIL import Image
-from PIL import TiffImagePlugin
 
-from src import PROJECT_ROOT_FOLDER, app_logger
-from src.utilities.constants import EARTH_EQUATORIAL_RADIUS, WKT_3857, DEFAULT_TMS
+from src import app_logger
+from src.utilities.constants import EARTH_EQUATORIAL_RADIUS
+
 
 Image.MAX_IMAGE_PIXELS = None
 
@@ -161,38 +157,6 @@ def print_progress(progress, total, done=False):
         app_logger.info('Downloaded image %d/%d, %.2f%%' % (progress, total, progress * 100 / total))
 
 
-class ProgressBar:
-    def __init__(self, use_tqdm=True):
-        self._tqdm_fn = None
-        self.tqdm_bar = None
-        self.tqdm_progress = 0
-        if use_tqdm:
-            try:
-                import tqdm
-                self._tqdm_fn = lambda total: tqdm.tqdm(
-                    total=total, unit='img')
-            except ImportError:
-                pass
-
-    def print_progress(self, progress, total, done=False):
-        if self.tqdm_bar is None and self._tqdm_fn:
-            self.tqdm_bar = self._tqdm_fn(total)
-        if not done:
-            return
-        if self.tqdm_bar is None:
-            print_progress(progress, total, done)
-        elif progress > self.tqdm_progress:
-            delta = progress - self.tqdm_progress
-            self.tqdm_bar.update(delta)
-            self.tqdm_progress = progress
-
-    def close(self):
-        if self.tqdm_bar:
-            self.tqdm_bar.close()
-        else:
-            app_logger.info('\nDone.')
-
-
 def mbtiles_save(db, img_data, xy, zoom, img_format):
     if not img_data:
         return
@@ -363,365 +327,5 @@ def download_extent(
     return retim, matrix
 
 
-def generate_tiffinfo(matrix):
-    ifd = TiffImagePlugin.ImageFileDirectory_v2()
-    # GeoKeyDirectoryTag
-    gkdt = [
-        1, 1,
-        0,  # GeoTIFF 1.0
-        0,  # NumberOfKeys
-    ]
-    # KeyID, TIFFTagLocation, KeyCount, ValueOffset
-    geokeys = [
-        # GTModelTypeGeoKey
-        (1024, 0, 1, 1),  # 2D projected coordinate reference system
-        # GTRasterTypeGeoKey
-        (1025, 0, 1, 1),  # PixelIsArea
-        # GTCitationGeoKey
-        (1026, 34737, 25, 0),
-        # GeodeticCitationGeoKey
-        (2049, 34737, 7, 25),
-        # GeogAngularUnitsGeoKey
-        (2054, 0, 1, 9102),  # degree
-        # ProjectedCRSGeoKey
-        (3072, 0, 1, 3857),
-        # ProjLinearUnitsGeoKey
-        (3076, 0, 1, 9001),  # metre
-    ]
-    gkdt[3] = len(geokeys)
-    ifd.tagtype[34735] = 3  # short
-    ifd[34735] = tuple(itertools.chain(gkdt, *geokeys))
-    # GeoDoubleParamsTag
-    ifd.tagtype[34736] = 12  # double
-    # GeoAsciiParamsTag
-    ifd.tagtype[34737] = 1  # byte
-    ifd[34737] = b'WGS 84 / Pseudo-Mercator|WGS 84|\x00'
-    a, b, c, d, e, f = matrix
-    # ModelPixelScaleTag
-    ifd.tagtype[33550] = 12  # double
-    # ModelTiepointTag
-    ifd.tagtype[33922] = 12  # double
-    # ModelTransformationTag
-    ifd.tagtype[34264] = 12  # double
-    # This matrix tag should not be used
-    # if the ModelTiepointTag and the ModelPixelScaleTag are already defined
-    if c == 0 and e == 0:
-        ifd[33550] = (b, -f, 0.0)
-        ifd[33922] = (0.0, 0.0, 0.0, a, d, 0.0)
-    else:
-        ifd[34264] = (
-            b, c, 0.0, a,
-            e, f, 0.0, d,
-            0.0, 0.0, 0.0, 0.0,
-            0.0, 0.0, 0.0, 1.0
-        )
-    return ifd
-
-
-def img_memorysize(img):
-    return img.size[0] * img.size[1] * len(img.getbands())
-
-
-def save_image_fn(img, filename, matrix, **params):
-    wld_ext = {
-        '.gif': '.gfw',
-        '.jpg': '.jgw',
-        '.jpeg': '.jgw',
-        '.jp2': '.j2w',
-        '.png': '.pgw',
-        '.tif': '.tfw',
-        '.tiff': '.tfw',
-    }
-    basename, ext = os.path.splitext(filename)
-    ext = ext.lower()
-    wld_name = basename + wld_ext.get(ext, '.wld')
-    img_params = params.copy()
-    if ext == '.jpg':
-        img_params['quality'] = 92
-        img_params['optimize'] = True
-    elif ext == '.png':
-        img_params['optimize'] = True
-    elif ext.startswith('.tif'):
-        if img_memorysize(img) >= 4 * 1024 * 1024 * 1024:
-            # BigTIFF
-            return save_geotiff_gdal(img, filename, matrix)
-        img_params['compression'] = 'tiff_adobe_deflate'
-        img_params['tiffinfo'] = generate_tiffinfo(matrix)
-    img.save(filename, **img_params)
-    if not ext.startswith('.tif'):
-        with open(wld_name, 'w', encoding='utf-8') as f_wld:
-            a, b, c, d, e, f = matrix
-            f_wld.write('\n'.join(map(str, (b, e, c, f, a, d, ''))))
-    return img
-
-
-def save_geotiff_gdal(img, filename, matrix):
-    if 'GDAL_DATA' in os.environ:
-        del os.environ['GDAL_DATA']
-    if 'PROJ_LIB' in os.environ:
-        del os.environ['PROJ_LIB']
-
-    import numpy
-    from osgeo import gdal
-    gdal.UseExceptions()
-
-    imgbands = len(img.getbands())
-    driver = gdal.GetDriverByName('GTiff')
-    gdal_options = ['COMPRESS=DEFLATE', 'PREDICTOR=2', 'ZLEVEL=9', 'TILED=YES']
-    if img_memorysize(img) >= 4 * 1024 * 1024 * 1024:
-        gdal_options.append('BIGTIFF=YES')
-    if img_memorysize(img) >= 50 * 1024 * 1024:
-        gdal_options.append('NUM_THREADS=%d' % max(1, os.cpu_count()))
-
-    gtiff = driver.Create(filename, img.size[0], img.size[1],
-                          imgbands, gdal.GDT_Byte,
-                          options=gdal_options)
-    gtiff.SetGeoTransform(matrix)
-    gtiff.SetProjection(WKT_3857)
-    for band in range(imgbands):
-        array = numpy.array(img.getdata(band), dtype='u8')
-        array = array.reshape((img.size[1], img.size[0]))
-        band = gtiff.GetRasterBand(band + 1)
-        band.WriteArray(array)
-    gtiff.FlushCache()
-    return img
-
-
-def save_image_auto(img, filename, matrix, use_gdal=False, **params):
-    ext = os.path.splitext(filename)[1].lower()
-    if ext in ('.tif', '.tiff') and use_gdal:
-        return save_geotiff_gdal(img, filename, matrix)
-    else:
-        return save_image_fn(img, filename, matrix, **params)
-
-
 class TaskCancelled(RuntimeError):
     pass
-
-
-def parse_extent(s):
-    try:
-        coords_text = re_coords_split.split(s)
-        return (float(coords_text[1]), float(coords_text[0]),
-                float(coords_text[3]), float(coords_text[2]))
-    except (IndexError, ValueError):
-        raise ValueError("Invalid extent, should be: min_lon,min_lat,max_lon,max_lat")
-
-
-def gui():
-    import tkinter as tk
-    import tkinter.ttk as ttk
-    import tkinter.messagebox
-
-    root_tk = tk.Tk()
-
-    def cmd_get_save_file():
-        result = root_tk.tk.eval("""tk_getSaveFile -filetypes {
-            {{GeoTIFF} {.tiff}}
-            {{JPG} {.jpg}}
-            {{PNG} {.png}}
-            {{All Files} *}
-        } -defaultextension .tiff""")
-        if result:
-            v_output.set(result)
-
-    def cmd_get_save_mbtiles():
-        result = root_tk.tk.eval("""tk_getSaveFile -filetypes {
-            {{MBTiles} {.mbtiles}}
-            {{All Files} *}
-        } -defaultextension .tiff""")
-        if result:
-            v_mbtiles.set(result)
-
-    frame = ttk.Frame(root_tk, padding=8)
-    frame.grid(column=0, row=0, sticky='nsew')
-    frame.master.title('Download TMS image')
-    frame.master.resizable(0, 0)
-    l_url = ttk.Label(frame, width=50, text="URL: (with {x}, {y}, {z})")
-    l_url.grid(column=0, row=0, columnspan=3, sticky='w', pady=(0, 2))
-    v_url = tk.StringVar()
-    e_url = ttk.Entry(frame, textvariable=v_url)
-    e_url.grid(column=0, row=1, columnspan=3, sticky='we', pady=(0, 5))
-    l_extent = ttk.Label(frame, text="Extent: (min_lon,min_lat,max_lon,max_lat)")
-    l_extent.grid(column=0, row=2, columnspan=3, sticky='w', pady=(0, 2))
-    v_extent = tk.StringVar()
-    e_extent = ttk.Entry(frame, width=50, textvariable=v_extent)
-    e_extent.grid(column=0, row=3, columnspan=3, sticky='we', pady=(0, 5))
-    l_zoom = ttk.Label(frame, width=5, text="Zoom:")
-    l_zoom.grid(column=0, row=4, sticky='w')
-    v_zoom = tk.StringVar()
-    v_zoom.set('13')
-    e_zoom = ttk.Spinbox(frame, width=10, textvariable=v_zoom, **{
-        'from': 1, 'to': 19, 'increment': 1
-    })
-    e_zoom.grid(column=1, row=4, sticky='w')
-    l_output = ttk.Label(frame, width=10, text="Output:")
-    l_output.grid(column=0, row=5, sticky='w')
-    v_output = tk.StringVar()
-    e_output = ttk.Entry(frame, width=30, textvariable=v_output)
-    e_output.grid(column=1, row=5, sticky='we')
-    b_output = ttk.Button(frame, text='...', width=3, command=cmd_get_save_file)
-    b_output.grid(column=2, row=5, sticky='we')
-    l_mbtiles = ttk.Label(frame, width=10, text="MBTiles:")
-    l_mbtiles.grid(column=0, row=6, sticky='w')
-    v_mbtiles = tk.StringVar()
-    e_mbtiles = ttk.Entry(frame, width=30, textvariable=v_mbtiles)
-    e_mbtiles.grid(column=1, row=6, sticky='we')
-    b_mbtiles = ttk.Button(frame, text='...', width=3, command=cmd_get_save_mbtiles)
-    b_mbtiles.grid(column=2, row=6, sticky='we')
-    p_progress = ttk.Progressbar(frame, mode='determinate')
-    p_progress.grid(column=0, row=7, columnspan=3, sticky='we', pady=(5, 2))
-
-    started = False
-    stop_download = False
-
-    def reset():
-        b_download.configure(
-            text='Download', state='normal', command=cmd_download)
-        root_tk.update()
-
-    def update_progress(progress, total, done):
-        nonlocal started, stop_download
-        if not started:
-            if done:
-                p_progress.configure(maximum=total, value=progress)
-            else:
-                p_progress.configure(maximum=total)
-            started = True
-        elif done:
-            p_progress.configure(value=progress)
-        root_tk.update()
-        if stop_download:
-            raise TaskCancelled()
-
-    def cmd_download():
-        nonlocal started, stop_download
-        started = False
-        stop_download = False
-        b_download.configure(text='Cancel', command=cmd_cancel)
-        root_tk.update()
-        try:
-            url = v_url.get().strip()
-            args = [url]
-            args.extend(parse_extent(v_extent.get()))
-            args.append(int(v_zoom.get()))
-            filename = v_output.get()
-            mbtiles = v_mbtiles.get()
-            kwargs = {'mbtiles': mbtiles, 'save_image': bool(filename)}
-            if not all(args) or not any((filename, mbtiles)):
-                raise ValueError("Empty input")
-        except (TypeError, ValueError, IndexError) as ex:
-            reset()
-            tkinter.messagebox.showerror(
-                title='tms2geotiff',
-                message="Invalid input: %s: %s" % (type(ex).__name__, ex),
-                master=frame
-            )
-            return
-        root_tk.update()
-        try:
-            img, matrix_projection = download_extent(
-                *args, progress_callback=update_progress, **kwargs)
-            b_download.configure(text='Saving...', state='disabled')
-            root_tk.update()
-            if filename:
-                save_image_auto(img, filename, matrix_projection)
-            reset()
-        except TaskCancelled:
-            reset()
-            tkinter.messagebox.showwarning(
-                title='tms2geotiff',
-                message="Download cancelled.",
-                master=frame
-            )
-            return
-        except Exception as ex:
-            reset()
-            tkinter.messagebox.showerror(
-                title='tms2geotiff',
-                message="%s: %s" % (type(ex).__name__, ex),
-                master=frame
-            )
-            return
-        tkinter.messagebox.showinfo(
-            title='tms2geotiff',
-            message="Download complete.",
-            master=frame
-        )
-
-    def cmd_cancel():
-        nonlocal started, stop_download
-        started = False
-        stop_download = True
-        reset()
-
-    b_download = ttk.Button(
-        width=15, text='Download', default='active', command=cmd_download)
-    b_download.grid(column=0, row=6, columnspan=3, pady=2)
-
-    root_tk.mainloop()
-
-
-def downloader(input_args, input_parser):
-    download_args = [input_args.source]
-    try:
-        if input_args.extent:
-            download_args.extend(parse_extent(input_args.extent))
-        else:
-            coords0 = tuple(map(float, getattr(input_args, 'from').split(',')))
-            print("coords0:", coords0, "#")
-            coords1 = tuple(map(float, getattr(input_args, 'to').split(',')))
-            print("coords1:", coords1, "#")
-            download_args.extend((coords0[0], coords0[1], coords1[0], coords1[1]))
-    except Exception as e_downloader:
-        print(f"e_downloader:", e_downloader, "#")
-        input_parser.print_help()
-        return 1
-    download_args.append(input_args.zoom)
-    download_args.append(input_args.mbtiles)
-    download_args.append(bool(input_args.output))
-    progress_bar = ProgressBar()
-    download_args.append(progress_bar.print_progress)
-    img_geo, matrix = download_extent(*download_args)
-    progress_bar.close()
-    if input_args.output:
-        print(f"Saving image to {input_args.output}.")
-        save_image_auto(img_geo, input_args.output, matrix)
-    return 0
-
-
-def main():
-    parser = argparse.ArgumentParser(
-        description="Merge TMS tiles to a big image.",
-        epilog="If no parameters are specified, it will open the GUI.")
-    parser.add_argument(
-        "-s", "--source", metavar='URL', default=DEFAULT_TMS,
-        help="TMS server url (default is OpenStreetMap: %s)" % DEFAULT_TMS)
-    parser.add_argument("-f", "--from", metavar='LAT,LON', help="one corner")
-    parser.add_argument("-t", "--to", metavar='LAT,LON', help="the other corner")
-    parser.add_argument("-e", "--extent",
-                        metavar='min_lon,min_lat,max_lon,max_lat',
-                        help="extent in one string (use either -e, or -f and -t)")
-    parser.add_argument("-z", "--zoom", type=int, help="zoom level")
-    parser.add_argument("-m", "--mbtiles", help="save MBTiles file")
-    parser.add_argument("-g", "--gui", action='store_true', help="show GUI")
-    parser.add_argument("output", nargs='?', help="output image file (can be omitted)")
-    args = parser.parse_args()
-    if args.gui or not getattr(args, 'zoom', None):
-        gui()
-        # parser.print_help()
-        return 1
-
-    downloader(args, parser)
-
-
-if __name__ == '__main__':
-    # import sys
-    # sys.exit(main())
-    pt0 = 45.699, 127.1
-    pt1 = 30.1, 148.492
-    geo_img_output_filename = PROJECT_ROOT_FOLDER / "tmp" / "japan_out_main.png"
-    geo_img, projection_matrix = download_extent(DEFAULT_TMS, pt0[0], pt0[1], pt1[0], pt1[1], 6)
-
-    print(f"Saving image to {geo_img_output_filename}.")
-    save_image_auto(geo_img, geo_img_output_filename, projection_matrix)