Module: sarpyx.sla.core.spectrum
File: sarpyx/sla/core/spectrum.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 (2)
center_frequency function
Centers a frequency vector around the specified central frequency of a sensor.
File location: sarpyx/sla/core/spectrum.py:36
Signature
center_frequency(array, freq_c, printout=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
array | inferred from implementation | yes | - | The input frequency vector to be centered. |
freq_c | inferred from implementation | yes | - | The target central frequency to align the array around. |
printout | inferred from implementation | no | False | If True, prints the original vector, the rotated vector, and the new center frequency. Defaults to False. |
Return Type
inferred from implementation
numpy.ndarray: The rotated frequency vector with the specified central frequency aligned.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.sla.core.spectrum import center_frequency
result = center_frequency(array=<array>, freq_c=<freq_c>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
DeHammWin function
Applies a modified Hamming window to the input signal and adjusts the imaginary part of the result.
File location: sarpyx/sla/core/spectrum.py:81
Signature
DeHammWin(Isign, coeff)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Isign | inferred from implementation | yes | - | array-like The input signal to be processed. It is expected to be a sequence of complex numbers. |
coeff | inferred from implementation | yes | - | float The coefficient for the Hamming window. Typically, this value is between 0 and 1. |
Return Type
inferred from implementation
numpy.ndarray The processed signal after applying the Hamming window and adjusting the imaginary part.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.sla.core.spectrum import DeHammWin
result = DeHammWin(Isign=<Isign>, coeff=<coeff>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (1)
SubLookAnalysis class
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:125
Class Signature
class SubLookAnalysisConstructor Parameters
Return Type
SubLookAnalysis 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.sla.core.spectrum import SubLookAnalysis
obj = SubLookAnalysis(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (6)
SubLookAnalysis.frequencyComputation method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:194
Signature
frequencyComputation(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
- io
Example Usage
from sarpyx.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.frequencyComputation()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
SubLookAnalysis.SpectrumComputation method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:272
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
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- io
Example Usage
from sarpyx.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.SpectrumComputation()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
SubLookAnalysis.SpectrumDeWeighting method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:320
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.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.SpectrumDeWeighting()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
SubLookAnalysis.AverageSpectrumDeWe method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:327
Signature
AverageSpectrumDeWe(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.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.AverageSpectrumDeWe()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
SubLookAnalysis.AncillaryDeWe method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:345
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
- io
Example Usage
from sarpyx.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.AncillaryDeWe()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
SubLookAnalysis.Generation method
inferred from implementation.
File location: sarpyx/sla/core/spectrum.py:408
Signature
Generation(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.sla.core.spectrum import SubLookAnalysis
# Constructor arguments are inferred from implementation.
obj = SubLookAnalysis(...) # inferred from implementation
result = obj.Generation()Edge Cases
Includes optional parameters with implementation-defined fallback behavior.