Octave WasdiLib¶
Methods¶
wAddFileToWASDI¶
matlabwasdilib.wAddFileToWASDI(Wasdi, sFileName)¶Ingest a new file in the Active WASDI Workspace waiting for the resultThe method takes a file saved in the workspace root (see getSaveFilePath) not already added to the WSo work be sure that the file is on the serverSyntaxsStatus =wAddFileToWASDI(Wasdi, sFileName);:param Wasdi: Wasdi object created after the wasdilib call:param 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 processorSyntaxwAddParam(Wasdi, sKey, sValue):param Wasdi: Wasdi object created after the wasdilib call:param sKey: a string to be used as key for the param: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 resultThe method takes a file saved in the workspace root (see getSaveFilePath) not already added to the WSIf the file is not present in the WASDI cloud workpsace, it will be automatically uploaded if the config AUTOUPLOAD flag is true (default)SyntaxsStatus =wAsynchAddFileToWASDI(Wasdi, sFileName);:param Wasdi: Wasdi object created after the wasdilib call:param 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 versionSyntaxwAsynchCopyFileToSftp(Wasdi, sFileName, sRelativePath):param Wasdi: Wasdi object created after the wasdilib call:param sFileName: a string containing the file name:param sRelativePath: a string containinng the relative path
wAsynchExecuteProcessor¶
matlabwasdilib.wAsynchExecuteProcessor(Wasdi, sProcessorName, asParams)¶Execute a WASDI processor asynchronouslySyntaxsStatus=wAsynchExecuteProcessor(Wasdi, sProcessorName, asParams):param Wasdi: Wasdi object created after the wasdilib call:param sProcessorName: Processor Name:param 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.SyntaxsProcessId = wExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles);:param Wasdi: Wasdi object created after the wasdilib call:param sWorkflow: Name of the workflow:param 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:param 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 versionSyntaxsStatus=wImportProduct(Wasdi, sProductLink, sName):param Wasdi: Wasdi object created after the wasdilib call:param sProductLink: Product Direct Link as returned by wSearchEOImage:param sName: Product Name as returned by wSearchEOImage:param sBoundingBox: product bounding box, optional:param 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 versionSyntaxsProcessObjId=wAsynchImportProductList(Wasdi, asProductLinks, asProductNames):param Wasdi: Wasdi object created after the wasdilib call:param asProductLinks: collection of Product Direct Link as returned by wSearchEOImage:param 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 fileSyntaxsProcessId=wAsynchMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue):param Wasdi: Wasdi object created after the wasdilib call:param asInputFileNames: Array of input file names:param sOutputFile: Name of the output file:param sNoDataValue: value to use as no data in the output file:param 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 versionSyntaxsReturn=wAsynchMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE):param Wasdi: Wasdi object created after the wasdilib call:param sInputFile: the input file from where subsets must be extracted:param asOutputFiles: names to be given to output files:param adLatN: a collection of Northernmost latitudes:param adLonW: a collection of Westernmost longitudes:param adLatS: a collection of Southernmost latitudes:param adLonE: a collection of Easternnmost longitudes
wCopyFileToSftp¶
matlabwasdilib.wCopyFileToSftp(Wasdi, sFileName, sRelativePath)¶Copy file to SFTP folder, synchronous versionSyntaxwCopyFileToSftp(Wasdi, sFileName, sRelativePath):param Wasdi: Wasdi object created after the wasdilib call:param sFileName: a string containing the file name:param 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 versionSyntaxwCreateWorkspace(Wasdi, sWorkspaceName, sNodeCode):param Wasdi: Wasdi object created after the wasdilib call:param sWorkspaceName: the name of the workspace:param 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 workspaceSyntaxsStatus = wDeleteProduct(Wasdi, sProductName):param Wasdi: Wasdi object created after the wasdilib call:param 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 deletedSyntaxsStatus = wDeleteProduct(Wasdi, sWorkspaceName):param Wasdi: Wasdi object created after the wasdilib call:param 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 asynchronouslySyntaxsStatus=wExecuteProcessor(Wasdi, sProcessorName, asParams):param Wasdi: Wasdi object created after the wasdilib call:param sProcessorName: Processor Name:param 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.SyntaxsStatus = wExecuteWorkflow(Wasdi, sWorkflow, asInputFiles, asOutputFiles);:param Wasdi: Wasdi object created after the wasdilib call:param sWorkflow: Name of the workflow:param 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:param 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 IDSyntaxsWorkspaceId = wGetActiveWorkspace(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sWorkspaceId: the ID of active WASDI workspace
wGetBasePath¶
matlabwasdilib.wGetBasePath(Wasdi)¶Gets the base pathSyntaxsBasePath = wGetBasePath(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sBasePath: the base path in use
wGetBaseUrl¶
matlabwasdilib.wGetBaseUrl(Wasdi)¶Gets the base URLSyntaxsBasePath = wGetBaseUrl(Wasdi):param 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 notSyntaxbDownloadActive = wGetDownloadActive(Wasdi):param 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 PCand DownloadActive flag is true the product will be downloadedSyntaxsFullPath =wGetFullProductPath(Wasdi, sFileName);:param Wasdi: Wasdi object created after the wasdilib call:param sFileName: Name of the file:Returns: :sFullPath: full local path
wGetMyProcId¶
matlabwasdilib.wGetMyProcId(Wasdi)¶Gets own processor IDSyntaxsProcId = wGetProcessorPayloadAsJSON(Wasdi, sProcessObjId):param 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 fileSyntaxsParameter = wGetParameter(Wasdi, sKey):param Wasdi: Wasdi object created after the wasdilib call:param 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 pathSyntaxsParametersFilePath = wGetParametersFilPath(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sParametersFilePath: the path to the parameters file
wGetParams¶
matlabwasdilib.wGetParams(Wasdi)¶Gets processor parametersSyntaxasParams = wGetParams(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :asParams: a map containing the parameters
wGetPassword¶
matlabwasdilib.wGetPassword(Wasdi)¶Gets the passwordSyntaxsPassword = wGetPassword(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sPassword: WASDI user’s password
wGetPath¶
matlabwasdilib.wGetPath(Wasdi, sFileName)¶Gets the path of given productSyntaxsPath = wGetPath(Wasdi, sFileName):param 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 ProcessSyntaxsStatus =wGetProcessStatus(Wasdi, sProcessId);:param Wasdi: Wasdi object created after the wasdilib call:param 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 workspaceSyntaxasProcesses=wgetProcessesByWorkspace(Wasdi, iStartIndex, iEndIndex=[], sStatus=[], sOperationType=[], sNamePattern=[]?):param Wasdi: Wasdi object created after the wasdilib call:param iStartIndex: first index:param iEndIndex: last index:param sStatus: filter by statuses:param sOperationType: filter by operation name:param sNamePattern: filter by name:Returns: :asProcesses: list of processes
wGetProcessorPath¶
matlabwasdilib.wGetProcessorPath(Wasdi)¶Gets the parameters file pathSyntaxsProcessorPath = wGetProcessorPath(Wasdi):param 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 processorSyntaxoProcessPayload = wGetProcessorPayload(Wasdi, sProcessObjId):param Wasdi: Wasdi object created after the wasdilib call:param 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 stringSyntaxsProcessPayload = wGetProcessorPayloadAsJSON(Wasdi, sProcessObjId):param Wasdi: Wasdi object created after the wasdilib call:param 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 IDSyntaxsProcId = wGetProductBbox(Wasdi, sProductName):param Wasdi: Wasdi object created after the wasdilib call:param 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 WorkspaceSyntaxasProducts=wGetProductsByActiveWorkspace(Wasdi);:param 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 WorkspaceSyntaxasProducts=wGetProductsByWorkspace(Wasdi, sWorkspaceName);:param Wasdi: Wasdi object created after the wasdilib call:param 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 workspaceSyntaxsSavePath =wGetSavePath(Wasdi);:param 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 IDSyntaxsSessionId = wGetSessionId(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sSessionId: the current session
wGetUploadActive¶
matlabwasdilib.wGetUploadActive(Wasdi)¶Gets whether Upload is active or notSyntaxbUploadActive = wGetUploadActive(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :bUploadActive: true if Upload is active, false otherwise
wGetUser¶
matlabwasdilib.wGetUser(Wasdi)¶Gets the userSyntaxsUser = wGetUser(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sUser: the username on wasdi
wGetVerbose¶
matlabwasdilib.wGetVerbose(Wasdi)¶Gets verbosity flagSyntaxbVerbose = wGetVerbose(Wasdi):param Wasdi: Wasdi object created after the wasdilib call:Returns: :bVerbose: verbosity flag
wGetWorkflows¶
matlabwasdilib.wGetWorkflows(Wasdi)¶Get the List of Workflows of the actual UserSyntax[asWorkflowNames, asWorkflowIds]=wGetWorkflows(Wasdi);:param 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 URLSyntaxsWorkspaceBaseUrl = wGetWorkspaceBaseUrl(Wasdi):param 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 nameSyntaxsWorkspaceId=wGetWorkspaceIdByName(Wasdi, sWorkspaceName);:param Wasdi: Wasdi object created after the wasdilib call:param sWorkspaceName: Name of the workspace:Returns: :sWorkspaceId: id of the workspace
wGetWorkspaceOwnerByName¶
matlabwasdilib.wGetWorkspaceOwnerByName(Wasdi, sWorkspaceName)¶Gets the owner of the workspace given its nameSyntaxsWorkspaceOwner = wGetWorkspaceOwnerByName(Wasdi, sWorkspaceName):param Wasdi: Wasdi object created after the wasdilib call:param sWorkspaceName: the name of the workspace:Returns: :sWorkspaceOwner: the owner of the workspace
wGetWorkspaceUrlByWsId¶
matlabwasdilib.wGetWorkspaceUrlByWsId(Wasdi, sWorkspaceId)¶Gets the workspace URL given its IDSyntax:sWorkspaceUrl = wGetWorkspaceUrlByWsId(Wasdi, sWorkspaceId):param Wasdi: Wasdi object created after the wasdilib call:Returns: :sBaseUrl: the base URL for WASDI
wImportAndPreprocess¶
matlabwasdilib.wImportAndPreprocess(Wasdi, asProductLinks, asProductNames, sWorkflowName, sSuffix, sProvider=[])¶Import and preprocess a collection of EO productsSyntaxwImportAndPreprocess(Wasdi, asProductLinks, asProductNames, sWorkflowName, sSuffix):param Wasdi: Wasdi object created after the wasdilib call:param asProductLinks: collection of Product Direct Link as returned by wSearchEOImages:param asProductNames: collection of Product names, as returned by wSearchEOImages:param sWorkflowName: the name of the SNAP workflow to be applied to downloaded imagesc:param sSuffix: the suffix to append to the preprocessed files:param sProvider: optional, the provider from where data must be collected
wImportProduct¶
matlabwasdilib.wImportProduct(Wasdi, sProductLink, sProductName, sBoundingBox='', sProvider='AUTO')¶Import an EO Image in WASDISyntaxsStatus=wImportProduct(Wasdi, sProductLink, sProductName):param Wasdi: Wasdi object created after the wasdilib call:param sProductLink: Product Direct Link as returned by wSearchEOImage:param sProductName: Product Name as returned by wSearchEOImage:param sBoundingBox: product bounding box, optional:param 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 versionSyntaxsProcessObjId=wAsynchImportProductList(Wasdi, asProductLinks, asProductNames):param Wasdi: Wasdi object created after the wasdilib call:param asProductLinks: collection of Product Direct Link as returned by wSearchEOImage:param 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.SyntaxwLog(Wasdi, sLogRow):param Wasdi: Wasdi object created after the wasdilib call:param sLogRow: Text to log
wMosaic¶
matlabwasdilib.wMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue)¶Mosaic input images in the output fileSyntaxsStatus=wMosaic(Wasdi, asInputFileNames, sOutputFile, sNoDataValue, sInputIgnoreValue):param 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 boxesSyntaxsReturn=wMultiSubset(Wasdi, sInputFile, asOutputFiles, adLatN, adLonW, adLatS, adLonE):param Wasdi: Wasdi object created after the wasdilib call:param sInputFile: the input file from where subsets must be extracted:param asOutputFiles: names to be given to output files:param adLatN: a collection of Northernmost latitudes:param adLonW: a collection of Westernmost longitudes:param adLatS: a collection of Southernmost latitudes:param adLonE: a collection of Easternnmost longitudes
wOpenWorkspace¶
matlabwasdilib.wOpenWorkspace(Wasdi, sWorkspaceName)¶Open a WorkspaceSyntaxsWorkspaceId=wOpenWorkspace(Wasdi, sWorkspaceName);:param Wasdi: Wasdi object created after the wasdilib call:param sWorkspaceName: Name of the workspace:Returns: :sWorkspaceId: id of the workspace
wOpenWorkspaceById¶
matlabwasdilib.wOpenWorkspaceById(Wasdi, sWorkspaceId)¶Opens a workspace given its IDSyntaxsWorkspaceId=wOpenWorkspaceById(Wasdi,sWorkspaceId):param Wasdi: Wasdi object created after the wasdilib call:param 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 statusSyntax:printStatus(Wasdi):param Wasdi: Wasdi object created after the wasdilib call
wRefreshParameters¶
matlabwasdilib.wRefreshParameters(Wasdi)¶Read again the parameters from the configured fileSyntaxsParameter = wRefreshParameters(Wasdi, sKey):param 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 workspaceSyntax[asProductNames, asProductLinks, asProductFootprints]=wSearchEOImages(Wasdi, sPlatform, sDateFrom, sDateTo, dULLat, dULLon, dLRLat, dLRLon, sProductType, iOrbitNumber, sSensorOperationalMode, sCloudCoverage);:param Wasdi: Wasdi object created after the wasdilib call:param sPlatform: Satellite Platform. Accepts “S1”,”S2”:param sDateFrom: Starting date in format “YYYY-MM-DD”:param sDateTo: End date in format “YYYY-MM-DD”:param dULLat: Upper Left Lat Coordinate. Can be null.:param dULLon: Upper Left Lon Coordinate. Can be null.:param dLRLat: Lower Right Lat Coordinate. Can be null.:param dLRLon: Lower Right Lon Coordinate. Can be null.:param sProductType: Product Type. If Platform = “S1” -> Accepts “SLC”,”GRD”, “OCN”. If Platform = “S2” -> Accepts “S2MSI1C”,”S2MSI2Ap”,”S2MSI2A”. Can be null.:param iOrbitNumber: Sentinel Orbit Number. Can be null.:param sSensorOperationalMode: Sensor Operational Mode. ONLY for S1. Accepts -> “SM”, “IW”, “EW”, “WV”. Can be null. Ignored for Platform “S2”:param 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 workspaceSyntaxwSetActiveWorkspaceId(Wasdi, sNewActiveWorkspaceId):param Wasdi: Wasdi object created after the wasdilib call:param sNewActiveWorkspaceId: the workspace ID to open
wSetBasePath¶
matlabwasdilib.wSetBasePath(Wasdi, sNewBasePath)¶Set the base pathSyntaxwSetBasePath(Wasdi, sNewBasePath):param Wasdi: Wasdi object created after the wasdilib call:param sNewBasePath: the new base path
wSetBaseUrl¶
matlabwasdilib.wSetBaseUrl(Wasdi, sBaseUrl)¶Set the base URLSyntaxwSetBaseUrl(Wasdi, sBaseUrl):param Wasdi: Wasdi object created after the wasdilib call:param sBaseUrl: the new base URL (must be valid)
wSetDownloadActive¶
matlabwasdilib.wSetDownloadActive(Wasdi, iActive)¶Set the download active flagSyntaxwSetDownloadActive(Wasdi, iActive):param Wasdi: Wasdi object created after the wasdilib call:param iActive: true/false
wSetIsOnServer¶
matlabwasdilib.wSetIsOnServer(Wasdi, bIsOnServer)¶Set is on server flagSyntaxwSetVerbose(Wasdi, bIsOnServer):param Wasdi: Wasdi object created after the wasdilib call:param bIsOnServer: true/false
wSetMyProcId¶
matlabwasdilib.wSetMyProcId(Wasdi, sMyNewProcId)¶Set the processor IDSyntaxwSetMyProcId(Wasdi, sMyNewProcId):param Wasdi: Wasdi object created after the wasdilib call:param sMyNewProcId: the new processor ID
wSetParameter¶
matlabwasdilib.wSetParameter(Wasdi, sKey, sValue)¶Set the value of a parameterSyntaxsParameter = wSetParameter(Wasdi, sKey, sValue):param Wasdi: Wasdi object created after the wasdilib call:param sKey: The KEY of the parameter to add or update:param 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 passwordSyntaxwSetPassword(Wasdi, sPassword):param Wasdi: Wasdi object created after the wasdilib call:param sPassword: the password
wSetPayload¶
matlabwasdilib.wSetPayload(Wasdi, sPayload)¶Writes a Payload in a processSyntaxsStatus =wSetProcessPayload(Wasdi, sProcessId, sData);:param Wasdi: Wasdi object created after the wasdilib call:param sPayload: the process payload
wSetProcessPayload¶
matlabwasdilib.wSetProcessPayload(Wasdi, sProcessId, sData)¶Writes a Payload in a processSyntaxsStatus =wSetProcessPayload(Wasdi, sProcessId, sData);:param Wasdi: Wasdi object created after the wasdilib call:param sProcessId: Id of the process to update:param 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 IDSyntaxwSetSessionId(Wasdi, sSessionId):param Wasdi: Wasdi object created after the wasdilib call:param sSessionId: the session ID
wSetSubPid¶
matlabwasdilib.wSetSubPid(Wasdi, sProcessId, iSubPid)¶Set the sub pidSyntaxsStatus=wSetSubPid(Wasdi, sProcessId, iSubPid):param Wasdi: Wasdi object created after the wasdilib call:param sProcessId: the process ID:param iSubPid: the sub pid
wSetUploadActive¶
matlabwasdilib.wSetUploadActive(Wasdi, iActive)¶Set the Upload active flagSyntaxwSetUploadActive(Wasdi, iActive):param Wasdi: Wasdi object created after the wasdilib call:param iActive: true/false
wSetUser¶
matlabwasdilib.wSetUser(Wasdi, sUser)¶Set the userSyntaxwSetUser(Wasdi, sUser):param Wasdi: Wasdi object created after the wasdilib call:param sUser: the user
wSetVerbose¶
matlabwasdilib.wSetVerbose(Wasdi, bVerbose)¶Set verbose flagSyntaxwSetVerbose(Wasdi, bVerbose):param Wasdi: Wasdi object created after the wasdilib call:param bVerbose: true/false
wSetWorkspaceBaseUrl¶
matlabwasdilib.wSetWorkspaceBaseUrl(Wasdi, sUrl)¶Set the workspace base URLSyntaxwSetWorkspaceBaseUrl(Wasdi, sUrl):param Wasdi: Wasdi object created after the wasdilib call:param 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 RectangleSyntaxsStatus=wSubset(Wasdi, sInputFile, sOutputFile, dLatN, dLonW, dLatS, dLonE):param Wasdi: Wasdi object created after the wasdilib call:param sInputFile: Name of the input file:param sOutputFile: Name of the output file:param dLatN: Lat North Coordinate:param dLonW: Lon West Coordinate:param dLatS: Lat South Coordinate:param dLonE: Lon East Coordinate:Returns: :sStatus: Status of the operation
wUpdateProcessStatus¶
matlabwasdilib.wUpdateProcessStatus(Wasdi, sProcessId, sStatus, iPerc)¶Updates the status of a ProcessSyntaxsStatus =wUpdateProcessStatus(Wasdi, sProcessId, sStatus, iPerc);:param Wasdi: Wasdi object created after the wasdilib call:param sProcessId: Id of the process to update:param sStatus: updated status. Must be CREATED, RUNNING, STOPPED, DONE, ERROR:param 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 processorSyntaxsStatus =wUpdateProgress(Wasdi, iPerc);:param Wasdi: Wasdi object created after the wasdilib call:param 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 processSyntaxsStatus = wUpdateProgressPerc(Wasdi, iPerc):param Wasdi: Wasdi object created after the wasdilib call:param 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 percentsyntax:sStatus = wUpdateStatus(Wasdi, sStatus, iPerc=[]):param Wasdi: Wasdi object created after the wasdilib call:param sStatus: the status to be set:param iPerc: optional, the progress percent
wWaitProcess¶
matlabwasdilib.wWaitProcess(Wasdi, sProcessId)¶Wait for the end of a processSyntaxsStatus =wWaitProcess(Wasdi, sProcessId);:param Wasdi: Wasdi object created after the wasdilib call:param sProcessId: Id of the process to wait:Returns: :sStatus: exit status of the process: CREATED, RUNNING, STOPPED, DONE, ERROR