Hints to start working with SARscape batch mode
This Help Article provides some hints to start working with SARscape batch mode.
1. How to launch the SARscape API : you need to initialize the ENVI batch mode in IDL before the SARscape routines are available as SARscapeBatch objects.
e= ENVI(/HEADLESS)
oSB = SARscapeBatch()
help,oSB
2. How to list all SARscape batch routines : using the Manifest method
oSB.Manifest
3. How to identify which SARscape batch routine will complete a given process : using the SearchModule method
Example: look for a batch routine to import ENVISAT data
oSB.SearchModule,'ENVISAT'
It returns the list of routines to process ENVISAT data.
The list also includes the module name to which each routine belongs.
-----------------------------------------------------------
Description of the modules available for SARscape Batch
seed: "ENVISAT"
-----------------------------------------------------------
Module Name..: FOCUSINGASARIM
Description..: ENVISAT ASAR IM Import and Focussing
************************************************************
Module Name..: FOCUSINGMOSAICENVISAT
Description..: ENVISAT Import Mosaic and Focusing
************************************************************
Module Name..: IMPORTENVISATASARFORMAT
Description..: Import ENVISAT ASAR
************************************************************
Module Name..: IMPORTENVISATMERISFORMAT
Description..: Import ENVISAT MERIS
************************************************************
4. How to create a SARscape batch tool: for example to import ENVISAT data
oSB.SetUpModule(Module='IMPORTENVISATASARFORMAT')
help,oSB,/OBJECT
5. How to list the properties/parameters associated to a given routine: for example the commands below list the parameters of the ENVISAT import tool defined at the previous step
oSB.listparams
6. How to access to the configuration of a given parameter : for example the commands below display the type and available values of the "make_tiff" parameter associated to the ENVISAT import tool defined above.
ok = oSB._GetParamType('make_tiff',type,list)
print,type
print,transpose(list)
7. How to get the current value of a given parameter: for example the commands below get the current value of the "make_tiff" parameter associated to the ENVISAT import tool defined above.
ok = oSB.GetParam('make_tiff',value)
print,value
8. How to add/change the value of a given parameter: for example the commands below assign the 'OK' value to the make_tiff parameter associated to the ENVISAT import tool defined above.
oSB.SetParam('make_tiff','OK')
ok = oSB.GetParam('make_tiff',value)
print,value
9. How to check if all mandatory parameters are set for a given batch routine: using the VerifyParams method. It should return 1 one if all mandatory parameters are set correctly. It lists the missing parameters if not.
ok = oSB.VerifyParams()
10. How to execute a given process: the previous step should return 1 before executing a given batch process using the Execute method
ok = oSB.Execute()
11. How to exit the SARscape batch mode:
SARscape_batch_exit
____________________________________________
Reviewed by CS and PS on 09/16/2014