visionsim.utils package

Submodules

visionsim.utils.color module

visionsim.utils.color.srgb_to_linearrgb(img: torch.Tensor | npt.NDArray[np.floating]) → torch.Tensor | npt.NDArray[np.floating]

Performs sRGB to linear RGB color space conversion by reversing gamma correction and obtaining values that represent the scene’s intensities.

Parameters:

img (torch.Tensor | npt.NDArray) – Image to un-tonemap.

Returns:

linear rgb image.

visionsim.utils.color.linearrgb_to_srgb(img: torch.Tensor | npt.NDArray) → torch.Tensor | npt.NDArray

Performs linear RGB to sRGB color space conversion to apply gamma correction for display purposes.

Parameters:

img (torch.Tensor | npt.NDArray) – Image to tonemap.

Returns:

tonemapped rgb image.

visionsim.utils.progress module

class visionsim.utils.progress.ElapsedProgress(*columns: str | ProgressColumn, console: Console | None = None, auto_refresh: bool = True, refresh_per_second: float = 10, speed_estimate_period: float = 30.0, transient: bool = False, redirect_stdout: bool = True, redirect_stderr: bool = True, get_time: Callable[[], float] | None = None, disable: bool = False, expand: bool = False)

Bases: Progress

classmethod get_default_columns() → tuple[ProgressColumn, ...]

Overrides rich.progress.Progress’s default columns to enable showing elapsed time when finished.

class visionsim.utils.progress.PoolProgress(*args, auto_visible=True, description='[green]Total progress:', **kwargs)

Bases: Progress

Convenience wrapper around rich’s Progress to enable progress bars when using multiple processes. All progressbar updates are carried out by the main process, and worker processes communicate their state via a callback obtained when a task gets added.

Example

import multiprocessing

def long_task(tick, min_len=50, max_len=200):
    import random, time

    length = random.randint(min_len, max_len)
    tick(total=length)

    for _ in range(length):
        time.sleep(0.01)
        tick(advance=1)


if __name__ == "__main__":
    with multiprocessing.Pool(4) as pool, PoolProgress() as progress:
        for i in range(25):
            tick = progress.add_task(f"Task: {i}")
            pool.apply_async(long_task, (tick, ))
        progress.wait()
        pool.close()
        pool.join()

__init__(*args, auto_visible=True, description='[green]Total progress:', **kwargs) → None

Initialize a PoolProgress instance.

Note

All other *args and **kwargs are passed as is to rich.progress.Progress.

Parameters:

• auto_visible (bool, optional) – if true, automatically hides tasks that have not started or finished tasks. Defaults to True.

• description (str, optional) – text description for the overall progress. Defaults to “[green]Total progress:”.

classmethod get_default_columns() → tuple[ProgressColumn, ...]

Overrides rich.progress.Progress’s default columns to enable showing elapsed time when finished.

static update_task(progress: multiprocessing.Queue[dict], task_id: TaskID, **kwargs) → None

task_percentage(task_id: TaskID) → float

task_finished(task_id: TaskID) → bool

add_task(*args, **kwargs) → UpdateFn

Same as Progress.add_task except it returns a callback to update the task instead of the task-id. The returned callback is roughly equivalent to Progress.update with it’s first argument (the task-id) already filled out, except calling it will not immediately update the task’s status. The main process will perform the update asynchronously.

wait() → None

Block and wait for tasks to finish.

Note

This is what actually updates the progress bars, if not called before exiting the with-block no progress will be reported, and processes might be killed.

Module contents