Module: sarpyx.utils.complex_losses-OLD

File: sarpyx/utils/complex_losses-OLD.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 (14)

loss_split_mse function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:5

Signature

loss_split_mse(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_split_mse

result = loss_split_mse(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_complex_l2 function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:9

Signature

loss_complex_l2(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_complex_l2

result = loss_complex_l2(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_complex_l1 function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:13

Signature

loss_complex_l1(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_complex_l1

result = loss_complex_l1(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_mag_l2 function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:17

Signature

loss_mag_l2(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_mag_l2

result = loss_mag_l2(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_log_mag function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:20

Signature

loss_log_mag(pred: torch.Tensor, target: torch.Tensor, eps=1e-06)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-inferred from implementation.
epsinferred from implementationno1e-06inferred 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.complex_losses-OLD import loss_log_mag

result = loss_log_mag(pred=<pred>, target=<target>)

Edge Cases

Includes optional parameters with implementation-defined fallback behavior.

loss_amp_phase function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:24

Signature

loss_amp_phase(pred: torch.Tensor, target: torch.Tensor, w_phase=1.0)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-inferred from implementation.
w_phaseinferred from implementationno1.0inferred 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.complex_losses-OLD import loss_amp_phase

result = loss_amp_phase(pred=<pred>, target=<target>)

Edge Cases

Includes optional parameters with implementation-defined fallback behavior.

loss_power_consistency function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:30

Signature

loss_power_consistency(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_power_consistency

result = loss_power_consistency(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_symmetry function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:35

Signature

loss_symmetry(pred: torch.Tensor, sym_op)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
sym_opinferred from implementationyes-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.complex_losses-OLD import loss_symmetry

result = loss_symmetry(pred=<pred>, sym_op=<sym_op>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_complex_tv function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:40

Signature

loss_complex_tv(pred: torch.Tensor, p=1)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
pinferred from implementationno1inferred 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.complex_losses-OLD import loss_complex_tv

result = loss_complex_tv(pred=<pred>)

Edge Cases

Includes optional parameters with implementation-defined fallback behavior.

loss_phase_smooth function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:48

Signature

loss_phase_smooth(pred: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-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.complex_losses-OLD import loss_phase_smooth

result = loss_phase_smooth(pred=<pred>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_grad_match function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:55

Signature

loss_grad_match(pred: torch.Tensor, target: torch.Tensor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-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.complex_losses-OLD import loss_grad_match

result = loss_grad_match(pred=<pred>, target=<target>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

loss_speckle_nll function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:73

Signature

loss_speckle_nll(pred: torch.Tensor, target: torch.Tensor, variance: float=1.0)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-inferred from implementation.
variancefloatno1.0inferred 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.complex_losses-OLD import loss_speckle_nll

result = loss_speckle_nll(pred=<pred>, target=<target>)

Edge Cases

Includes optional parameters with implementation-defined fallback behavior.

loss_adversarial function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:80

Signature

loss_adversarial(pred: torch.Tensor, discriminator, real_label=1.0, fake_label=0.0)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
discriminatorinferred from implementationyes-inferred from implementation.
real_labelinferred from implementationno1.0inferred from implementation.
fake_labelinferred from implementationno0.0inferred 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.complex_losses-OLD import loss_adversarial

result = loss_adversarial(pred=<pred>, discriminator=<discriminator>)

Edge Cases

Includes optional parameters with implementation-defined fallback behavior.

loss_feature function

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:87

Signature

loss_feature(pred: torch.Tensor, target: torch.Tensor, feature_extractor)

Parameters

ParameterTypeRequiredDefaultDescription
predtorch.Tensoryes-inferred from implementation.
targettorch.Tensoryes-inferred from implementation.
feature_extractorinferred from implementationyes-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.complex_losses-OLD import loss_feature

result = loss_feature(pred=<pred>, target=<target>, feature_extractor=<feature_extractor>)

Edge Cases

No explicit edge-case section found; behavior is inferred from implementation.

Public Classes (1)

ComplexLossComposite class

inferred from implementation.

File location: sarpyx/utils/complex_losses-OLD.py:92

Class Signature

class ComplexLossComposite

Constructor Parameters

Return Type

ComplexLossComposite 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.utils.complex_losses-OLD import ComplexLossComposite

obj = ComplexLossComposite(...)  # inferred from implementation

Edge Cases

No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.

Public Methods (0)

No public methods detected.