Source code for iwfm.gis.raster_band2jpeg

# raster_band2jpeg.py
# Extract raster band to jpeg file
# Copyright (C) 2020-2021 University of California
# -----------------------------------------------------------------------------
# This information is free; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This work is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# For a copy of the GNU General Public License, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# -----------------------------------------------------------------------------


'''Extract a raster band to a file.'''



def raster_band2jpeg(infile, band, outfile, format='JPEG'):
    '''Extract a raster band to a file.

    Parameters
    ----------
    infile : str
        input file name

    band : int
        image band to process

    outfile : str
        output file name

    format : str, default='JPEG'
        output file format

    Returns
    -------
    nothing
    '''
    from osgeo import gdal_array as gdal_array

    srcArray = gdal_array.LoadFile(infile)
    band = srcArray[band - 1]
    gdal_array.SaveArray(band, outfile, format=format)
    return