Octave WasdiLib

Methods

startWasdi

matlabwasdilib.startWasdi(config_path)

find out what the library path is:

wAddFileToWASDI

matlabwasdilib.wAddFileToWASDI(Wasdi, sFileName)

Ingest a new file in the Active WASDI Workspace waiting for the result The method takes a file saved in the workspace root (see getSaveFilePath) not already added to the WS o work be sure that the file is on the server Syntax sStatus =wAddFileToWASDI(Wasdi, sFileName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – Name of the file to add

Returns
sStatus

Status of the Ingest Process as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wAddParam

matlabwasdilib.wAddParam(Wasdi, sKey, sValue)

Adds a parameter to current processor Syntax wAddParam(Wasdi, sKey, sValue)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sKey – a string to be used as key for the param

  • sValue – a string to be used as a value

wAsynchAddFileToWASDI

matlabwasdilib.wAsynchAddFileToWASDI(Wasdi, sFileName)

Ingest a new file in the Active WASDI Workspace WITHOUT waiting for the result The method takes a file saved in the workspace root (see getSaveFilePath) not already added to the WS If the file is not present in the WASDI cloud workpsace, it will be automatically uploaded if the config AUTOUPLOAD flag is true (default) Syntax sStatus =wAsynchAddFileToWASDI(Wasdi, sFileName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – Name of the file to add

Returns
sProcessId

Process Id of the WASDI Ingest operation on the server. Can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wAsynchCopyFileToSftp

matlabwasdilib.wAsynchCopyFileToSftp(Wasdi, sFileName, sRelativePath)

Copy file to SFTP folder, asynchronous version Syntax wAsynchCopyFileToSftp(Wasdi, sFileName, sRelativePath)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – a string containing the file name

  • sRelativePath – a string containinng the relative path

wAsynchExecuteProcessor

matlabwasdilib.wAsynchExecuteProcessor(Wasdi, sProcessorName, asParams)

Execute a WASDI processor asynchronously Syntax sStatus=wAsynchExecuteProcessor(Wasdi, sProcessorName, asParams)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessorName – Processor Name

  • asParams – Processor parameters, as a key/value dictionary

Returns
sProcessId

process workspace id. It can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wAsynchExecuteWorkflow

matlabwasdilib.wAsynchExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles)

Executes a SNAP workflow in Asynch mode. The workflow has to be uploaded in WASDI: it can be public or private of a user. If it is private, it must be triggered from the owner. Syntax sProcessId = wExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkflow – Name of the workflow

  • asInputFiles – array of strings with the name of the input files. Must be one file for each Read Node of the workflow, in the exact order

  • asOutputFiles – array of strings with the name of the output files. Must be one file for each Write Node of the workflow, in the exact order

Returns
sProcessId

Id of the process representing the Workflow execution. Can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wAsynchImportProduct

matlabwasdilib.wAsynchImportProduct(Wasdi, sProductLink, sName, sBoundingBox='', sProvider='AUTO')

Import an EO Image in WASDI. This is the asynchronous version Syntax sStatus=wImportProduct(Wasdi, sProductLink, sName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProductLink – Product Direct Link as returned by wSearchEOImage

  • sName – Product Name as returned by wSearchEOImage

  • sBoundingBox – product bounding box, optional

  • sProvider – data provider, optional

Returns
param sProcessObjId

Identifier of the import process

wAsynchImportProductList

matlabwasdilib.wAsynchImportProductList(Wasdi, asProductLinks, asProductNames)

Import an EO Image in WASDI. This is the asynchronous version Syntax sProcessObjId=wAsynchImportProductList(Wasdi, asProductLinks, asProductNames)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • asProductLinks – collection of Product Direct Link as returned by wSearchEOImage

  • asProductNames – collection of Product Names as returned by wSearchEOImage

Returns
param asStatuses

list of statuses of the import processes

wAsynchMosaic

matlabwasdilib.wAsynchMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue)

Mosaic input images in the output file Syntax sProcessId=wAsynchMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • asInputFileNames – Array of input file names

  • sOutputFile – Name of the output file

  • sNoDataValue – value to use as no data in the output file

  • sInputIgnoreValue – value used as no data in the input file

Returns
sProcessId

Id of the mosaic process on WASDI. Can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wAsynchMultiSubset

matlabwasdilib.wAsynchMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE)

Extracts subsets of an image given its name and the desired bounding boxes.Asynchronous version Syntax sReturn=wAsynchMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sInputFile – the input file from where subsets must be extracted

  • asOutputFiles – names to be given to output files

  • adLatN – a collection of Northernmost latitudes

  • adLonW – a collection of Westernmost longitudes

  • adLatS – a collection of Southernmost latitudes

  • adLonE – a collection of Easternnmost longitudes

wCopyFileToSftp

matlabwasdilib.wCopyFileToSftp(Wasdi, sFileName, sRelativePath)

Copy file to SFTP folder, synchronous version Syntax wCopyFileToSftp(Wasdi, sFileName, sRelativePath)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – a string containing the file name

  • sRelativePath – a string containinng the relative path

Returns

sProcessId

process workspace id. It can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wCreateWorkspace

matlabwasdilib.wCreateWorkspace(Wasdi, sWorkspaceName, sNodeCode='')

Copy file to SFTP folder, asynchronous version Syntax wCreateWorkspace(Wasdi, sWorkspaceName, sNodeCode)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – the name of the workspace

  • sNodeCode – the code of the node, optional

Returns
sWorkspaceId

the ID of the workspace (empty in case of error)

wDeleteProduct

matlabwasdilib.wDeleteProduct(Wasdi, sProductName)

Deletes a product in active workspace Syntax sStatus = wDeleteProduct(Wasdi, sProductName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – Name of the file to add

Returns
sStatus

empty string if deletion was successful, null in case it did not work

wDeleteWorkspace

matlabwasdilib.wDeleteWorkspace(Wasdi, sWorkspaceName)

Deletes a workspace. If the user is not the workspace owner, then just the sharing is deleted Syntax sStatus = wDeleteProduct(Wasdi, sWorkspaceName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – the name of the workspace to be deleted

Returns
sStatus

empty string if deletion was successful, null in case it did not work

wExecuteProcessor

matlabwasdilib.wExecuteProcessor(Wasdi, sProcessorName, asParams)

Execute a WASDI processor asynchronously Syntax sStatus=wExecuteProcessor(Wasdi, sProcessorName, asParams)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessorName – Processor Name

  • asParams – Processor parameters, as a key/value dictionary

Returns
sProcessId

process workspace id. It can be used as input to the wWaitProcess method or wGetProcessStatus methods to check the execution.

wExecuteWorkflow

matlabwasdilib.wExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles)

Executes a SNAP workflow. The workflow has to be uploaded in WASDI: it can be public or private of a user. If it is private, it must be triggered from the owner. Syntax sStatus = wExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkflow – Name of the workflow

  • asInputFiles – array of strings with the name of the input files. Must be one file for each Read Node of the workflow, in the exact order

  • asOutputFiles – array of strings with the name of the output files. Must be one file for each Write Node of the workflow, in the exact order

Returns
sStatus

Exit Workflow Process Status as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wGetActiveWorkspace

matlabwasdilib.wGetActiveWorkspace(Wasdi)

Gets the active workspace ID Syntax sWorkspaceId = wGetActiveWorkspace(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sWorkspaceId

the ID of active WASDI workspace

wGetBasePath

matlabwasdilib.wGetBasePath(Wasdi)

Gets the base path Syntax sBasePath = wGetBasePath(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sBasePath

the base path in use

wGetBaseUrl

matlabwasdilib.wGetBaseUrl(Wasdi)

Gets the base URL Syntax sBasePath = wGetBaseUrl(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sBaseUrl

the base URL for WASDI

wGetDownloadActive

matlabwasdilib.wGetDownloadActive(Wasdi)

Gets whether download is active or not Syntax bDownloadActive = wGetDownloadActive(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
bDownloadActive

true if download is active, false otherwise

wGetFullProductPath

matlabwasdilib.wGetFullProductPath(Wasdi, sFileName)

Get the full local path of a product. If it is not present on the local PC and DownloadActive flag is true the product will be downloaded Syntax sFullPath =wGetFullProductPath(Wasdi, sFileName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sFileName – Name of the file

Returns
sFullPath

full local path

wGetMyProcId

matlabwasdilib.wGetMyProcId(Wasdi)

Gets own processor ID Syntax sProcId = wGetProcessorPayloadAsJSON(Wasdi, sProcessObjId)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sProcId

own processor ID

wGetParameter

matlabwasdilib.wGetParameter(Wasdi, sKey)

Get the value of a parameter identified by sKey in the parameters file Syntax sParameter = wGetParameter(Wasdi, sKey)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sKey – The KEY of the parameter in the paramteres file

Returns
sParameter

The value of the parameter. If it does not exists the function returns “”

wGetParametersFilePath

matlabwasdilib.wGetParametersFilePath(Wasdi)

Gets the parameters file path Syntax sParametersFilePath = wGetParametersFilPath(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sParametersFilePath

the path to the parameters file

wGetParams

matlabwasdilib.wGetParams(Wasdi)

Gets processor parameters Syntax asParams = wGetParams(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
asParams

a map containing the parameters

wGetPassword

matlabwasdilib.wGetPassword(Wasdi)

Gets the password Syntax sPassword = wGetPassword(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sPassword

WASDI user’s password

wGetPath

matlabwasdilib.wGetPath(Wasdi, sFileName)

Gets the path of given product Syntax sPath = wGetPath(Wasdi, sFileName)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sPath

wasdi local path for given product

wGetProcessStatus

matlabwasdilib.wGetProcessStatus(Wasdi, sProcessId)

Get the status of a Process Syntax sStatus =wGetProcessStatus(Wasdi, sProcessId);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessId – Id of the process to query

Returns
sStatus

Process Status as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wGetProcessesByWorkspace

matlabwasdilib.wGetProcessesByWorkspace(Wasdi, iStartIndex=0, iEndIndex=, []sStatus=, []sOperationType=, []sNamePattern=[])

Get a paginated list of processes in the active workspace Syntax asProcesses=wgetProcessesByWorkspace(Wasdi, iStartIndex, iEndIndex=[], sStatus=[], sOperationType=[], sNamePattern=[]?)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • iStartIndex – first index

  • iEndIndex – last index

  • sStatus – filter by statuses

  • sOperationType – filter by operation name

  • sNamePattern – filter by name

Returns
asProcesses

list of processes

wGetProcessorPath

matlabwasdilib.wGetProcessorPath(Wasdi)

Gets the parameters file path Syntax sProcessorPath = wGetProcessorPath(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sProcessorPath

the path to current processor

wGetProcessorPayload

matlabwasdilib.wGetProcessorPayload(Wasdi, sProcessObjId)

Gets the payload of given processor Syntax oProcessPayload = wGetProcessorPayload(Wasdi, sProcessObjId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessObjId – process ID for which the payload must be retrieve

Returns
oProcessPayload

an object containing the payload

wGetProcessorPayloadAsJSON

matlabwasdilib.wGetProcessorPayloadAsJSON(Wasdi, sProcessObjId)

Gets the payload of given processor as a JSON string Syntax sProcessPayload = wGetProcessorPayloadAsJSON(Wasdi, sProcessObjId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessObjId – process ID for which the payload must be retrieve

Returns
sProcessPayload

a JSON formatted string containing the payload

wGetProductBbox

matlabwasdilib.wGetProductBbox(Wasdi, sProductName)

Gets own processor ID Syntax sProcId = wGetProductBbox(Wasdi, sProductName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProductName – the product name for which the bounding box must be retrieved

Returns
sBbox

the requested bounding box

wGetProductsByActiveWorkspace

matlabwasdilib.wGetProductsByActiveWorkspace(Wasdi)

Get the List of Products in the active Workspace Syntax asProducts=wGetProductsByActiveWorkspace(Wasdi);

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
asProducts

array of strings that are the names of the products

wGetProductsByWorkspace

matlabwasdilib.wGetProductsByWorkspace(Wasdi, sWorkspaceName)

Get the List of Products in a Workspace Syntax asProducts=wGetProductsByWorkspace(Wasdi, sWorkspaceName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – name of the workspace

Returns
asProducts

array of strings that are the names of the products

wGetSavePath

matlabwasdilib.wGetSavePath(Wasdi)

Get the full local path where to save a product in the active workspace Syntax sSavePath =wGetSavePath(Wasdi);

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sSavePath

the local path to use to save the file, including last /

wGetSessionId

matlabwasdilib.wGetSessionId(Wasdi)

Get the session ID Syntax sSessionId = wGetSessionId(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sSessionId

the current session

wGetUploadActive

matlabwasdilib.wGetUploadActive(Wasdi)

Gets whether Upload is active or not Syntax bUploadActive = wGetUploadActive(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
bUploadActive

true if Upload is active, false otherwise

wGetUser

matlabwasdilib.wGetUser(Wasdi)

Gets the user Syntax sUser = wGetUser(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sUser

the username on wasdi

wGetVerbose

matlabwasdilib.wGetVerbose(Wasdi)

Gets verbosity flag Syntax bVerbose = wGetVerbose(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
bVerbose

verbosity flag

wGetWorkflows

matlabwasdilib.wGetWorkflows(Wasdi)

Get the List of Workflows of the actual User Syntax [asWorkflowNames, asWorkflowIds]=wGetWorkflows(Wasdi);

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
asWorkflowNames

array of strings that are the names of the workflows

asWorkflowIds

array of strings that are the id of the workflows

wGetWorkspaceBaseUrl

matlabwasdilib.wGetWorkspaceBaseUrl(Wasdi)

Gets the workspace base URL Syntax sWorkspaceBaseUrl = wGetWorkspaceBaseUrl(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sWorkspaceBaseUrl

the base URL for active workspace

wGetWorkspaceIdByName

matlabwasdilib.wGetWorkspaceIdByName(Wasdi, sWorkspaceName)

Get the Id of a Workspace from the name Syntax sWorkspaceId=wGetWorkspaceIdByName(Wasdi, sWorkspaceName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – Name of the workspace

Returns
sWorkspaceId

id of the workspace

wGetWorkspaceOwnerByName

matlabwasdilib.wGetWorkspaceOwnerByName(Wasdi, sWorkspaceName)

Gets the owner of the workspace given its name Syntax sWorkspaceOwner = wGetWorkspaceOwnerByName(Wasdi, sWorkspaceName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – the name of the workspace

Returns
sWorkspaceOwner

the owner of the workspace

wGetWorkspaceUrlByWsId

matlabwasdilib.wGetWorkspaceUrlByWsId(Wasdi, sWorkspaceId)

Gets the workspace URL given its ID Syntax: sWorkspaceUrl = wGetWorkspaceUrlByWsId(Wasdi, sWorkspaceId)

Parameters

Wasdi – Wasdi object created after the wasdilib call

Returns
sBaseUrl

the base URL for WASDI

wGetWorkspaces

matlabwasdilib.wGetWorkspaces(Wasdi)

wImportAndPreprocess

matlabwasdilib.wImportAndPreprocess(Wasdi, asProductLinks, asProductNames, sWorkflowName, sSuffix, sProvider=[])

Import and preprocess a collection of EO products Syntax wImportAndPreprocess(Wasdi, asProductLinks, asProductNames, sWorkflowName, sSuffix)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • asProductLinks – collection of Product Direct Link as returned by wSearchEOImages

  • asProductNames – collection of Product names, as returned by wSearchEOImages

  • sWorkflowName – the name of the SNAP workflow to be applied to downloaded imagesc

  • sSuffix – the suffix to append to the preprocessed files

  • sProvider – optional, the provider from where data must be collected

wImportProduct

matlabwasdilib.wImportProduct(Wasdi, sProductLink, sProductName, sBoundingBox='', sProvider='AUTO')

Import an EO Image in WASDI Syntax sStatus=wImportProduct(Wasdi, sProductLink, sProductName)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProductLink – Product Direct Link as returned by wSearchEOImage

  • sProductName – Product Name as returned by wSearchEOImage

  • sBoundingBox – product bounding box, optional

  • sProvider – data provider, optional

Returns
sProcessObjId

Identifier of the import process

wImportProductList

matlabwasdilib.wImportProductList(Wasdi, asProductLinks, asProductNames)

Import an EO Image in WASDI. This is the asynchronous version Syntax sProcessObjId=wAsynchImportProductList(Wasdi, asProductLinks, asProductNames)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • asProductLinks – collection of Product Direct Link as returned by wSearchEOImage

  • asProductNames – collection of Product Names as returned by wSearchEOImage

Returns
asStatuses

list of statuses of the import processes

wLog

matlabwasdilib.wLog(Wasdi, sLogRow)

Add a row to the application logs. Locally, just print on the console if VERBOSE. On the server, it logs on the WASDI interface. Syntax wLog(Wasdi, sLogRow)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sLogRow – Text to log

wMosaic

matlabwasdilib.wMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue)

Mosaic input images in the output file Syntax sStatus=wMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue)

Parameters

Wasdi – Wasdi object created after the wasdilib call asInputFileNames: Array of input file names sOutputFile: Name of the output file sNoDataValue: value to use as no data in the output file sInputIgnoreValue: value used as no data in the input file

Returns
sStatus

end status of the mosaic operation

wMultiSubset

matlabwasdilib.wMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE)

Extracts subsets of an image given its name and the desired bounding boxes Syntax sReturn=wMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sInputFile – the input file from where subsets must be extracted

  • asOutputFiles – names to be given to output files

  • adLatN – a collection of Northernmost latitudes

  • adLonW – a collection of Westernmost longitudes

  • adLatS – a collection of Southernmost latitudes

  • adLonE – a collection of Easternnmost longitudes

wOpenWorkspace

matlabwasdilib.wOpenWorkspace(Wasdi, sWorkspaceName)

Open a Workspace Syntax sWorkspaceId=wOpenWorkspace(Wasdi, sWorkspaceName);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceName – Name of the workspace

Returns
sWorkspaceId

id of the workspace

wOpenWorkspaceById

matlabwasdilib.wOpenWorkspaceById(Wasdi, sWorkspaceId)

Opens a workspace given its ID Syntax sWorkspaceId=wOpenWorkspaceById(Wasdi,sWorkspaceId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sWorkspaceId – ID of the workspace to open

Returns
sWorkspaceId

the ID of the workspace if succesfully opened, empty string otherwise

wPrintStatus

matlabwasdilib.wPrintStatus(Wasdi)

Prints the status Syntax: printStatus(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

wRefreshParameters

matlabwasdilib.wRefreshParameters(Wasdi)

Read again the parameters from the configured file Syntax sParameter = wRefreshParameters(Wasdi, sKey)

Parameters

Wasdi – Wasdi object created after the wasdilib call

wSearchEOImages

matlabwasdilib.wSearchEOImages(Wasdi, sPlatform, sDateFrom, sDateTo, dULLat, dULLon, dLRLat, dLRLon, sProductType, iOrbitNumber, sSensorOperationalMode, sCloudCoverage)

Search EO Images. Returns 3 parallel arrays: one with the names, one with the links and one with the footprints of the found products. The links and footprints can be used as input to the wImportProduct function, that imports the product in the active workspace Syntax [asProductNames, asProductLinks, asProductFootprints]=wSearchEOImages(Wasdi, sPlatform, sDateFrom, sDateTo, dULLat, dULLon, dLRLat, dLRLon, sProductType, iOrbitNumber, sSensorOperationalMode, sCloudCoverage);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sPlatform – Satellite Platform. Accepts “S1”,”S2”

  • sDateFrom – Starting date in format “YYYY-MM-DD”

  • sDateTo – End date in format “YYYY-MM-DD”

  • dULLat – Upper Left Lat Coordinate. Can be null.

  • dULLon – Upper Left Lon Coordinate. Can be null.

  • dLRLat – Lower Right Lat Coordinate. Can be null.

  • dLRLon – Lower Right Lon Coordinate. Can be null.

  • sProductType – Product Type. If Platform = “S1” -> Accepts “SLC”,”GRD”, “OCN”. If Platform = “S2” -> Accepts “S2MSI1C”,”S2MSI2Ap”,”S2MSI2A”. Can be null.

  • iOrbitNumber – Sentinel Orbit Number. Can be null.

  • sSensorOperationalMode – Sensor Operational Mode. ONLY for S1. Accepts -> “SM”, “IW”, “EW”, “WV”. Can be null. Ignored for Platform “S2”

  • sCloudCoverage – sCloudCoverage Cloud Coverage. Sample syntax: [0 TO 9.4]

Returns
asProductNames

array of strings that are the names of the found products

asProductLinks

array of strings that are the links to download the products

asProductFootprints

array of strings that are the footprints of found products in WKT

wSetActiveWorkspaceId

matlabwasdilib.wSetActiveWorkspaceId(Wasdi, sNewActiveWorkspaceId)

Set the active workspace Syntax wSetActiveWorkspaceId(Wasdi, sNewActiveWorkspaceId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sNewActiveWorkspaceId – the workspace ID to open

wSetBasePath

matlabwasdilib.wSetBasePath(Wasdi, sNewBasePath)

Set the base path Syntax wSetBasePath(Wasdi, sNewBasePath)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sNewBasePath – the new base path

wSetBaseUrl

matlabwasdilib.wSetBaseUrl(Wasdi, sBaseUrl)

Set the base URL Syntax wSetBaseUrl(Wasdi, sBaseUrl)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sBaseUrl – the new base URL (must be valid)

wSetDownloadActive

matlabwasdilib.wSetDownloadActive(Wasdi, iActive)

Set the download active flag Syntax wSetDownloadActive(Wasdi, iActive)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • iActive – true/false

wSetIsOnServer

matlabwasdilib.wSetIsOnServer(Wasdi, bIsOnServer)

Set is on server flag Syntax wSetVerbose(Wasdi, bIsOnServer)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • bIsOnServer – true/false

wSetMyProcId

matlabwasdilib.wSetMyProcId(Wasdi, sMyNewProcId)

Set the processor ID Syntax wSetMyProcId(Wasdi, sMyNewProcId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sMyNewProcId – the new processor ID

wSetParameter

matlabwasdilib.wSetParameter(Wasdi, sKey, sValue)

Set the value of a parameter Syntax sParameter = wSetParameter(Wasdi, sKey, sValue)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sKey – The KEY of the parameter to add or update

  • sValue – The the value of the parameter

Returns
sParameter

The value (same as sValue in input)

wSetPassword

matlabwasdilib.wSetPassword(Wasdi, sPassword)

Set the WASDI user password Syntax wSetPassword(Wasdi, sPassword)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sPassword – the password

wSetPayload

matlabwasdilib.wSetPayload(Wasdi, sPayload)

Writes a Payload in a process Syntax sStatus =wSetProcessPayload(Wasdi, sProcessId, sData);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sPayload – the process payload

wSetProcessPayload

matlabwasdilib.wSetProcessPayload(Wasdi, sProcessId, sData)

Writes a Payload in a process Syntax sStatus =wSetProcessPayload(Wasdi, sProcessId, sData);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessId – Id of the process to update

  • sData – Data to write as payloar

Returns
sStatus

Process Status as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wSetSessionId

matlabwasdilib.wSetSessionId(Wasdi, sSessionId)

Set the session ID Syntax wSetSessionId(Wasdi, sSessionId)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sSessionId – the session ID

wSetSubPid

matlabwasdilib.wSetSubPid(Wasdi, sProcessId, iSubPid)

Set the sub pid Syntax sStatus=wSetSubPid(Wasdi, sProcessId, iSubPid)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessId – the process ID

  • iSubPid – the sub pid

wSetUploadActive

matlabwasdilib.wSetUploadActive(Wasdi, iActive)

Set the Upload active flag Syntax wSetUploadActive(Wasdi, iActive)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • iActive – true/false

wSetUser

matlabwasdilib.wSetUser(Wasdi, sUser)

Set the user Syntax wSetUser(Wasdi, sUser)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sUser – the user

wSetVerbose

matlabwasdilib.wSetVerbose(Wasdi, bVerbose)

Set verbose flag Syntax wSetVerbose(Wasdi, bVerbose)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • bVerbose – true/false

wSetWorkspaceBaseUrl

matlabwasdilib.wSetWorkspaceBaseUrl(Wasdi, sUrl)

Set the workspace base URL Syntax wSetWorkspaceBaseUrl(Wasdi, sUrl)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sUrl – the workspace base URL

wSubset

matlabwasdilib.wSubset(Wasdi, sInputFile, sOutputFile, dLatN, dLonW, dLatS, dLonE)

Make a Subset (tile) of an input image in a specified Lat Lon Rectangle Syntax sStatus=wSubset(Wasdi, sInputFile, sOutputFile, dLatN, dLonW, dLatS, dLonE)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sInputFile – Name of the input file

  • sOutputFile – Name of the output file

  • dLatN – Lat North Coordinate

  • dLonW – Lon West Coordinate

  • dLatS – Lat South Coordinate

  • dLonE – Lon East Coordinate

Returns
sStatus

Status of the operation

wUpdateProcessStatus

matlabwasdilib.wUpdateProcessStatus(Wasdi, sProcessId, sStatus, iPerc)

Updates the status of a Process Syntax sStatus =wUpdateProcessStatus(Wasdi, sProcessId, sStatus, iPerc);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessId – Id of the process to update

  • sStatus – updated status. Must be CREATED, RUNNING, STOPPED, DONE, ERROR

  • iPerc – progress percentage of the process

Returns
sOutputStatus

Process Status Updated as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wUpdateProgress

matlabwasdilib.wUpdateProgress(Wasdi, iPerc)

Updates the progress of the processor Syntax sStatus =wUpdateProgress(Wasdi, iPerc);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • iPerc – progress percentage of the own process

Returns
sOutputStatus

Process Status as a String: CREATED, RUNNING, STOPPED, DONE, ERROR

wUpdateProgressPerc

matlabwasdilib.wUpdateProgressPerc(Wasdi, iPerc)

Updates the status of a process Syntax sStatus = wUpdateProgressPerc(Wasdi, iPerc)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • iPerc – the %of completion

Returns
sStatus

updated status as a String or ‘’ if there was any problem

wUpdateStatus

matlabwasdilib.wUpdateStatus(wasdi, sStatus, iPerc=[])

updates the status and, optionally, the progress percent syntax: sStatus = wUpdateStatus(Wasdi, sStatus, iPerc=[])

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sStatus – the status to be set

  • iPerc – optional, the progress percent

wUrlEncode

matlabwasdilib.wUrlEncode(s)

wWaitProcess

matlabwasdilib.wWaitProcess(Wasdi, sProcessId)

Wait for the end of a process Syntax sStatus =wWaitProcess(Wasdi, sProcessId);

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sProcessId – Id of the process to wait

Returns
sStatus

exit status of the process: CREATED, RUNNING, STOPPED, DONE, ERROR

wasdiHello

matlabwasdilib.wasdiHello(Wasdi)

Hello world in WASDI. Useful for testing the setup Syntax: wasdiHello(Wasdi)

Parameters

Wasdi – Wasdi object created after the wasdilib call

wasdiLog

matlabwasdilib.wasdiLog(Wasdi, sLine)

Logs a line Syntax wasdiLog(Wasdi, sLine)

Parameters
  • Wasdi – Wasdi object created after the wasdilib call

  • sLine – the string to be logged