EGMStoolkit.classes.EGMSS1ROIapi.S1ROIparameter

class documentation

class S1ROIparameter: (source)

Constructor: S1ROIparameter(bbox, egmslevel, egmsL3component, release, ...)

View In Hierarchy

S1ROIparameter class.

Method __init__ S1ROIparameter initialisation.
Method checkparameter Check the paramaters
Method createROI Create the ROI file
Method detectfromIDmap Detect the tiles from the user parameters
Method displaymap Create a map of the burst IDs
Method loadIDlistL2 Load the L2a/L2b search results from a file
Method print Print the class attributes
Method saveIDlistL2 Save the L2a/L2b search results into a file
Instance Variable bbox Bbox [Default: None]
Instance Variable Data Storage of available data [Default: empty]
Instance Variable DataL3 Storage of available data [Default: empty]
Instance Variable egmsL3component 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: '2019_2023']
Instance Variable ROIs 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] = '2019_2023', 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, OptionalBbox [Default: None]
egmslevel:str, OptionalEGMS level of LOS-displacement data [Default: 'L2a']
egmsL3component:str, OptionalEGMS level of 3D-displacement data [Default: 'UD']
release:str, OptionalEGMS release code [Default: '2019_2023']
workdirectory:str, OptionalFull path of the work directory [Default: './']
verbose:bool, OptionalVerbose [Default: True]
log:str or None, OptionalLoggin mode [Default: None]
def checkparameter(self, verbose: Optional[Union[bool, None]] = None): (source)

Check the paramaters

Return

S1ROIparameter class
Parameters
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def createROI(self, verbose: Optional[Union[bool, None]] = None): (source)

Create the ROI file

Return

S1ROIparameter class
Parameters
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [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
infoburstIDS1burstIDmap class
Track_user:str or list or None, OptionalSatellite track number [Default: 'None']
Pass_user:str or list or None, OptionalSatellite pass [Default: 'None']
verbose:bool or None, OptionalVerbose 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, OptionalFile for the figure. If none, the figure will be displayed [Default: None]
use_folium:bool, OptionalUse Folium package to create the map [Default: True]
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def loadIDlistL2(self, input: Optional[str] = 'egmslist.pkl', verbose: Optional[Union[bool, None]] = None): (source)

Load the L2a/L2b search results from a file

Return

S1ROIparameter class
Parameters
input:str, OptionalFile [Default: 'egmslist.pkl']
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def print(self): (source)

Print the class attributes

Return

S1ROIparameter class
def saveIDlistL2(self, output: Optional[str] = 'egmslist.pkl', verbose: Optional[Union[bool, None]] = None): (source)

Save the L2a/L2b search results into a file

Return

S1ROIparameter class
Parameters
output:str, OptionalFile [Default: 'egmslist.pkl']
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
bbox: str or None = (source)

Bbox [Default: None]

Data: dict = (source)

Storage of available data [Default: empty]

DataL3: dict = (source)

Storage of available data [Default: empty]

egmsL3component: str = (source)

EGMS level of 3D-displacement data [Default: 'UD']

egmslevel: str = (source)

EGMS level of LOS-displacement data [Default: 'L2a']

log: str or None = (source)

Loggin mode [Default: None]

release: str = (source)

EGMS release code [Default: '2019_2023']

ROIs: any = (source)

ROI polygon

verbose: bool = (source)

Verbose [Default: True]

workdirectory: str = (source)

Full path of the work directory [Default: './']