Module: sarpyx.processor.data.readers
File: sarpyx/processor/data/readers.py
SAR data readers for various formats. This module contains readers for different SAR data formats including Sentinel-1, COSMO-SkyMed, TerraSAR-X, and other mission data.
Exported Symbols (__all__)
read_sentinel1read_cosmo_skymedread_terrasar_xread_tifread_zarr_file
Public Functions (5)
read_sentinel1 function
Reader for Sentinel-1 data.
File location: sarpyx/processor/data/readers.py:13
Signature
read_sentinel1()
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.processor.data.readers import read_sentinel1
result = read_sentinel1()
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
read_cosmo_skymed function
Reader for COSMO-SkyMed data.
File location: sarpyx/processor/data/readers.py:18
Signature
read_cosmo_skymed()
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.processor.data.readers import read_cosmo_skymed
result = read_cosmo_skymed()
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
read_terrasar_x function
Reader for TerraSAR-X data.
File location: sarpyx/processor/data/readers.py:22
Signature
read_terrasar_x()
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.processor.data.readers import read_terrasar_x
result = read_terrasar_x()
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
read_tif function
inferred from implementation.
File location: sarpyx/processor/data/readers.py:28
Signature
read_tif(tif_path, verbose=False)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tif_path | inferred from implementation | yes | - | inferred from implementation. |
verbose | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- filesystem
- io
Example Usage
from sarpyx.processor.data.readers import read_tif
result = read_tif(tif_path=<tif_path>)
Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
read_zarr_file function
Read and extract data from a .zarr file.
File location: sarpyx/processor/data/readers.py:48
Signature
read_zarr_file(file_path, array_or_group_key=None)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file_path | inferred from implementation | yes | - | inferred from implementation. |
array_or_group_key | inferred from implementation | no | None | inferred from implementation. |
Return Type
inferred from implementation
Zarr array or group, depending on what is stored in the file.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- filesystem
Example Usage
from sarpyx.processor.data.readers import read_zarr_file
result = read_zarr_file(file_path=<file_path>)
Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
Public Classes (0)
No public classes detected.