Module: sarpyx.cli.__init__
File: sarpyx/cli/__init__.py
CLI module for sarpyx package. This module provides command-line interfaces for various sarpyx functionalities, including ship detection, SAR processing, and other utilities.
Exported Symbols (__all__)
cli_mainshipdet_mainutils
Public Functions (3)
cli_main function
inferred from implementation.
File location: sarpyx/cli/__init__.py:15
Signature
cli_main(*args, **kwargs)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
*args | inferred from implementation | no | - | inferred from implementation. |
**kwargs | inferred from implementation | no | - | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.__init__ import cli_main
result = cli_main()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
shipdet_main function
inferred from implementation.
File location: sarpyx/cli/__init__.py:19
Signature
shipdet_main(*args, **kwargs)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
*args | inferred from implementation | no | - | inferred from implementation. |
**kwargs | inferred from implementation | no | - | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.__init__ import shipdet_main
result = shipdet_main()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
utils function
inferred from implementation.
File location: sarpyx/cli/__init__.py:23
Signature
utils()Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.cli.__init__ import utils
result = utils()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (0)
No public classes detected.