General toolkit.

Odak provides a set of functions that can be used for general purpose work, such as saving an image file or loading a three-dimensional point cloud of an object. These functions are helpful for general use and provide consistency across routine works in loading and saving routines. When working with odak, we strongly suggest sticking to the general toolkit to provide a coherent solution to your task.

Engineering notes

Note	Description
Working with images	This engineering note will give you an idea about how read and write images using odak.
Working with dictionaries	This engineering note will give you an idea about how read and write dictionaries using odak.

odak.learn.tools

This submodule is based on torch, therefore the functions provided here are differentiable and can be used with provided optimizers in torch.

Function	Description
odak.learn.tools.peak_signal_to_noise_ratio	Calculates signal-to-noise-ratio with respect to a ground truth.

odak.tools

This submodule is based on numpy. If you are using functions outside of odak.learn submodule, we recommend you to use this specific set of tools. Note that there are also corner case like loading a dictionary when using odak.learn, which does not necessarily require to work with odak.learn.tools as odak.tools.load_dictionary works with numpy or torch. In such cases, odak.tools is the go to submodule.

Function	Description
odak.tools.check_directory	Check if directory exist, if not create it.
odak.tools.convert_bytes	Convert bytes to other units (e.g., MB).
odak.tools.load_image	Load an image.
odak.tools.load_dictionary	Load a dictionary.
odak.tools.list_files	List files in a given path.
odak.tools.resize_image	Resize a given image.
odak.tools.save_image	Save as an image.
odak.tools.save_dictionary	Save a dictionary.
odak.tools.size_of_a_file	Geet size of a file in units (e.g., MB).
odak.tools.shell_command	Trigger a shell command.