diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 5150d4b..a38c2d6 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-20T10:54:36","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-01-11T16:10:22","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 3fcf56d..4f4dead 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,5 +1,5 @@ -Home · OpenEOClient.jl

OpenEOClient

Documentation for OpenEOClient.

Tutorial

Processing data on a openEO server requires authentication.

using OpenEOClient
+Home · OpenEOClient.jl
OpenEOClient
Documentation for OpenEOClient.
Tutorial
Processing data on a openEO server requires authentication.
using OpenEOClient
 username = ENV["OPENEO_USERNAME"]
 password = ENV["OPENEO_PASSWORD"]
 c = connect("earthengine.openeo.org", "v1.0", username, password)
@@ -52,4 +52,4 @@
   :log                   => Process("log", "Logarithm to a base", "Logarithm to the base `base` of the number `x` is defined to be t…
   :between               => Process("between", "Between comparison", "By default, this process checks whether `x` is greater than or…
   :mean                  => Process("mean", "Arithmetic mean (average)", "The arithmetic mean of an array of numbers is the quantity…
-  ⋮                      => ⋮
Reference
OpenEOClient.ProcessGraph — Type
Create a ProcessGraph using a user-defined Function
This is useful e.g. to create reducers to combine values of different bands in a customized way.
source

+  ⋮                      => ⋮

Reference

OpenEOClient.DataCube — Type

openEO n-dimensional array of ratser data represented by the process graph with root node call to create it. This process graph can be grown iterativeley by applying functions and operators to DataCube instances.

source
diff --git a/dev/out.zip b/dev/out.zip index e17f0e8..23d4f94 100644 Binary files a/dev/out.zip and b/dev/out.zip differ diff --git a/dev/search_index.js b/dev/search_index.js index 323fa75..c2759a7 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"","page":"Home","title":"Home","text":"CurrentModule = OpenEOClient","category":"page"},{"location":"#OpenEOClient","page":"Home","title":"OpenEOClient","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for OpenEOClient.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"#Tutorial","page":"Home","title":"Tutorial","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Processing data on a openEO server requires authentication.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using OpenEOClient\nusername = ENV[\"OPENEO_USERNAME\"]\npassword = ENV[\"OPENEO_PASSWORD\"]\nc = connect(\"earthengine.openeo.org\", \"v1.0\", username, password)\nstep1 = c.load_collection(\n \"COPERNICUS/S2\", BoundingBox(west=16.06, south=48.06, east=16.65, north=48.35),\n [\"2020-01-01\", \"2020-01-31\"], [\"B10\"]\n)\nstep2 = c.reduce_dimension(step1, ProcessGraph(\"median\"), \"t\", nothing)\nstep3 = c.save_result(step2, \"GTIFF-ZIP\", Dict())\npath = c.compute_result(step3)","category":"page"},{"location":"#Connect-to-Copernicus-Dataspace-using-OIDC","page":"Home","title":"Connect to Copernicus Dataspace using OIDC","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"The Copernicus Data Space Ecosystem provides free instant access to sentinel mission data using openEO. After registration, we can establish an connection using OID. The log-in process is performed at a given URL that must be visited in a browser. This can happen at any device and does not need to be at the server running the code:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c = connect(\"openeo.dataspace.copernicus.eu/openeo/\", \"1.2\", OpenEOClient.oidc_auth)\n┌ Info: Please log in using any device at:\n│ https://identity.dataspace.copernicus.eu/auth/realms/CDSE/device?user_code=ABCDE-FGHI\n└ Waiting until log in succeeded...\nopenEO ConnectionInstance\nauthorized openEO connection to https://openeo.dataspace.copernicus.eu/openeo//1.2\n8 collections\n132 processes","category":"page"},{"location":"","page":"Home","title":"Home","text":"Explore available collections:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c.collections","category":"page"},{"location":"","page":"Home","title":"Home","text":"8-element Vector{OpenEOClient.Collection}:\n SENTINEL3_OLCI_L1B: Sentinel 3 OLCI\n SENTINEL3_SLSTR: Sentinel 3 SLSTR\n SENTINEL_5P_L2: Sentinel 5 Precursor\n SENTINEL2_L1C: Sentinel-2 L1C\n SENTINEL2_L2A: Sentinel-2 L2A\n SENTINEL1_GRD: Sentinel-1 SAR GRD: C-band Synthetic Aperture Radar Ground Range Detected.\n COPERNICUS_30: Copernicus Global 30 meter Digital Elevation Model dataset.\n LANDSAT8_L2: Landsat 8 level 2 ARD, European Coverage","category":"page"},{"location":"","page":"Home","title":"Home","text":"Explore available processes:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c.processes","category":"page"},{"location":"","page":"Home","title":"Home","text":"Dict{Symbol, OpenEOClient.Process} with 132 entries:\n :sinh => Process(\"sinh\", \"Hyperbolic sine\", \"Computes the hyperbolic sine of `x`.\\n\\nWorks on radians only.\\nThe …\n :eq => Process(\"eq\", \"Equal to comparison\", \"Compares whether `x` is strictly equal to `y`.\\n\\n**Remarks:**\\n\\n…\n :sgn => Process(\"sgn\", \"Signum\", \"The signum (also known as *sign*) of `x` is defined as:\\n\\n* *1* if *x > 0*\\n*…\n :apply_kernel => Process(\"apply_kernel\", \"Apply a spatial convolution with a kernel\", \"Applies a 2D convolution (i.e. a f…\n :filter_labels => Process(\"filter_labels\", \"Filter dimension labels based on a condition\", \"Filters the dimension labels i…\n :rename_dimension => Process(\"rename_dimension\", \"Rename a dimension\", \"Renames a dimension in the data cube while preserving…\n :load_ml_model => Process(\"load_ml_model\", \"Load a ML model\", \"Loads a machine learning model from a STAC Item.\\n\\nSuch a …\n :drop_dimension => Process(\"drop_dimension\", \"Remove a dimension\", \"Drops a dimension from the data cube.\\n\\nDropping a dim…\n :is_valid => Process(\"is_valid\", \"Value is valid data\", \"Checks whether the specified value `x` is valid. The followi…\n :mod => Process(\"mod\", \"Modulo\", \"Remainder after a division of `x` by `y` for both integers and floating-point …\n :apply_neighborhood => Process(\"apply_neighborhood\", \"Apply a process to pixels in a n-dimensional neighborhood\", \"Applies a fo…\n :save_result => Process(\"save_result\", \"Save processed data\", \"Makes the processed data available in the given file form…\n :filter_spatial => Process(\"filter_spatial\", \"Spatial filter raster data cubes using geometries\", \"Limits the raster data c…\n :run_udf => Process(\"run_udf\", \"Run a UDF\", \"Runs a UDF in one of the supported runtime environments.\\n\\nThe process…\n :mask_scl_dilation => Process(\"mask_scl_dilation\", \"Mask clouds by dilating Sen2Cor sceneclassification\", \"Mask clouds by dila…\n :date_between => Process(\"date_between\", \"Between comparison for dates and times\", \"By default, this process checks wheth…\n :count => Process(\"count\", \"Count the number of elements\", \"Gives the number of elements in an array that matches …\n :arctan2 => Process(\"arctan2\", \"Inverse tangent of two numbers\", \"Computes the arc tangent of two numbers `x` and `y…\n :exp => Process(\"exp\", \"Exponentiation to the base e\", \"Exponential function to the base *e* raised to the power…\n :tanh => Process(\"tanh\", \"Hyperbolic tangent\", \"Computes the hyperbolic tangent of `x`. The tangent is defined to…\n :floor => Process(\"floor\", \"Round fractions down\", \"The greatest integer less than or equal to the number `x`.\\n\\n…\n :apply_dimension => Process(\"apply_dimension\", \"Apply a process to all values along a dimension\", \"Applies a process to all …\n :normalized_difference => Process(\"normalized_difference\", \"Normalized difference\", \"Computes the normalized difference for two ba…\n :all => Process(\"all\", \"Are all of the values true?\", \"Checks if **all** of the values in `data` are true. If no…\n :log => Process(\"log\", \"Logarithm to a base\", \"Logarithm to the base `base` of the number `x` is defined to be t…\n :between => Process(\"between\", \"Between comparison\", \"By default, this process checks whether `x` is greater than or…\n :mean => Process(\"mean\", \"Arithmetic mean (average)\", \"The arithmetic mean of an array of numbers is the quantity…\n ⋮ => ⋮","category":"page"},{"location":"#Reference","page":"Home","title":"Reference","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Modules = [OpenEOClient]","category":"page"},{"location":"#OpenEOClient.AuthorizedConnection-NTuple{4, Any}","page":"Home","title":"OpenEOClient.AuthorizedConnection","text":"HTTP basic authentification\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.AuthorizedConnection-Tuple{Any, Any}","page":"Home","title":"OpenEOClient.AuthorizedConnection","text":"OpenID Connect device flow + PKCE authentification\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.ProcessGraph","page":"Home","title":"OpenEOClient.ProcessGraph","text":"Create a ProcessGraph to reduce dimesnions\n\n\n\n\n\n","category":"type"},{"location":"#OpenEOClient.ProcessGraph-2","page":"Home","title":"OpenEOClient.ProcessGraph","text":"Create a ProcessGraph using a user-defined Function\n\nThis is useful e.g. to create reducers to combine values of different bands in a customized way.\n\n\n\n\n\n","category":"type"},{"location":"#OpenEOClient.compute_result","page":"Home","title":"OpenEOClient.compute_result","text":"Process and download data synchronously\n\n\n\n\n\n","category":"function"},{"location":"#OpenEOClient.describe_collection-Tuple{OpenEOClient.AbstractConnection, String}","page":"Home","title":"OpenEOClient.describe_collection","text":"Lists all information about a specific collection specified by the identifier \n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.get_acces_token-Tuple{String, String, AbstractVector}","page":"Home","title":"OpenEOClient.get_acces_token","text":"OpenID Connect device flow + PKCE\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_collections-Tuple{OpenEOClient.AbstractConnection}","page":"Home","title":"OpenEOClient.list_collections","text":"Lists available collections with at least the required information.\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_jobs-Tuple{OpenEOClient.AuthorizedConnection}","page":"Home","title":"OpenEOClient.list_jobs","text":"Lists all batch jobs submitted by a user.\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_processes-Tuple{OpenEOClient.AbstractConnection}","page":"Home","title":"OpenEOClient.list_processes","text":"Lists all predefined processes and returns detailed process descriptions, including parameters and return values.\n\n\n\n\n\n","category":"method"}] +[{"location":"","page":"Home","title":"Home","text":"CurrentModule = OpenEOClient","category":"page"},{"location":"#OpenEOClient","page":"Home","title":"OpenEOClient","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for OpenEOClient.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"#Tutorial","page":"Home","title":"Tutorial","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Processing data on a openEO server requires authentication.","category":"page"},{"location":"","page":"Home","title":"Home","text":"using OpenEOClient\nusername = ENV[\"OPENEO_USERNAME\"]\npassword = ENV[\"OPENEO_PASSWORD\"]\nc = connect(\"earthengine.openeo.org\", \"v1.0\", username, password)\nstep1 = c.load_collection(\n \"COPERNICUS/S2\", BoundingBox(west=16.06, south=48.06, east=16.65, north=48.35),\n [\"2020-01-01\", \"2020-01-31\"], [\"B10\"]\n)\nstep2 = c.reduce_dimension(step1, ProcessGraph(\"median\"), \"t\", nothing)\nstep3 = c.save_result(step2, \"GTIFF-ZIP\", Dict())\npath = c.compute_result(step3)","category":"page"},{"location":"#Connect-to-Copernicus-Dataspace-using-OIDC","page":"Home","title":"Connect to Copernicus Dataspace using OIDC","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"The Copernicus Data Space Ecosystem provides free instant access to sentinel mission data using openEO. After registration, we can establish an connection using OID. The log-in process is performed at a given URL that must be visited in a browser. This can happen at any device and does not need to be at the server running the code:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c = connect(\"openeo.dataspace.copernicus.eu/openeo/\", \"1.2\", OpenEOClient.oidc_auth)\n┌ Info: Please log in using any device at:\n│ https://identity.dataspace.copernicus.eu/auth/realms/CDSE/device?user_code=ABCDE-FGHI\n└ Waiting until log in succeeded...\nopenEO ConnectionInstance\nauthorized openEO connection to https://openeo.dataspace.copernicus.eu/openeo//1.2\n8 collections\n132 processes","category":"page"},{"location":"","page":"Home","title":"Home","text":"Explore available collections:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c.collections","category":"page"},{"location":"","page":"Home","title":"Home","text":"8-element Vector{OpenEOClient.Collection}:\n SENTINEL3_OLCI_L1B: Sentinel 3 OLCI\n SENTINEL3_SLSTR: Sentinel 3 SLSTR\n SENTINEL_5P_L2: Sentinel 5 Precursor\n SENTINEL2_L1C: Sentinel-2 L1C\n SENTINEL2_L2A: Sentinel-2 L2A\n SENTINEL1_GRD: Sentinel-1 SAR GRD: C-band Synthetic Aperture Radar Ground Range Detected.\n COPERNICUS_30: Copernicus Global 30 meter Digital Elevation Model dataset.\n LANDSAT8_L2: Landsat 8 level 2 ARD, European Coverage","category":"page"},{"location":"","page":"Home","title":"Home","text":"Explore available processes:","category":"page"},{"location":"","page":"Home","title":"Home","text":"c.processes","category":"page"},{"location":"","page":"Home","title":"Home","text":"Dict{Symbol, OpenEOClient.Process} with 132 entries:\n :sinh => Process(\"sinh\", \"Hyperbolic sine\", \"Computes the hyperbolic sine of `x`.\\n\\nWorks on radians only.\\nThe …\n :eq => Process(\"eq\", \"Equal to comparison\", \"Compares whether `x` is strictly equal to `y`.\\n\\n**Remarks:**\\n\\n…\n :sgn => Process(\"sgn\", \"Signum\", \"The signum (also known as *sign*) of `x` is defined as:\\n\\n* *1* if *x > 0*\\n*…\n :apply_kernel => Process(\"apply_kernel\", \"Apply a spatial convolution with a kernel\", \"Applies a 2D convolution (i.e. a f…\n :filter_labels => Process(\"filter_labels\", \"Filter dimension labels based on a condition\", \"Filters the dimension labels i…\n :rename_dimension => Process(\"rename_dimension\", \"Rename a dimension\", \"Renames a dimension in the data cube while preserving…\n :load_ml_model => Process(\"load_ml_model\", \"Load a ML model\", \"Loads a machine learning model from a STAC Item.\\n\\nSuch a …\n :drop_dimension => Process(\"drop_dimension\", \"Remove a dimension\", \"Drops a dimension from the data cube.\\n\\nDropping a dim…\n :is_valid => Process(\"is_valid\", \"Value is valid data\", \"Checks whether the specified value `x` is valid. The followi…\n :mod => Process(\"mod\", \"Modulo\", \"Remainder after a division of `x` by `y` for both integers and floating-point …\n :apply_neighborhood => Process(\"apply_neighborhood\", \"Apply a process to pixels in a n-dimensional neighborhood\", \"Applies a fo…\n :save_result => Process(\"save_result\", \"Save processed data\", \"Makes the processed data available in the given file form…\n :filter_spatial => Process(\"filter_spatial\", \"Spatial filter raster data cubes using geometries\", \"Limits the raster data c…\n :run_udf => Process(\"run_udf\", \"Run a UDF\", \"Runs a UDF in one of the supported runtime environments.\\n\\nThe process…\n :mask_scl_dilation => Process(\"mask_scl_dilation\", \"Mask clouds by dilating Sen2Cor sceneclassification\", \"Mask clouds by dila…\n :date_between => Process(\"date_between\", \"Between comparison for dates and times\", \"By default, this process checks wheth…\n :count => Process(\"count\", \"Count the number of elements\", \"Gives the number of elements in an array that matches …\n :arctan2 => Process(\"arctan2\", \"Inverse tangent of two numbers\", \"Computes the arc tangent of two numbers `x` and `y…\n :exp => Process(\"exp\", \"Exponentiation to the base e\", \"Exponential function to the base *e* raised to the power…\n :tanh => Process(\"tanh\", \"Hyperbolic tangent\", \"Computes the hyperbolic tangent of `x`. The tangent is defined to…\n :floor => Process(\"floor\", \"Round fractions down\", \"The greatest integer less than or equal to the number `x`.\\n\\n…\n :apply_dimension => Process(\"apply_dimension\", \"Apply a process to all values along a dimension\", \"Applies a process to all …\n :normalized_difference => Process(\"normalized_difference\", \"Normalized difference\", \"Computes the normalized difference for two ba…\n :all => Process(\"all\", \"Are all of the values true?\", \"Checks if **all** of the values in `data` are true. If no…\n :log => Process(\"log\", \"Logarithm to a base\", \"Logarithm to the base `base` of the number `x` is defined to be t…\n :between => Process(\"between\", \"Between comparison\", \"By default, this process checks whether `x` is greater than or…\n :mean => Process(\"mean\", \"Arithmetic mean (average)\", \"The arithmetic mean of an array of numbers is the quantity…\n ⋮ => ⋮","category":"page"},{"location":"#Reference","page":"Home","title":"Reference","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Modules = [OpenEOClient]","category":"page"},{"location":"#OpenEOClient.AuthorizedCredentials-NTuple{4, Any}","page":"Home","title":"OpenEOClient.AuthorizedCredentials","text":"HTTP basic authentification\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.AuthorizedCredentials-Tuple{Any, Any}","page":"Home","title":"OpenEOClient.AuthorizedCredentials","text":"OpenID Connect device flow + PKCE authentification\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.DataCube","page":"Home","title":"OpenEOClient.DataCube","text":"openEO n-dimensional array of ratser data represented by the process graph with root node call to create it. This process graph can be grown iterativeley by applying functions and operators to DataCube instances.\n\n\n\n\n\n","category":"type"},{"location":"#OpenEOClient.ProcessGraph","page":"Home","title":"OpenEOClient.ProcessGraph","text":"Create a ProcessGraph to reduce dimesnions\n\n\n\n\n\n","category":"type"},{"location":"#OpenEOClient.compute_result","page":"Home","title":"OpenEOClient.compute_result","text":"Process and download data synchronously\n\n\n\n\n\n","category":"function"},{"location":"#OpenEOClient.describe_collection-Tuple{OpenEOClient.AbstractCredentials, String}","page":"Home","title":"OpenEOClient.describe_collection","text":"Lists all information about a specific collection specified by the identifier \n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.get_acces_token-Tuple{String, String, AbstractVector}","page":"Home","title":"OpenEOClient.get_acces_token","text":"OpenID Connect device flow + PKCE\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_collections-Tuple{OpenEOClient.AbstractCredentials}","page":"Home","title":"OpenEOClient.list_collections","text":"Lists available collections with at least the required information.\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_jobs-Tuple{OpenEOClient.AuthorizedCredentials}","page":"Home","title":"OpenEOClient.list_jobs","text":"Lists all batch jobs submitted by a user.\n\n\n\n\n\n","category":"method"},{"location":"#OpenEOClient.list_processes-Tuple{OpenEOClient.AbstractCredentials}","page":"Home","title":"OpenEOClient.list_processes","text":"Lists all predefined processes and returns detailed process descriptions, including parameters and return values.\n\n\n\n\n\n","category":"method"}] }