Module: sarpyx.utils.rfigen
File: sarpyx/utils/rfigen.py
No module docstring available; module purpose is inferred from implementation.
Exported Symbols (__all__)
No explicit __all__ list. Public symbols inferred from implementation.
Public Functions (4)
freq2wavelen function
inferred from implementation.
File location: sarpyx/utils/rfigen.py:19
Signature
freq2wavelen(f_hz)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
f_hz | inferred from implementation | yes | - | 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.utils.rfigen import freq2wavelen
result = freq2wavelen(f_hz=<f_hz>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
fspl function
inferred from implementation.
File location: sarpyx/utils/rfigen.py:23
Signature
fspl(r_m, wavelen_m)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
r_m | inferred from implementation | yes | - | inferred from implementation. |
wavelen_m | inferred from implementation | yes | - | 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.utils.rfigen import fspl
result = fspl(r_m=<r_m>, wavelen_m=<wavelen_m>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
sentinel1_receive_times function
Return relative times of the first stored complex sample in each line.
File location: sarpyx/utils/rfigen.py:27
Signature
sentinel1_receive_times(metadata: Sequence[Mapping[str, Any]])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metadata | Sequence[Mapping[str, Any]] | yes | - | inferred from implementation. |
Return Type
np.ndarray
inferred from implementation.
Exceptions
ValueError
Side Effects
None explicitly documented; inferred from implementation.
Example Usage
from sarpyx.utils.rfigen import sentinel1_receive_times
headers = [
dict(pri=600e-6, swst=100e-6, pri_count=count,
coarse_time=1000, fine_time=fine, range_decimation=8,
rx_channel_id=1, swath_number=10, data_take_id=1, signal_type=0)
for count, fine in ((100, 0.1), (101, 0.1006), (103, 0.1018))
]
receive_times = sentinel1_receive_times(headers)
Edge Cases
May raise: ValueError.
GenerateRFISignal function
Generate RFI at acquisition sample times, or explicitly replay legacy RFI.
File location: sarpyx/utils/rfigen.py:173
Signature
GenerateRFISignal(sqd: np.ndarray, RadPar: Mapping[str, float] | None=None, verbose: bool=False, *, mode: str='acquisition', line_start_times: Sequence[float] | None=None, seed: int | None=None, parameters: Mapping[str, float] | None=None, affected_az: tuple[int, int] | None=None, affected_rg: tuple[int, int] | None=None, generator_revision: str | None=None)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sqd | np.ndarray | yes | - | inferred from implementation. |
RadPar | Mapping[str, float] | None | no | None | inferred from implementation. |
verbose | bool | no | False | inferred from implementation. |
mode | str | no | 'acquisition' | inferred from implementation. |
line_start_times | Sequence[float] | None | no | None | inferred from implementation. |
seed | int | None | no | None | inferred from implementation. |
parameters | Mapping[str, float] | None | no | None | inferred from implementation. |
affected_az | tuple[int, int] | None | no | None | inferred from implementation. |
affected_rg | tuple[int, int] | None | no | None | inferred from implementation. |
generator_revision | str | None | no | None | inferred from implementation. |
Return Type
tuple[np.ndarray, dict]
inferred from implementation.
Exceptions
ValueError
Side Effects
- emits RuntimeWarning for legacy mode or zero overlap
- advances global NumPy RNG state in legacy mode
- reads module source for acquisition-mode provenance
Example Usage
import numpy as np
from sarpyx.utils.rfigen import GenerateRFISignal
echo = np.ones((8, 200), dtype=np.complex64)
radar = {"fs": 4e6, "fo": 5.405e9, "bw": 1e6}
interference, parameters = GenerateRFISignal(
echo, radar, line_start_times=np.arange(8) * 600e-6, seed=12,
parameters={"pulse_start": 0, "duty": 0.8},
affected_az=(0, 8), affected_rg=(0, 200),
)
# Replay the historical model; its timing limits still apply.
np.random.seed(12)
legacy_interference, legacy_parameters = GenerateRFISignal(
echo, radar, mode="legacy",
)
Edge Cases
May raise: ValueError. Includes optional parameters with implementation-defined fallback behavior.
Public Classes (0)
No public classes detected.