Kalmus

This is the official release of KALMUS 1.3.14 version.

**Add features**

Now, you can rotate the 3D Bar plot in the *Colors in Hue Light 3D Bar Plot window with arrow keys. <Left> rotate counter-clockwise, <Right> rotate clockwise, <Up> from down to up, and <Down> from up to down.

**Changes**

Default key bindings of `matplotlib` plot are removed.

The light axis of the 3D Bar plot is inverted. In the default view, the bright colors are now in the foreground.

This is the official release of KALMUS 1.3.13 version.

**Add features**

Color swatch. A small color display is now added to the main window under the barcode plots. When the user's mouse hovers over a pixel of the barcode, the color display will show the color of that pixel along with red, blue, green, frame, and time at that pixel.

<img src="https://user-images.githubusercontent.com/69224866/175841286-871c01b8-8553-4386-8099-5439676d0436.png" width="700">

For the brightness barcode, the color display will show the brightness instead.

<img src="https://user-images.githubusercontent.com/69224866/175841872-bdd3ec86-71c3-43d0-8a00-73967aff0119.png" width="700">

More configuration available for the Hue vs. Light 3D bar plot:
<img src="https://user-images.githubusercontent.com/69224866/175841427-5a45bd62-75fa-4c50-9236-3645c86f3fc4.png" width="550">

Users may now turn on/off the shade on 3D objects, grids, and axis. The resolution of the plot (in the other words, the dimension of a 3D bar) can also be configured in the plot resolutions section. Smaller bar width on Hue/Light axis will increase the number of 3D bars in the plot (higher resolution), providing more details. Larger width will decrease the number of 3D bars and improve the performance (e.g. the refreshing speed when spinning or zooming the plot). Users can also switch to 7 pre-defined camera positions using the Camera Views.

Users can configure the plot resolution (dpi) when launching the KALMUS GUI using the -d/--dpi flag: `$ kalmus-gui --dpi 160` or $ kalmus-gui -d 160`. The default dpi of the GUI is 120.

<img src="https://user-images.githubusercontent.com/69224866/175842087-d89e1d92-5825-4bcc-b824-45d1aa6e0cb4.png" width="200">

**Changes**

When users click the browse button in the Generate barcode/Load JSON barcode window, KALMUS GUI will open the last closed folder rather than the current working directory.

**Fixes**

Fix the crash caused by generating and saving a barcode to an invalid JSON output file path. If you are using the save output barcode to JSON function added in v1.3.11, we recommend you update KALMUS to this new release. The KALMUS GUI may crash if you give an invalid file path to the output JSON file.

This is the beta prerelease of KALMUS 1.3.13 version.

**Add features**

Color swatch. A small color display is now added to the main window under the barcode plots. When the user's mouse hovers over a pixel of the barcode, the color display will show the color of that pixel along with red, blue, green, frame, and time at that pixel.

<img src="https://user-images.githubusercontent.com/69224866/175841286-871c01b8-8553-4386-8099-5439676d0436.png" width="700">

For the brightness barcode, the color display will show the brightness instead.

<img src="https://user-images.githubusercontent.com/69224866/175841872-bdd3ec86-71c3-43d0-8a00-73967aff0119.png" width="700">

More configuration available for the Hue vs. Light 3D bar plot:
<img src="https://user-images.githubusercontent.com/69224866/175841427-5a45bd62-75fa-4c50-9236-3645c86f3fc4.png" width="550">

Users may now turn on/off the shade on 3D objects, grids, and axis. The resolution of the plot (in the other words, the dimension of a 3D bar) can also be configured in the plot resolutions section. Smaller bar width on Hue/Light axis will increase the number of 3D bars in the plot (higher resolution), providing more details. Larger width will decrease the number of 3D bars and improve the performance (e.g. the refreshing speed when spinning or zooming the plot). Users can also switch to 7 pre-defined camera positions using the Camera Views.

Users can configure the plot resolution (dpi) when launching the KALMUS GUI using the -d/--dpi flag: `$ kalmus-gui --dpi 160` or $ kalmus-gui -d 160`. The default dpi of the GUI is 120.

<img src="https://user-images.githubusercontent.com/69224866/175842087-d89e1d92-5825-4bcc-b824-45d1aa6e0cb4.png" width="200">

**Changes**

When users click the browse button in the Generate barcode/Load JSON barcode window, KALMUS GUI will open the last closed folder rather than the current working directory.

**Fixes**

Fix the crash caused by generating and saving a barcode to an invalid JSON output file path. If you are using the save output barcode to JSON function added in v1.3.11, we recommend you update KALMUS to this new release. The KALMUS GUI may crash if you give an invalid file path to the output JSON file.

This is the official release of KALMUS 1.3.12 version.

**Add features**

3D Bar plot of Hue vs. Light is now available in the Inspect Barcode window.

<img src="https://user-images.githubusercontent.com/69224866/174497362-5401deae-0c4b-4768-9505-d1635ae556da.png" width="450">

Click the `Hue vs. Light Bar Plot` button to instantiate the plot.

3D Bar plot without shade:
<img src="https://user-images.githubusercontent.com/69224866/174497199-58a1d56f-ba6f-4342-b19d-0b6f76540f3c.png" width="450">

You can press the left mouse key to rotate the 3D plot or press the right mouse key to zoom in and out.

Users can select whether they want the 3D bar object to be shaded or not using the radio buttons below the plot.

Shaded 3D Bar plot:
<img src="https://user-images.githubusercontent.com/69224866/174497279-6661b65d-7a28-4bf6-868f-a314605696a3.png" width="450">

This functionality is also accessible through Programming API with call to [`show_colors_in_hue_light_3d_bar_plot`](https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/kalmus/utils/visualization_utils.py#L464) in [`kalmus.utils.visualization_utils`](https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/kalmus/utils/visualization_utils.py).

**Changes**

The `Calibrate` button has been removed from the Check Time Point window. This button was used to fix the time-pixel relation in the barcode after rescaling/resizing the barcode. However, since version 1.3.1, KALMUS GUI automatically recalibrates the barcode when its size changes. The `Calibrate` button is no longer needed if you are using JSON barcodes generated from version 1.3.1 and onward.

Display button has been removed from the Check Time Point Window. KALMUS will always display the saved frames if they are available.

For barcodes without saved frames:
<img src="https://user-images.githubusercontent.com/69224866/174497709-d8bf3478-9010-48b3-b995-b726dfbd358f.png" width="300">

For barcodes with saved frames:
<img src="https://user-images.githubusercontent.com/69224866/174497784-f1818b92-9775-4ca2-8a34-9bf50ab13134.png" width="500">

The Check Time Point window is always on top once generated.

**Fixes**

In the previous version, KALMUS will always show the longer barcode at the bottom of the window, which can be confusing. Now, a new barcode loaded from the memory/JSON object will be plotted in the exact slot selected by users.

This is the alpha prerelease of KALMUS 1.3.12 version.

**Add features**

3D Bar plot of Hue vs. Light is now available in the Inspect Barcode window.

<img src="https://user-images.githubusercontent.com/69224866/174497362-5401deae-0c4b-4768-9505-d1635ae556da.png" width="450">

Click the `Hue vs. Light Bar Plot` button to instantiate the plot.

3D Bar plot without shade:
<img src="https://user-images.githubusercontent.com/69224866/174497199-58a1d56f-ba6f-4342-b19d-0b6f76540f3c.png" width="450">

You can press the left mouse key to rotate the 3D plot or press the right mouse key to zoom in and out.

Users can select whether they want the 3D bar object to be shaded or not using the radio buttons below the plot.

Shaded 3D Bar plot:
<img src="https://user-images.githubusercontent.com/69224866/174497279-6661b65d-7a28-4bf6-868f-a314605696a3.png" width="450">

This functionality is also accessible through Programming API with call to [`show_colors_in_hue_light_3d_bar_plot`](https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/kalmus/utils/visualization_utils.py#L464) in [`kalmus.utils.visualization_utils`](https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/kalmus/utils/visualization_utils.py).

**Changes**

The `Calibrate` button has been removed from the Check Time Point window. This button was used to fix the time-pixel relation in the barcode after rescaling/resizing the barcode. However, since version 1.3.1, KALMUS GUI automatically recalibrates the barcode when its size changes. The `Calibrate` button is no longer needed if you are using JSON barcodes generated from version 1.3.1 and onward.

Display button has been removed from the Check Time Point Window. KALMUS will always display the saved frames if they are available.

For barcodes without saved frames:
<img src="https://user-images.githubusercontent.com/69224866/174497709-d8bf3478-9010-48b3-b995-b726dfbd358f.png" width="300">

For barcodes with saved frames:
<img src="https://user-images.githubusercontent.com/69224866/174497784-f1818b92-9775-4ca2-8a34-9bf50ab13134.png" width="500">

The Check Time Point window is always on top once generated.

**Fixes**

In the previous version, KALMUS will always show the longer barcode at the bottom of the window, which can be confusing. Now, a new barcode loaded from the memory/JSON object will be plotted in the exact slot selected by users.

This is the official release of KALMUS 1.3.11 version.

**Add features**

A new button (**Default Setting**) is added in the Generate Barcode window.

<img src="https://user-images.githubusercontent.com/69224866/168917481-3d85c3e2-62cf-4686-9314-9af76cf52e53.png" width="600">

Clicking this button will fill in a set of default parameters for barcode generation:
- *Barcode Type*: Color
- *Frame Type*: Whole_frame
- *Color Metric*: Average
- *Acquisition unit*: Frame
- *Start at*: start (frame 0)
- *Total Frames*: end (whole video)
- *Sample every*: 2 (frames)
- *Save output*: Checked and if output path is not given, a default output path will be filled in.
- *Remove letterbox*: Auto
- *Save Frames*: Checked and save a frame every 4 seconds
- *Rescale Frames*: Unchecked

<img src="https://user-images.githubusercontent.com/69224866/168919244-798fb726-50bb-4bca-ab07-264c72975b55.png" width="600">

**Changes**

KALMUS GUI will now verify the extension of the output JSON/CSV file. If **.json**/**.csv** extension is missing, the GUI will automatically append it to the end of given path.

KALMUS GUI now gives warning to the users when saving barcode into JSON object fails.

<img src="https://user-images.githubusercontent.com/69224866/168921818-6fe8300a-57e1-4c9c-8476-5f96b07c4b03.png" width="450">

KALMUS GUI checks if a user selects a barcode when they try to save it as a JSON object. The software will attempt to save the barcode object only if a barcode is selected.

**Fixes**

Fixed the scikit-image ValueError which occurs when generating Hue vs. Light plot using [`show_colors_in_hue_light_scatter_plot`](https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/kalmus/utils/visualization_utils.py#L347).