Alphabetical index for all classes

Map class methods

Map.addBasemap	Add a basemap layer to the map
Map.addLayer	Adds a new layer to a Map.
Map.addVideo	Add a video overlay layer to the map
Map.addWMS	Add a WMS layer to the map
Map.clear	Removes all layers of a Map object except the base layer.
Map.drawClose	Closes any interface that was opened with a call to Map.drawPolygons(), Map.drawPolylines() or Map.drawPoints().
Map.drawPolygons	Activates the interface for drawing polygons on the map.
Map.drawPolylines	Activates the interface for drawing polylines on the map.
Map.drawPoints	Activates the interface for drawing points on the map.
Map.getExtent	Returns the current boundary of the Map object.
Map.getFeatures	Returns a JSON string containing all the geometries and the attributes of the digitized feature.
Map.getGeojson	Returns a GEOJSON containing all the geometries and the attributes of the digitized feature.
Map.getLayerIds	Returns the IDs of the layers of the Map object.
Map.getLayerNames	Returns the names of the layers of the Map object.
Map.layersControl	Displays of hides the layers control on the map.
Map.measureControl	Displays of hides the measure control on the map.
Map.printAvailableBasemaps	Prints the list of all available basemaps.
Map.removeLayerByName	Remove a layer from the map given its name.
Map.replaceLayer	Replaces a layer on the map with a new procid.
Map.setAttributeValues	Sets the name and value of the attributes to associate to the next features digitized using a call to Map.drawPolygons(), Map.drawPolylines() or Map.drawPoints()
Map.split	Splits the map view in two parts visualizing a different layer on each of them.
Map.zoomToExtent	Sets the center and zoom of the Map.
Map.zoomToImageExtent	Zooms to the extent of an ImageProcess object.

ImageCollection class methods

ImageCollection.copyTo	Copies the content of an ImageCollection instance to another instance.
ImageCollection.count	Counts the number of images currently selected.
ImageCollection.distinct	Given in input a name of a metadata attribute, the distinct method returns a python list containing the distinct values of the attribute for all the selected images of the ImageCollection instance.
ImageCollection.expandToScenes	Sets or resets the flag that controls the expansion of selection to the entire scene.
ImageCollection.filterOn	Filters the ImageCollection on the values of a metadata attribute.
ImageCollection.filterOnDate	Filters the ImageCollection on the base of date range.
ImageCollection.filterOnDay	Filters the ImageCollection on the base of specific date.
ImageCollection.filterOnGeoName	Filters the ImageCollection on the intersection with the extents of a named location (as returned by the online service GeoNames).
ImageCollection.filterOnPoint	Filters the ImageCollection on the base of a geographic location.
ImageCollection.filterOnRect	Filters the ImageCollection on the base of a geographic rectangle.
ImageCollection.getAcquisitionDays	Returns the ordered list of all acquisition days of the selected images inside the collection.
ImageCollection.getCustom	Returns the JSON representation of the ImageCollection instance that can be used to create a custom collection using ImageCollection.setCustom() method.
ImageCollection.getDebug	Queries the current state of the Debug flag
ImageCollection.limit	Limits the number of results that the ImageCollection has to return.
ImageCollection.listImages	Given in input a name of a metadata attribute, the listImages method returns a python list containing the values of the attribute for all the selected images of the ImageCollection instance.
ImageCollection.distinct	Given in input a name of a metadata attribute, the distinct method returns a python list containing the distinct values of the attribute for all the selected images of the ImageCollection instance.
ImageCollection.printAttributes	Prints the list of all available metadata attributes for the ImageCollection.
ImageCollection.printBandNames	Prints the list of all available band names for the ImageCollection.
ImageCollection.printColorSchemes	Prints the list of of all available color schemes.
ImageCollection.printGeoNames	Queries the GeoNames service for geocoding: prints geonames found.
ImageCollection.printImages	Prints the values of the metadata attribute whose name is passed as argument for all the selected images of the collection.
ImageCollection.printNamedColors	Prints the list of named colors managed by the interactive visualization library.
ImageCollection.process	Creates an instance of ImageProcess from the collection.
ImageCollection.processMulti	Creates a multi-band instance of ImageProcess from the collection.
ImageCollection.removeOverlap	Sets or resets the flag that controls if the visualization system should try to remove images that overlap and that would not be visible because other images are displayed on top of them.
ImageCollection.setCustom	Changes the ImageCollection to become a ‘’CUSTOM’’ ImageCollection by setting all the internal members to the information read from the JSON string passed as argument.
ImageCollection.setDebug	Sets the Debug flag.
ImageCollection.sort	Defines how to sort images that are currently selected inside the image collection.

ImageProcess class methods

ImageProcess.addBand	Add a new band to an existing multi-band image.
ImageProcess.arith	Processing step that performs an arithmetic operation using as operand a scalar or another ImageProcess instance.
ImageProcess.band	Sets the processing chain to work on a single band.
ImageProcess.bands	Sets the processing chain to work on an RGB composition of three bands.
ImageProcess.bitwise	Processing step that performs a bitwise operation using as operand a second instance of an ImageProcess.
ImageProcess.blank	Processing step that sets all pixels to a specific value.
ImageProcess.blend	Combine operation that blends together two R,G,B images using alpha values to generate a composite image.
ImageProcess.BNDVI	Sets the processing chain to work on a derived band that calculates, for each pixel, the BNDVI index (Blue Normalized Difference Vegetation Index) defined as (NIR-BLUE)/(NIR+BLUE).
ImageProcess.classify	Supervised classification of a raster dataset.
ImageProcess.colorCustom	Defines a custom color scheme from a list of user defined colors.
ImageProcess.colorMap	Explicitly sets the colors for specific values of a single band image.
ImageProcess.colorScheme	Select one of the available color schemes to apply to a processing chain in order to convert values into colors used for display.
ImageProcess.copyTo	Copies the content of an ImageProcess instance to another instance.
ImageProcess.count	Sets the processing chain to work on a derived band that calculates, for each pixel, the total number of overlapping valid pixels inside the ImageCollection instance from which the ImageProcess object is created.
ImageProcess.dilate	Processing step that performs a dilate operation using a 3x3 structuring element.
ImageProcess.erode	Processing step that performs an erode operation using a 3x3 structuring element.
ImageProcess.execute	Processing step that executes a custom python function inside the server-side loop of the processing chain.
ImageProcess.exportCellsize	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method returns the cellsize (spatial resolution) in Google Mercator projection of the TIFF file that the ImageProcess.exportImage() will produce if called with the same input rectangle.
ImageProcess.exportImage	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method exports the processing chain to a georeferenced TIFF file.
ImageProcess.exportNumBytes	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method returns the number of bytes that the ImageProcess.exportImage() method will produce if called with the same input rectangle.
ImageProcess.exportPixelsX	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method returns the number of pixel in the X axis for the export as an image or a numpy array.
ImageProcess.exportPixelsY	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method returns the number of pixel in the Y axis for the export as an image or a numpy array.
ImageProcess.filter2d	Filter image in spatial domain performed on single or multi-band raster dataset.
ImageProcess.getCenterAndZoom	Returns the extents of the geographic area covered by the processing chain expressed in (lat,lon) center point and zoom level.
ImageProcess.getDegreeExtents	Returns the extents of the geographic area covered by the processing chain expressed in degrees (epsg = 4326).
ImageProcess.getGoogleExtents	Returns the extents of the geographic area covered by the processing chain expressed in coordinates in the Google Mercator reference system (epsg = 3857).
ImageProcess.getWindowSize	Returns the dimension in pixels of the area covered by a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level).
ImageProcess.GNDVI	Sets the processing chain to work on a derived band that calculates, for each pixel, the GNDVI index (Green Normalized Difference Vegetation Index) defined as (NIR-GREEN)/(NIR+GREEN).
ImageProcess.identifyPoint	Given in input a point in a specific SRS, the method returns a string containing the values read from the processing chain related to that geographic location.
ImageProcess.invmask	Processing step that performs an inverted masking by substituting NoData to all pixels that correspond to valid pixels in the ImageProcess instance passed as argument.
ImageProcess.isTileBased	Returns True if the processing chain can be queried in a tile-based mode from the server (display of the processing chain is done tile-by-tile using 256x256 tiles).
ImageProcess.labelAlphaCCs	Processing step that performs a constrained connectivity segmentation.
ImageProcess.mask	Processing step that performs a masking by substituting NoData to all pixels that correspond to pixel 0 or Nodata in the ImageProcess instance passed as argument.
ImageProcess.maskBW	Processing step that performs a masking by substituting NoData to all values that are inside the range defined by the two values passed as arguments.
ImageProcess.maskGT	Processing step that performs a masking by substituting NoData to all values that are greater than the value passed as argument.
ImageProcess.maskLT	Processing step that performs a masking by substituting NoData to all values that are lower than the value passed as argument.
ImageProcess.math	Processing step that performs a simple mathematical operation (sum, substract, multiply, divide, etc.) using as operand a scalar or another ImageProcess instance.
ImageProcess.max	Processing step that calculates the maximum vale for a multi-band combination.
ImageProcess.modulo	Processing step that performs a modulo operation: every pixel is substituted by the remainder after division by the Value passed as argument.
ImageProcess.multi	Global operator that builds a multi-band image by putting together one or more instances of ImageProcess class.
ImageProcess.NBR	Sets the processing chain to work on a derived band that calculates, for each pixel, the NBR index (Normalized Burn Ratio Index) defined as (NIR-SWIR2)/(NIR+SWIR2).
ImageProcess.NDSI	Sets the processing chain to work on a derived band that calculates, for each pixel, the NDSI index (Normalized Difference Salinity Index) defined as (SWIR1-SWIR2)/(SWIR1+SWIR2).
ImageProcess.NDSI2	Sets the processing chain to work on a derived band that calculates, for each pixel, the NDSI2 index (Normalized Difference Salinity Index 2) defined as (RED-NIR)/(RED+NIR).
ImageProcess.NDSII	Sets the processing chain to work on a derived band that calculates, for each pixel, the NDSII index (Normalized Difference Snow/Ice Index) defined as (GREEN-SWIR1)/(GREEN+SWIR1).
ImageProcess.NDVI	Sets the processing chain to work on a derived band that calculates, for each pixel, the NDVI index (Normalized Difference Vegetation Index) between near-infrared band and red band of the source images: (NIR-RED)/(NIR+RED).
ImageProcess.NDWI	Sets the processing chain to work on a derived band that calculates, for each pixel, the NDWI index (Normalized Difference Water Index) defined as (NIR-SWIR1)/(NIR+SWIR1).
ImageProcess.normalizedDifference	Sets the processing chain to work on a derived band that calculates, for each pixel, the normalized difference index between two bands of the source images.
ImageProcess.noscale	Disable the scaling operations so that the real image values are used to produce the visualization.
ImageProcess.numBands	Returns the number of bands selected for the instance of the processing chain using methods: band, bands, count, etc.
ImageProcess.opacity	Sets the opacity value to be used for the display of the processing chain as a layer into the Map instance.
ImageProcess.optimizeStats	Sets the flag that controls if an homogeneization of input data values should be applied before visualization of ImageCollections that contain more than one source image.
ImageProcess.parameter	Sets the value for a parameter of the ImageProcess object.
ImageProcess.printProcess	Prints to the output of the notebook a detailed description of the processing chain, showing data members for all types of ImageProcess.
ImageProcess.quicklooks	Sets the processing chain to display the quicklooks of the collection, if available.
ImageProcess.range	Processing step that performs a linear stretching from an input range to an output range.
ImageProcess.rgb	Global operator that builds an RGB image by putting together three instances of ImageProcess class.
ImageProcess.scale	Sets the scaling values to convert data from their original range to [0,255] before being visualized on the map.
ImageProcess.shift	Quick way to change the scaling ranges previously set to increase or decrease luminosity of the visualization.
ImageProcess.stats	Calculate and returns the statistics of the processing chain over the extent and zoom level passed as arguments.
ImageProcess.toLayer	Saves the ImageProcess object to the server side processing chain DB and returns a string containing the unique ID of the processing chain itself.

VectorLayer class methods

VectorLayer.all	Returns the list of all values for an attribute of layer given the layer name and the attribute name.
VectorLayer.attribtype	Returns the attribute type for an attribute of layer given the layer name and the attribute name.
VectorLayer.attribtypes	Returns the list of attribute types for a layer given the layer name.
VectorLayer.attributes	Returns the list of attribute names for a layer given the layer name.
VectorLayer.colorCustom	Defines a custom color scheme from a list of user defined colors.
VectorLayer.colorKeyName	Returns the name of the attribute that specifies symbol color for a layer given the layer name.
VectorLayer.colorScheme	Select one of the available color schemes to apply to the VectorLayer in order to convert values to display colors.
VectorLayer.copyTo	Copies the content of a VectorLayer instance to another instance.
VectorLayer.datasourcefile	Returns the datasource file path for a layer given the layer name.
VectorLayer.distinct	Returns the list of all distinct values for an attribute of layer given the layer name and the attribute name.
VectorLayer.featuresAdd	Adds a list of features to the VectorLayer instance.
VectorLayer.fileAdd	Adds all geometries read from a local file (a file uploaded inside the Jupyter manager) to the VectorLayer instance.
VectorLayer.geomAdd	Adds a custom geometry to the VectorLayer instance.
VectorLayer.geomAddEx	Adds a custom geometry to the VectorLayer instance.
VectorLayer.geomReset	Removes all custom geometries added with previous calls to VectorLayer.geomAdd(), VectorLayer.geomAddEx() or VectorLayer.fileAdd().
VectorLayer.geomtype	Returns the geometry type for a layer given the layer name.
VectorLayer.get	Returns the value of an attribute of a symbolizer.
VectorLayer.getDebug	Queries the current state of the Debug flag
VectorLayer.heatmap	Set the VectorLayer to display points in heatmap mode (Density mapping).
VectorLayer.identifyPoint	Given in input a point in a specific SRS, the method returns a string containing the values read from the VectorLayer instance in correspondance to that geographic location.
VectorLayer.layers	A VectorLayer object represents a vector dataset.
VectorLayer.joinAdd	Add a new join to a layer.
VectorLayer.joinExist	Returns True if a join having that name exists, False if not.
VectorLayer.joinRemove	Remove a join given its name.
VectorLayer.joinReset	Remove all the joins from a layer.
VectorLayer.legendCategories	Create a categorized legend (for all types attributes) having a different symbol for every distinct value of the attribute.
VectorLayer.legendGraduated	Create a graduated values legend: it can be applied only to numerical attributes.
VectorLayer.legendSet	Modifies the value of an attribute of a symbolizer to be applied to all items of a legend.
VectorLayer.legendSingle	Create a legend made up of a single symbol (all features of the layer are displayed with the same symbol).
VectorLayer.mainlayer	Among the layers of a vector dataset, the first one is considered the main layer.
VectorLayer.mainstyle	Any layer of a vector dataset can be displayed using one or more styles.
VectorLayer.numeric	Returns the list of all numeric values of an attribute of a layer given the layer name and the attribute name.
VectorLayer.opacity	Sets the opacity value to be used for the display of the VectorLayer as a layer into the Map instance.
VectorLayer.overlay	Overlays vector layer to an ImageProcess instance to calculate statistics (count, average, standard deviation, etc.) from pixels inside each of the geometries.
VectorLayer.parameter	Sets the value for a parameter of the VectorLayer object.
VectorLayer.printColorSchemes	Prints the list of of all available color schemes.
VectorLayer.printLayer	Prints to the output of the notebook a detailed description of the VectorLayer showing all data members of the instance.
VectorLayer.printNamedColors	Prints the list of named colors managed by the interactive visualization library.
VectorLayer.printXML	Prints the complete description of the VectorLayer in XML format.
VectorLayer.process	Creates an instance of ImageProcess from the vectorLayer.
VectorLayer.remove	Removes a rule from a style.
VectorLayer.reset	Resets all modifications done to the style rules.
VectorLayer.rules	Returns a list of names of rules present in a style.
VectorLayer.search	Search features of VectorLayer that satisfy a given query.
VectorLayer.set	Modifies the value of an attribute of a symbolizer.
VectorLayer.setDebug	Sets the Debug flag.
VectorLayer.srs	Returns SRS (Spatial Reference System) for a layer given the layer name.
VectorLayer.style	Returns the name of the first style of a layer.
VectorLayer.styles	Returns a list of names of styles present in the vector dataset.
VectorLayer.symbolizer	Returns the name of the standard symbolizer for a layer given the layer name.
VectorLayer.toLayer	Saves the VectorLayer object to the server side processing chain DB and returns a string containing the unique ID of the processing chain itself.

Video class methods

Video.__init__	Initialization of a Video instance
Video.addFrame	Add a frame to the video.
Video.close	Closes the output file and finalizes the video creation.
Video.getWidth	Returns the width of the video in pixels.
Video.getHeight	Returns the height of the video in pixels.
Video.overlayAddFile	Add a new image from a PNG file to overlay over the subsequent frames of the video
Video.overlayAddImage	Add a new image from a PIL (or Pillow) Image object to overlay over the subsequent frames of the video
Video.overlayReset	Resets the list of images to overlay to the frames of the video.
Video.setDelayInMilliseconds	Set the delay in milliseconds between the frames in case of output to GIF format.
Video.setFramesPerSecond	Set the number of frames to play for each second in case of output to MP4 or WEBM format.
Video.setExtentsAndZoom	Set the geographic extent and the zoom level of the area to save in the video.
Video.setMap	Set the geographic extent and the zoom level of the area to save in the video from the current viewport and zoon of a Map class instance

Inter global functions

Collection	Creates a collection (an ImageCollection in case of a raster dataset or a VectorLayer in case of a vector dataset) given the path descriptor of the collection.
collectionsSearch	Prints information on raster or vector data collections that match a search string
colorSchemaLegend	Calculates and returns the SVG string to display the legend of a ColorSchema.
exportArray	Exports a band of an instance of ImageProcess to a numpy array.
exportArrayEx	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method exports the processing chain imgProc to a numpy array.
exportImage	Exports an instance of ImageProcess to a georeferenced TIFF file.
exportImageEx	Given a rectangle (defined in (lat,lon) coordinates in EPSG 4326 and at a specific zoom level), the method exports the processing chain imgProc to a georeferenced TIFF file.
exportNumColumns	Given an instance of a Map object, the function calculates the number of columns that the export functions (exportImage(), exportArray() or exportTemporalGIF()) will produce as output.
exportNumRows	Given an instance of a Map object, the function calculates the number of rows that the export functions (exportImage(), exportArray() or exportTemporalGIF()) will produce as output.
exportTemporalGIF	Exports to an animated GIF file a sequence of frames obtained from an ImageCollection by displaying the images acquired in any single acquisition day.
exportTemporalVideo	Exports to a video file in MPEG4 or WEBM format a sequence of frames obtained from an ImageCollection by displaying the images acquired in any single acquisition day.
gui	Given a map, the function creates a graphical user interface to display complex dataset without the need to write lines of python code.
helpjeodpp	Displays inside the notebook the links to read the online documentation for the JEODPP Interactive Library.
identify	The functions allows users to graphically request the real values of a processing chain element added to a Map.
identifyNDVI	The functions is a version of the identify tailored for the NDVI dataset.
identifyPopup	Activates the identify on an ImageProcess or on a VectorLayer by directly displaying a popup on the map at the user click
legend	Displays the legend of a VectorLayer (see VectorLayer.legendSingle(), VectorLayer.legendCategories() or VectorLayer.legendGraduated()) inside the notebook.
listImageCollections	Prints the list of all available ImageCollection datasets with a brief description.
listVectorLayers	Prints the list of all available vector datasets with a brief description.
loadLocalRaster	Loads a local raster file (stored inside the special <home>/data folder ) to create an instance of a ImageProcess that can be added as a layer to a Map.
loadLocalVector	Loads a local vector file (stored inside the special <home>/data folder) to create an instance of a ImageProcess that can be added as a layer to a Map.
loadUserRaster	Loads a raster file (stored inside the special <home>/data folder of the user UserName) to create an instance of a ImageProcess that can be added as a layer to a Map.
s2explorer	Application made up using ipython widgets that can be used to browse, filter, sort and visualize Sentinel-2 images.
s2scl	Displays the legend of the Scene Classification for L2A products
saveShapefile	Save a list of features described in a JSON string to a file in shapefile format.
search	Search for a location by name (using online GeoNames service).
stats	Calculate and returns the statistics of an instance of ImageProcess class.
svg	Displays the svg string passed as argument.
temporalSlider	Creates a temporal slider to allow users to easily browse through all the acquisition days of an ImageCollection.
temporalSliderAnimate	Similarly to temporalSlider() functon, temporalSliderAnimate creates a temporal slider with some added buttons to automatically play/pause/restart the animation between the acquisition days of the images inside the input ImageCollection.
temporalSliderRange	Creates a temporal slider to allow users to easily select a range of acquisition days of an ImageCollection and display the resulting images on a Map.
testExecute	Helper function to test the syntactic correctness of python functions definition and call made by the processing step ImageProcess.execute().
UAlegend	Displays the legend for Urban Atlas dataset, showing colors and descriptions of all the classes for the 2006 or 2012 version.