Packager writer plugin

Collect referenced GeoTiffs (COGs) into a tar gzip

writer(id, src, extent, dst, cellsize, dst_srs='EPSG:5070')

Packager writer plugin

Parameters:

Name Type Description Default
id str

Download ID

required
src list

List of objects describing the GeoTiff (COG)

required
extent dict

Object with watershed name and bounding box

required
dst str

Temporary directory

required
cellsize float

Grid resolution

required
dst_srs str, optional

Destination Spacial Reference, by default "EPSG:5070"

'EPSG:5070'

Returns:

Type Description
str

FQPN to dss file

Source code in cumulus_packager/writers/tgz-cog.py
 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
@pyplugs.register
def writer(
    id: str,
    src: str,
    extent: str,
    dst: str,
    cellsize: float,
    dst_srs: str = "EPSG:5070",
):
    """Packager writer plugin

    Parameters
    ----------
    id : str
        Download ID
    src : list
        List of objects describing the GeoTiff (COG)
    extent : dict
        Object with watershed name and bounding box
    dst : str
        Temporary directory
    cellsize : float
        Grid resolution
    dst_srs : str, optional
        Destination Spacial Reference, by default "EPSG:5070"

    Returns
    -------
    str
        FQPN to dss file
    """
    # convert the strings back to json objects; needed for pyplugs
    src = json.loads(src)
    gridcount = len(src)
    extent = json.loads(extent)
    # _extent_name = extent["name"]
    _bbox = extent["bbox"]
    _progress = 0

    # return None if no items in the 'contents'
    if len(src) < 1:
        update_status(id=id, status_id=PACKAGE_STATUS["FAILED"], progress=_progress)
        return

    tarfilename = os.path.join(dst, id) + ".tar.gz"
    try:
        tar = TarFile.open(tarfilename, "w:gz")

        for idx, tif in enumerate(src):
            TifCfg = namedtuple("TifCfg", tif)(**tif)

            filename_ = os.path.basename(TifCfg.key)

            # GDAL Warp the Tiff to what we need for DSS
            ds = gdal.Open(f"/vsis3_streaming/{TifCfg.bucket}/{TifCfg.key}")
            gdal.Warp(
                tarfile := os.path.join(dst, filename_),
                ds,
                format="GTiff",
                outputBounds=_bbox,
                xRes=cellsize,
                yRes=cellsize,
                targetAlignedPixels=True,
                dstSRS=dst_srs,
                outputType=gdal.GDT_Float64,
                resampleAlg="bilinear",
                dstNodata=-9999,
                copyMetadata=True,
            )

            # add the tiff to the tar
            tar.add(tarfile, arcname=filename_, recursive=False)

            # callback
            _progress = int(((idx + 1) / gridcount) * 100)
            # Update progress at predefined interval
            if idx % PACKAGER_UPDATE_INTERVAL == 0 or idx == gridcount - 1:
                logger.debug(f"Progress: {_progress}")
                update_status(
                    id=id, status_id=PACKAGE_STATUS["INITIATED"], progress=_progress
                )
    except (RuntimeError, Exception) as ex:
        logger.error(f"{type(ex).__name__}: {this}: {ex}")
        update_status(id=id, status_id=PACKAGE_STATUS["FAILED"], progress=_progress)
        return None
    finally:
        ds = None
        tar.close()

    return tarfilename