ipygee.ee_image_collection#

Toolbox for the ee.ImageCollection class.

Attributes#

EE_DATE_FORMAT

The javascript format to use to burn date object in GEE.

PY_DATE_FORMAT

The python format to use to parse dates coming from GEE.

Classes#

ImageCollectionAccessor

Initialize the ImageCollectionAccessor class.

Module Contents#

class ipygee.ee_image_collection.ImageCollectionAccessor(obj)[source]#

Initialize the ImageCollectionAccessor class.

Parameters:

obj (ee.ImageCollection)

plot_dates_by_bands(region, reducer='mean', dateProperty='system:time_start', bands=None, labels=None, colors=None, figure=None, scale=10000, crs=None, crsTransform=None, bestEffort=False, maxPixels=10**7, tileScale=1)[source]#

Plot the reduced data for each image in the collection by bands on a specific region.

This method is plotting the reduced data for each image in the collection by bands on a specific region.

Parameters:

  • region (ee.Geometry) – The region to reduce the data on.

  • reducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • dateProperty (str) – The property to use as date for each image. Default is "system:time_start".

  • bands (list[str] | None) – The bands to reduce. If empty, all bands are reduced.

  • labels (list[str] | None) – The labels to use for the bands. If empty, the bands names are used.

  • colors (list[str] | None) – The colors to use for the bands. If empty, the default colors are used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to plot the data on. If None, a new figure is created.

  • scale (int) – The scale in meters to use for the reduction. default is 10000m

  • crs (str | None) – The projection to work in. If unspecified, the projection of the image’s first band is used. If specified in addition to scale, rescaled to the specified scale.

  • crsTransform (list | None) – The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with ‘scale’, and replaces any transform already set on the projection.

  • bestEffort (bool) – If the polygon would contain too many pixels at the given scale, compute and use a larger scale which would allow the operation to succeed.

  • maxPixels (int | None) – The maximum number of pixels to reduce. Defaults to 1e7.

  • tileScale (float) – A scaling factor between 0.1 and 16 used to adjust aggregation tile size; setting a larger tileScale (e.g., 2 or 4) uses smaller tiles and may enable computations that run out of memory with the default.

Returns:

A bokeh figure with the reduced values for each band and each date.

Return type:

bokeh.plotting.figure

Examples

import ee, geetools

ee.Initialize()

collection = (
    ee.ImageCollection("LANDSAT/LC08/C01/T1_TOA")
    .filterBounds(ee.Geometry.Point(-122.262, 37.8719))
    .filterDate("2014-01-01", "2014-12-31")
)

region = ee.Geometry.Point(-122.262, 37.8719).buffer(10000)
collection.geetools.plot_dates_by_bands(region, "mean", 10000, "system:time_start")
plot_dates_by_regions(band, regions, label='system:index', reducer='mean', dateProperty='system:time_start', colors=None, figure=None, scale=10000, crs=None, crsTransform=None, tileScale=1)[source]#

Plot the reduced data for each image in the collection by regions for a single band.

This method is plotting the reduced data for each image in the collection by regions for a single band.

Parameters:

  • band (str) – The band to reduce.

  • regions (ee.FeatureCollection) – The regions to reduce the data on.

  • label (str) – The property to use as label for each region. Default is "system:index".

  • reducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • dateProperty (str) – The property to use as date for each image. Default is "system:time_start".

  • colors (list[str] | None) – The colors to use for the regions. If empty, the default colors are used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to plot the data on. If None, a new figure is created.

  • scale (int) – The scale in meters to use for the reduction. default is 10000m

  • crs (str | None) – The projection to work in. If unspecified, the projection of the image’s first band is used. If specified in addition to scale, rescaled to the specified scale.

  • crsTransform (list | None) – The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with ‘scale’, and replaces any transform already set on the projection.

  • tileScale (float) – A scaling factor between 0.1 and 16 used to adjust aggregation tile size; setting a larger tileScale (e.g., 2 or 4) uses smaller tiles and may enable computations that run out of memory with the default.

Returns:

A bokeh figure with the reduced values for each region and each date.

Return type:

bokeh.plotting.figure

Examples

import ee, geetools

ee.Initialize()

collection = (
    ee.ImageCollection("LANDSAT/LC08/C01/T1_TOA")
    .filterBounds(ee.Geometry.Point(-122.262, 37.8719))
    .filterDate("2014-01-01", "2014-12-31")
)

regions = ee.FeatureCollection([
    ee.Feature(ee.Geometry.Point(-122.262, 37.8719).buffer(10000), {"name": "region1"}),
    ee.Feature(ee.Geometry.Point(-122.262, 37.8719).buffer(20000), {"name": "region2"})
])

collection.geetools.plot_dates_by_regions("B1", regions, "name", "mean", 10000, "system:time_start")
plot_doy_by_bands(region, spatialReducer='mean', timeReducer='mean', dateProperty='system:time_start', bands=None, labels=None, colors=None, figure=None, scale=10000, crs=None, crsTransform=None, bestEffort=False, maxPixels=10**7, tileScale=1)[source]#

Plot the reduced data for each image in the collection by bands on a specific region.

This method is plotting the reduced data for each image in the collection by bands on a specific region.

Parameters:

  • region (ee.Geometry) – The region to reduce the data on.

  • spatialReducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • timeReducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • dateProperty (str) – The property to use as date for each image. Default is "system:time_start".

  • bands (list[str] | None) – The bands to reduce. If empty, all bands are reduced.

  • labels (list[str] | None) – The labels to use for the bands. If empty, the bands names are used.

  • colors (list[str] | None) – The colors to use for the bands. If empty, the default colors are used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to plot the data on. If None, a new figure is created.

  • scale (int) – The scale in meters to use for the reduction. default is 10000m

  • crs (str | None) – The projection to work in. If unspecified, the projection of the image’s first band is used. If specified in addition to scale, rescaled to the specified scale.

  • crsTransform (list | None) – The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with ‘scale’, and replaces any transform already set on the projection.

  • bestEffort (bool) – If the polygon would contain too many pixels at the given scale, compute and use a larger scale which would allow the operation to succeed.

  • maxPixels (int | None) – The maximum number of pixels to reduce. Defaults to 1e7.

  • tileScale (float) – A scaling factor between 0.1 and 16 used to adjust aggregation tile size; setting a larger tileScale (e.g., 2 or 4) uses smaller tiles and may enable computations that run out of memory with the default.

Returns:

A bokeh figure with the reduced values for each band and each day.

Return type:

bokeh.plotting.figure

Examples

import ee, geetools

ee.Initialize()

collection = (
    ee.ImageCollection("LANDSAT/LC08/C01/T1_TOA")
    .filterBounds(ee.Geometry.Point(-122.262, 37.8719))
    .filterDate("2014-01-01", "2014-12-31")
)

region = ee.Geometry.Point(-122.262, 37.8719).buffer(10000)
collection.geetools.plot_doy_by_bands(region, "mean", "mean", 10000, "system:time_start")
plot_doy_by_regions(band, regions, label='system:index', spatialReducer='mean', timeReducer='mean', dateProperty='system:time_start', colors=None, figure=None, scale=10000, crs=None, crsTransform=None, tileScale=1)[source]#

Plot the reduced data for each image in the collection by regions for a single band.

This method is plotting the reduced data for each image in the collection by regions for a single band.

Parameters:

  • band (str) – The band to reduce.

  • regions (ee.FeatureCollection) – The regions to reduce the data on.

  • label (str) – The property to use as label for each region. Default is "system:index".

  • spatialReducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • timeReducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • dateProperty (str) – The property to use as date for each image. Default is "system:time_start".

  • colors (list[str] | None) – The colors to use for the regions. If empty, the default colors are used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to plot the data on. If None, a new figure is created.

  • scale (int) – The scale in meters to use for the reduction. default is 10000m

  • crs (str | None) – The projection to work in. If unspecified, the projection of the image’s first band is used. If specified in addition to scale, rescaled to the specified scale.

  • crsTransform (list | None) – The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with ‘scale’, and replaces any transform already set on the projection.

  • tileScale (float) – A scaling factor between 0.1 and 16 used to adjust aggregation tile size; setting a larger tileScale (e.g., 2 or 4) uses smaller tiles and may enable computations that run out of memory with the default.

Returns:

A bokeh figure with the reduced values for each region and each day.

Return type:

bokeh.plotting.figure

Examples

import ee, geetools

ee.Initialize()

collection = (
    ee.ImageCollection("LANDSAT/LC08/C01/T1_TOA")
    .filterBounds(ee.Geometry.Point(-122.262, 37.8719))
    .filterDate("2014-01-01", "2014-12-31")
)

regions = ee.FeatureCollection([
    ee.Feature(ee.Geometry.Point(-122.262, 37.8719).buffer(10000), {"name": "region1"}),
    ee.Feature(ee.Geometry.Point(-122.262, 37.8719).buffer(20000), {"name": "region2"})
])

collection.geetools.plot_doy_by_regions("B1", regions, "name", "mean", "mean", 10000, "system:time_start")
plot_doy_by_seasons(band, region, seasonStart=1, seasonEnd=366, reducer='mean', dateProperty='system:time_start', colors=None, figure=None, scale=10000, crs=None, crsTransform=None, bestEffort=False, maxPixels=10**7, tileScale=1)[source]#

Plot the reduced data for each image in the collection by years for a single band.

This method is plotting the reduced data for each image in the collection by years for a single band. To set the start and end of the season, use the ee.Date.getRelative() or time.struct_time method to get the day of the year.

Parameters:

  • band (str) – The band to reduce.

  • region (ee.Geometry) – The region to reduce the data on.

  • seasonStart (int | ee.Number) – The day of the year that marks the start of the season.

  • seasonEnd (int | ee.Number) – The day of the year that marks the end of the season.

  • reducer (str | ee.Reducer) – The name of the reducer or a reducer object to use. Default is "mean".

  • dateProperty (str) – The property to use as date for each image. Default is "system:time_start".

  • colors (list[str] | None) – The colors to use for the regions. If empty, the default colors are used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to plot the data on. If None, a new figure is created.

  • scale (int) – The scale in meters to use for the reduction. default is 10000m

  • crs (str | None) – The projection to work in. If unspecified, the projection of the image’s first band is used. If specified in addition to scale, rescaled to the specified scale.

  • crsTransform (list | None) – The list of CRS transform values. This is a row-major ordering of the 3x2 transform matrix. This option is mutually exclusive with ‘scale’, and replaces any transform already set on the projection.

  • bestEffort (bool) – If the polygon would contain too many pixels at the given scale, compute and use a larger scale which would allow the operation to succeed.

  • maxPixels (int | None) – The maximum number of pixels to reduce. Defaults to 1e7.

  • tileScale (float) – A scaling factor between 0.1 and 16 used to adjust aggregation tile size; setting a larger tileScale (e.g., 2 or 4) uses smaller tiles and may enable computations that run out of memory with the default.

Returns:

A bokeh figure with the reduced values for each year and each day.

Return type:

bokeh.plotting.figure

Examples

_obj[source]#
ipygee.ee_image_collection.EE_DATE_FORMAT = "YYYY-MM-dd'T'HH-mm-ss"[source]#

The javascript format to use to burn date object in GEE.

ipygee.ee_image_collection.PY_DATE_FORMAT = '%Y-%m-%dT%H-%M-%S'[source]#

The python format to use to parse dates coming from GEE.