Module: sarpyx.processor.core.subaperture
File: sarpyx/processor/core/subaperture.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 (1)
DeHammWin function
Applies a modified Hamming window to the input signal and adjusts the imaginary part of the result.
File location: sarpyx/processor/core/subaperture.py:10
Signature
DeHammWin(signal, coeff)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
signal | inferred from implementation | yes | - | input signal to be processed, expected as array of complex numbers |
coeff | inferred from implementation | yes | - | coefficient for the Hamming window, typically between 0 and 1 |
Return Type
inferred from implementation
numpy.ndarray : processed signal after applying the Hamming window
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.processor.core.subaperture import DeHammWin
result = DeHammWin(signal=<signal>, coeff=<coeff>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (1)
CombinedSublooking class
inferred from implementation.
File location: sarpyx/processor/core/subaperture.py:45
Class Signature
class CombinedSublookingConstructor Parameters
Return Type
CombinedSublooking instances.
Exceptions
Construction/runtime exceptions are inferred from implementation and method-level documentation.
Side Effects
See method-level side effects below.
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
obj = CombinedSublooking(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (9)
CombinedSublooking.FrequencyComputation method
Calculate the min, max and central frequencies of each sublook.
File location: sarpyx/processor/core/subaperture.py:112
Signature
FrequencyComputation(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
VERBOSE | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
List: central frequencies for each sublook List: minimum frequencies for each sublook List: maximum frequencies for each sublook
Exceptions
ValueError
Side Effects
- io
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.FrequencyComputation()Edge Cases
May raise: ValueError. Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.CalcFrequencyVectors method
Define a zero-centred frequency vector from the number of sampled points along the axis of analysis and the specified bandwidth or PRF.
File location: sarpyx/processor/core/subaperture.py:176
Signature
CalcFrequencyVectors(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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
- io
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.CalcFrequencyVectors()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.SpectrumComputation method
"
File location: sarpyx/processor/core/subaperture.py:196
Signature
SpectrumComputation(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
VERBOSE | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
Spectrum array of complex numbers.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.SpectrumComputation()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.SpectrumNormalization method
Address singal attenuation by normalizing frequency spectrum to the average value by row or column and scale by average intensity of the image.
File location: sarpyx/processor/core/subaperture.py:227
Signature
SpectrumNormalization(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
VERBOSE | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
SpectrumOneDimNorm: Normalized spectrum.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.SpectrumNormalization()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.SpectrumDeWeighting method
Call the appropiate deweighting function
File location: sarpyx/processor/core/subaperture.py:254
Signature
SpectrumDeWeighting(self)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.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.SpectrumDeWeighting()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
CombinedSublooking.AverageDeWe method
inferred from implementation.
File location: sarpyx/processor/core/subaperture.py:264
Signature
AverageDeWe(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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
- inferred from implementation
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.AverageDeWe()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.AncillaryDeWe method
Reverse the effect of a previously applied Hamming window.
File location: sarpyx/processor/core/subaperture.py:291
Signature
AncillaryDeWe(self, VERBOSE=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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
- inferred from implementation
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.AncillaryDeWe()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.Generation method
Generate the sublooks
File location: sarpyx/processor/core/subaperture.py:353
Signature
Generation(self, VERBOSE=True)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
VERBOSE | inferred from implementation | no | True | inferred from implementation. |
Return Type
inferred from implementation
numpy.array: 3D array of complex numbers of size [nLooks, x, y].
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.processor.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.Generation()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
CombinedSublooking.chain method
inferred from implementation.
File location: sarpyx/processor/core/subaperture.py:448
Signature
chain(self)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.core.subaperture import CombinedSublooking
# Constructor arguments are inferred from implementation.
obj = CombinedSublooking(...) # inferred from implementation
result = obj.chain()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.