EGMStoolkit.classes.EGMSS1burstIDapi.S1burstIDmap

class documentation

class S1burstIDmap: (source)

Constructor: S1burstIDmap(date_str_init, dirmap, pathIDmap, list_date, ...)

View In Hierarchy

S1burstIDmap class.

Method __init__ S1burstIDmap initialisation.
Method checkfile Check the available map(s) stored.
Method downloadfile Download the available map(s) stored.
Method print Print the class attributes
Instance Variable date_str_init First date to search the S1-Burst-ID map [Default: '29/05/2022']
Instance Variable dirmap Directory of the S1-Burst-ID map
Instance Variable list_date List of the date to search the S1-Burst-ID map [Default: empty]
Instance Variable log Loggin mode [Default: None]
Instance Variable pathIDmap Full path of the S1-Burst-ID map [Default: None]
Instance Variable verbose Verbose [Default: True]
def __init__(self, date_str_init: Optional[str] = '29/05/2022', dirmap: Optional[str] = constants.__pathS1map__, pathIDmap: Optional[Union[str, None]] = None, list_date: Optional[list] = [], verbose: Optional[bool] = True, log: Optional[Union[str, None]] = None): (source)

S1burstIDmap initialisation.

Return

S1burstIDmap class
Parameters
date_str_init:str, OptionalFirst date to search the S1-Burst-ID map [Default: '29/05/2022']
dirmap:str, OptionalDirectory of the S1-Burst-ID map
pathIDmap:str or None, OptionalFull path of the S1-Burst-ID map [Default: None]
list_date:list, OptionalList of the date to search the S1-Burst-ID map [Default: empty]
verbose:bool, OptionalVerbose [Default: True]
log:str or None, OptionalLoggin mode [Default: None]
def checkfile(self, verbose: Optional[Union[bool, None]] = None): (source)

Check the available map(s) stored.

Return

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

Download the available map(s) stored.

Return

S1burstIDmap class
Parameters
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

S1burstIDmap class
date_str_init: str = (source)

First date to search the S1-Burst-ID map [Default: '29/05/2022']

dirmap: str = (source)

Directory of the S1-Burst-ID map

list_date: list = (source)

List of the date to search the S1-Burst-ID map [Default: empty]

log: str or None = (source)

Loggin mode [Default: None]

pathIDmap: str or None = (source)

Full path of the S1-Burst-ID map [Default: None]

verbose: bool = (source)

Verbose [Default: True]