EGMStoolkit.classes.EGMSdownloaderapi.egmsdownloader

class documentation

class egmsdownloader: (source)

Constructor: egmsdownloader(listL2a, listL2alink, listL2b, listL2blink, ...)

View In Hierarchy

egmsdownloader class.

Method __init__ egmsdownloader initialisation.
Method checkparameter Check the parameter
Method clean Clean the unused files (based on the list(s))
Method download Download the EGMS files
Method print Print the class attributes
Method printlist Print the list(s) of EGMS files
Method unzipfile Unzip the EGMS files
Method updatelist Update the list of of EGMS files
Instance Variable listL2a Storage of available data [Default: empty]
Instance Variable listL2alink Storage of available data [Default: empty]
Instance Variable listL2b Storage of available data [Default: empty]
Instance Variable listL2blink Storage of available data [Default: empty]
Instance Variable listL3EW Storage of available data [Default: empty]
Instance Variable listL3EWlink Storage of available data [Default: empty]
Instance Variable listL3UD Storage of available data [Default: empty]
Instance Variable listL3UDlink Storage of available data [Default: empty]
Instance Variable log Loggin mode [Default: None]
Instance Variable token User token [Default: 'XXXXXXX--XXXXXXX']
Instance Variable verbose Verbose [Default: True]
def __init__(self, listL2a: Optional[any] = [], listL2alink: Optional[any] = [], listL2b: Optional[any] = [], listL2blink: Optional[any] = [], listL3UD: Optional[any] = [], listL3UDlink: Optional[any] = [], listL3EW: Optional[any] = [], listL3EWlink: Optional[any] = [], token: Optional[str] = 'XXXXXXX--XXXXXXX', verbose: Optional[bool] = True, log: Optional[Union[str, None]] = None): (source)

egmsdownloader initialisation.

Return egmsdownloader class

Parameters
listL2a:list, OptionalStorage of available data [Default: empty]
listL2alink:list, OptionalStorage of available data [Default: empty]
listL2b:list, OptionalStorage of available data [Default: empty]
listL2blink:list, OptionalStorage of available data [Default: empty]
listL3UD:list, OptionalStorage of available data [Default: empty]
listL3UDlink:list, OptionalStorage of available data [Default: empty]
listL3EW:list, OptionalStorage of available data [Default: empty]
listL3EWlink:list, OptionalStorage of available data [Default: empty]
token:str, OptionalUser token [Default: 'XXXXXXX--XXXXXXX']
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 parameter

Return

egmsdownloader class
Parameters
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def clean(self, outputdir: Optional[str] = '.%sOutput'%os.sep, verbose: Optional[Union[bool, None]] = None): (source)

Clean the unused files (based on the list(s))

Return

egmsdownloader class
Parameters
outputdir:str, OptionalPath of the output directory [Default: './Output']
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def download(self, outputdir: Optional[str] = '.%sOutput'%os.sep, unzipmode: Optional[bool] = False, cleanmode: Optional[bool] = False, force: Optional[bool] = True, verbose: Optional[Union[bool, None]] = None): (source)

Download the EGMS files

Return

egmsdownloader class
Parameters
outputdir:str, OptionalPath of the output directory [Default: './Output']
unzipmode:bool, OptionalUnzip the file [Default: False]
cleanmode:bool, OptionalDelete the file after unzipping [Default: False]
force:bool, OptionalReplace the stored file [Default: True]
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

egmsdownloader class
def printlist(self, verbose: Optional[Union[bool, None]] = None): (source)

Print the list(s) of EGMS files

Return

egmsdownloader class
Parameters
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def unzipfile(self, outputdir: Optional[str] = '.%sOutput'%os.sep, unzipmode: Optional[bool] = True, nbworker: Optional[int] = 1, cleanmode: Optional[bool] = False, verbose: Optional[Union[bool, None]] = None): (source)

Unzip the EGMS files

Return

egmsdownloader class
Parameters
outputdir:str, OptionalPath of the output directory [Default: './Output']
unzipmode:bool, OptionalUnzip the file [Default: True]
nbworker:int, OptionalNumber of workers for unzipping [Default: 1]
cleanmode:bool, OptionalDelete the file after unzipping [Default: False]
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
def updatelist(self, infoS1ROIparameter, verbose: Optional[Union[bool, None]] = None): (source)

Update the list of of EGMS files

Return

egmsdownloader class
Parameters
infoS1ROIparameterS1ROIparameter class
verbose:bool or None, OptionalVerbose if None, use the verbose mode of the job [Default: None]
listL2a: list = (source)

Storage of available data [Default: empty]

listL2alink: list = (source)

Storage of available data [Default: empty]

listL2b: list = (source)

Storage of available data [Default: empty]

listL2blink: list = (source)

Storage of available data [Default: empty]

listL3EW: list = (source)

Storage of available data [Default: empty]

listL3EWlink: list = (source)

Storage of available data [Default: empty]

listL3UD: list = (source)

Storage of available data [Default: empty]

listL3UDlink: list = (source)

Storage of available data [Default: empty]

log: str or None = (source)

Loggin mode [Default: None]

token: str = (source)

User token [Default: 'XXXXXXX--XXXXXXX']

verbose: bool = (source)

Verbose [Default: True]