Module: sarpyx.processor.algorithms.mbautofocus
File: sarpyx/processor/algorithms/mbautofocus.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 (0)
No public top-level functions detected.
Public Classes (3)
estimate_V_eff class
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:13
Class Signature
class estimate_V_eff
Constructor Parameters
Return Type
estimate_V_eff 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.algorithms.mbautofocus import estimate_V_eff
obj = estimate_V_eff(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (1)
estimate_V_eff.forward method
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:24
Signature
forward(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.algorithms.mbautofocus import estimate_V_eff
# Constructor arguments are inferred from implementation.
obj = estimate_V_eff(...) # inferred from implementation
result = obj.forward()
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
estimate_D class
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:36
Class Signature
class estimate_D
Constructor Parameters
Return Type
estimate_D 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.algorithms.mbautofocus import estimate_D
obj = estimate_D(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (1)
estimate_D.forward method
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:49
Signature
forward(self, V)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
V | 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.processor.algorithms.mbautofocus import estimate_D
# Constructor arguments are inferred from implementation.
obj = estimate_D(...) # inferred from implementation
result = obj.forward(V=<V>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Focalizer class
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:57
Class Signature
class Focalizer
Constructor Parameters
Return Type
Focalizer 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.algorithms.mbautofocus import Focalizer
obj = Focalizer(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (3)
Focalizer.fft2D method
Perform FFT on radar data along range and azimuth lines.
File location: sarpyx/processor/algorithms/mbautofocus.py:73
Signature
fft2D(x)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
x | inferred from implementation | yes | - | Input tensor of shape [batch, channels, height, width]. |
Return Type
inferred from implementation
torch.Tensor: Transformed tensor after FFT operations.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.processor.algorithms.mbautofocus import Focalizer
# Constructor arguments are inferred from implementation.
obj = Focalizer(...) # inferred from implementation
result = obj.fft2D(x=<x>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Focalizer.extract_velocity method
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:127
Signature
extract_velocity(metadata)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metadata | 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.processor.algorithms.mbautofocus import Focalizer
# Constructor arguments are inferred from implementation.
obj = Focalizer(...) # inferred from implementation
result = obj.extract_velocity(metadata=<metadata>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Focalizer.forward method
inferred from implementation.
File location: sarpyx/processor/algorithms/mbautofocus.py:155
Signature
forward(self, x)
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
x | 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.processor.algorithms.mbautofocus import Focalizer
# Constructor arguments are inferred from implementation.
obj = Focalizer(...) # inferred from implementation
result = obj.forward(x=<x>)
Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.