Module: sarpyx.processor.utils.viz
File: sarpyx/processor/utils/viz.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 (9)
plot_with_logscale function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:15
Signature
plot_with_logscale(res, k=1)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
res | inferred from implementation | yes | - | inferred from implementation. |
k | inferred from implementation | no | 1 | 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.utils.viz import plot_with_logscale
result = plot_with_logscale(res=<res>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
plot_with_cdf function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:25
Signature
plot_with_cdf(img, figsize=(22, 22), savepath=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
img | inferred from implementation | yes | - | inferred from implementation. |
figsize | inferred from implementation | no | (22, 22) | inferred from implementation. |
savepath | inferred from implementation | no | None | 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.utils.viz import plot_with_cdf
result = plot_with_cdf(img=<img>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
plot2_with_cdf function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:41
Signature
plot2_with_cdf(img1, img2)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
img1 | inferred from implementation | yes | - | inferred from implementation. |
img2 | 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.utils.viz import plot2_with_cdf
result = plot2_with_cdf(img1=<img1>, img2=<img2>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
get_lognorm function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:66
Signature
get_lognorm(output_data)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
output_data | 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.utils.viz import get_lognorm
result = get_lognorm(output_data=<output_data>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
find_checkpoint function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:73
Signature
find_checkpoint(folder)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder | 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.utils.viz import find_checkpoint
result = find_checkpoint(folder=<folder>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
plot_histogram function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:78
Signature
plot_histogram(img, xlim=[0, 500], savepath=None)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
img | inferred from implementation | yes | - | inferred from implementation. |
xlim | inferred from implementation | no | [0, 500] | inferred from implementation. |
savepath | inferred from implementation | no | None | 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.utils.viz import plot_histogram
result = plot_histogram(img=<img>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
dump function
Save an object to a pickle file using joblib.
File location: sarpyx/processor/utils/viz.py:92
Signature
dump(obj, filename)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
obj | inferred from implementation | yes | - | The object to be saved. |
filename | inferred from implementation | yes | - | The name of the file where the object will be saved. |
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.utils.viz import dump
result = dump(obj=<obj>, filename=<filename>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
load function
Load an object from a pickle file.
File location: sarpyx/processor/utils/viz.py:102
Signature
load(filename)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | inferred from implementation | yes | - | The name of the file from which the object will be loaded. |
Return Type
inferred from implementation
object: The object loaded from the pickle file.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- filesystem
Example Usage
from sarpyx.processor.utils.viz import load
result = load(filename=<filename>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
main function
inferred from implementation.
File location: sarpyx/processor/utils/viz.py:115
Signature
main()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.processor.utils.viz import main
result = main()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Public Classes (0)
No public classes detected.