Module: sarpyx.cli.shipdet
File: sarpyx/cli/shipdet.py
Ship Detection CLI Tool for SARPyX. This module provides a command-line interface for ship detection using SNAP's GPT engine with adaptive thresholding and object discrimination.
Exported Symbols (__all__)
No explicit __all__ list. Public symbols inferred from implementation.
Public Functions (4)
create_parser function
Create the argument parser for ship detection.
File location: sarpyx/cli/shipdet.py:26
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.shipdet import create_parser
result = create_parser()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
validate_arguments function
Validate command line arguments.
File location: sarpyx/cli/shipdet.py:161
Signature
validate_arguments(args: argparse.Namespace) -> NoneParameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
args | argparse.Namespace | yes | - | Parsed command line arguments. |
Return Type
None
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.cli.shipdet import validate_arguments
result = validate_arguments(args=<args>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
run_ship_detection function
Execute ship detection processing pipeline.
File location: sarpyx/cli/shipdet.py:216
Signature
run_ship_detection(args: argparse.Namespace) -> Optional[str]Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
args | argparse.Namespace | yes | - | Parsed command line arguments. |
Return Type
Optional[str]
Path to final output product, or None if processing failed.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.cli.shipdet import run_ship_detection
result = run_ship_detection(args=<args>)Edge Cases
Documented return may be None for some execution paths.
main function
Main entry point for ship detection CLI.
File location: sarpyx/cli/shipdet.py:310
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.shipdet import main
result = main()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (0)
No public classes detected.