Module: sarpyx.cli.decode
File: sarpyx/cli/decode.py
Decode CLI Tool for SARPyX. This module provides a command-line interface for decoding Sentinel-1 Level-0 products to zarr format.
Exported Symbols (__all__)
No explicit __all__ list. Public symbols inferred from implementation.
Public Functions (4)
create_parser function
Create the argument parser for decode command.
File location: sarpyx/cli/decode.py:27
Signature
create_parser() -> argparse.ArgumentParserParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
argparse.ArgumentParser
Configured ArgumentParser instance.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.decode import create_parser
result = create_parser()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
decode_s1_l0 function
Decode S1 L0 file to zarr format.
File location: sarpyx/cli/decode.py:80
Signature
decode_s1_l0(input_file: Path, output_dir: Path) -> NoneParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input_file | Path | yes | - | Path to the input .dat file. |
output_dir | Path | yes | - | Directory to save decoded output. |
Return Type
None
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.decode import decode_s1_l0
result = decode_s1_l0(input_file=<input_file>, output_dir=<output_dir>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
retrieve_input_files function
Retrieve input files from SAFE folders.
File location: sarpyx/cli/decode.py:94
Signature
retrieve_input_files(safe_folders: List[Path], verbose: bool=False) -> Tuple[List[Path], Dict[Path, List[Path]]]Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
safe_folders | List[Path] | yes | - | List of SAFE folder paths. |
verbose | bool | no | False | Whether to log verbose output. |
Return Type
Tuple[List[Path], Dict[Path, List[Path]]]
Tuple of (input_files, folders_map)
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.decode import retrieve_input_files
result = retrieve_input_files(safe_folders=<safe_folders>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
main function
Main entry point for decode CLI.
File location: sarpyx/cli/decode.py:129
Signature
main() -> NoneParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
None
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.cli.decode import main
result = main()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (0)
No public classes detected.