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 (3)
freq2wavelen function
inferred from implementation.
File location: sarpyx/utils/rfigen.py:4
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:7
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.
GenerateRFISignal function
Generate Radio Frequency Interference (RFI) signal for SAR data.
File location: sarpyx/utils/rfigen.py:10
Signature
GenerateRFISignal(sqd, RadPar=None, verbose=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sqd | inferred from implementation | yes | - | Input SAR single look complex data with shape (rows, cols). |
RadPar | inferred from implementation | no | None | Radar parameters containing: - 'bw': Bandwidth in Hz - 'fo': Center frequency in Hz - 'fs': Sampling frequency in Hz |
verbose | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
tuple: A tuple containing: - sInterf (np.ndarray): Generated interference signal with same shape as sqd - IR (dict): Dictionary containing RFI parameters used in generation
Exceptions
ValueError
Side Effects
- io
Example Usage
from sarpyx.utils.rfigen import GenerateRFISignal
result = GenerateRFISignal(sqd=<sqd>)Edge Cases
May raise: ValueError. Includes optional parameters with implementation-defined fallback behavior.
Public Classes (0)
No public classes detected.