class documentation
class S1ROIparameter: (source)
Constructor: S1ROIparameter(bbox, egmslevel, egmsL3component, release, ...)
S1ROIparameter
class.
Method | __init__ |
S1ROIparameter initialisation. |
Method | checkparameter |
Check the paramaters |
Method | create |
Create the ROI file |
Method | detectfrom |
Detect the tiles from the user parameters |
Method | displaymap |
Create a map of the burst IDs |
Method | load |
Load the L2a/L2b search results from a file |
Method | print |
Print the class attributes |
Method | save |
Save the L2a/L2b search results into a file |
Instance Variable | bbox |
Bbox [Default: None ] |
Instance Variable |
|
Storage of available data [Default: empty] |
Instance Variable |
|
Storage of available data [Default: empty] |
Instance Variable | egms |
EGMS level of 3D-displacement data [Default: 'UD'] |
Instance Variable | egmslevel |
EGMS level of LOS-displacement data [Default: 'L2a'] |
Instance Variable | log |
Loggin mode [Default: None ] |
Instance Variable | release |
EGMS release code [Default: '2018_2022'] |
Instance Variable |
|
ROI polygon |
Instance Variable | verbose |
Verbose [Default: True ] |
Instance Variable | workdirectory |
Full path of the work directory [Default: './'] |
def __init__(self, bbox:
Optional[ Union[ str, None]]
= None, egmslevel: Optional[ str]
= 'L2a', egmsL3component: Optional[ str]
= 'UD', release: Optional[ str]
= '2018_2022', workdirectory: Optional[ str]
= '.'+os.sep, verbose: Optional[ bool]
= True, log: Optional[ Union[ str, None]]
= None):
(source)
¶
S1ROIparameter
initialisation.
Return
S1ROIparameter
class
Parameters | |
bbox:str or None , Optional | Bbox [Default: None ] |
egmslevel:str , Optional | EGMS level of LOS-displacement data [Default: 'L2a'] |
egmsstr , Optional | EGMS level of 3D-displacement data [Default: 'UD'] |
release:str , Optional | EGMS release code [Default: '2018_2022'] |
workdirectory:str , Optional | Full path of the work directory [Default: './'] |
verbose:bool , Optional | Verbose [Default: True ] |
log:str or None , Optional | Loggin mode [Default: None ] |
def detectfromIDmap(self, infoburstID, Track_user:
Optional[ str]
= 'None', Pass_user: Optional[ str]
= 'None', verbose: Optional[ Union[ bool, None]]
= None):
(source)
¶
Detect the tiles from the user parameters
Return
S1ROIparameter
class
Parameters | |
infoburst | S1burstIDmap class |
str or list or None , Optional | Satellite track number [Default: 'None'] |
str or list or None , Optional | Satellite pass [Default: 'None'] |
verbose:bool or None , Optional | Verbose if None , use the verbose mode of the job [Default: None ] |
def displaymap(self, output:
Optional[ Union[ str, None]]
= None, use_folium: Optional[ bool]
= True, verbose: Optional[ Union[ bool, None]]
= None):
(source)
¶
Create a map of the burst IDs
Return
S1ROIparameter
class
Parameters | |
output:str or None , Optional | File for the figure. If none, the figure will be displayed [Default: None ] |
usebool , Optional | Use Folium package to create the map [Default: True ] |
verbose:bool or None , Optional | Verbose if None , use the verbose mode of the job [Default: None ] |