Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: finish haan taggit user guide migration #105

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions user-guide/docs/tools/visualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,11 @@

---

<!-- ## Basic Image Browsing and Mapping -->
<!-- moved from use cases -->

{% include-markdown '../usecases/haan/usecase.md' %}
{% include-markdown 'visualization/taggit-browse-map.md' %}

---

<!-- ## Grouping and Tagging Image Files -->
<!-- moved from use cases -->

{% include-markdown '../usecases/haan/usecase-2.md' %}
{% include-markdown 'visualization/taggit-categorize.md' %}

---

Expand Down
97 changes: 97 additions & 0 deletions user-guide/docs/tools/visualization/taggit-browse-map.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/// html | header

## Taggit User Guide: Basic Image Browsing and Mapping

Using HazMapper and Taggit to browse thumbnails of large numbers of images and map their locations

///


**Fred Haan – Calvin University **

_Keywords: Taggit, HazMapper, image browsing_

### Resources

The example makes use of the following DesignSafe resources:

* <https://hazmapper.tacc.utexas.edu/hazmapper>
* <https://hazmapper.tacc.utexas.edu/taggit>

### Description

This user guide demonstrates how to use HazMapper and Taggit applications on DesignSafe to browse through large numbers of image files. HazMapper and Taggit should be considered different ways of viewing the same set of images. You see a thumbnail Gallery of those images when you use Taggit, and you see a Map of those images when you use HazMapper, but it is the same *.hazmapper file in both cases.

NOTE: You always start a Map/Gallery file in HazMapper. All browsing/mapping starts with HazMapper, and you can switch back and forth between the apps as you wish. Also, at this time you cannot publish a Map/Gallery but this functionality is coming soon.

**Creating a Map/Gallery and Browsing Images**

Taggit and HazMapper allow you to browse and map image files that are on DesignSafe. This document shows you how to get started with Taggit and HazMapper for a set of images available on DesignSafe.

As an example workflow, we will consider a damage survey dataset from the December 2021 Midwest tornado outbreak (see below).

![](imgs/taggit-browse-map-001.png)

If you were looking at this project on DesignSafe, you might be interested in seeing the image files in the folder shown below.

![](imgs/taggit-browse-map-002.png)

In order to browse thumbnail images of these photographs or see them laid out on a map, you can launch HazMapper to get started.

NOTE: All browsing/mapping starts with HazMapper. HazMapper and Taggit are just different ways of viewing the same Map/Gallery.

So to get started, we launch HazMapper from the Visualization tab of the Tools and Applications page of the DesignSafe Workspace.


<!-- ![](imgs/taggit-browse-map-004.png) -->

Once HazMapper is up, click on “Create a New Map” as shown below:

![](imgs/taggit-browse-map-006.png)

Fill out a name and description of the “Map” you will create. This Map will also be a Gallery in Taggit. You then select a Save Location for your Map/Gallery by pulling down the menu on the right:


![](imgs/taggit-browse-map-007.png)

When you are selecting a Save Location, you should probably select from MyProjects. That way, you can share your Map/Gallery with other users. I selected a project called “Tornado Damage Research” as shown below.

<!-- ![](imgs/taggit-browse-map-008.png) -->

Next you click on Assets and Import from DesignSafe to load the images you want to see:

![](imgs/taggit-browse-map-009.png)

I'm going to select files from the StEER – 10 December 2021 Midwest Tornado Outbreak project:

![](imgs/taggit-browse-map-010.png)

Once you navigate to the folder containing the image files you want, you can use shift-select to select multiple files to import:

![](imgs/taggit-browse-map-011.png)

Once you press Import, you will see messages about successful imports on the right side of the screen:

![](imgs/taggit-browse-map-012.png)

### Browsing Thumbnail Images in Taggit

Once you've loaded your images, you can zoom in on your map to see the location of each photo. However, for this Taggit workflow demonstration, we will click on Manage and select View in Taggit as show below:

![](imgs/taggit-browse-map-014.png)

This will launch Taggit and show thumbnail images of all the photos that were just loaded in HazMapper. You can now browse through all the photos as shown below.

![](imgs/taggit-browse-map-015.png)

You can then add more photos to the Gallery using the pull-down menu in the upper-left corner. Selecting Import image from DesignSafe gives you access to all the files on DesignSafe.

![](imgs/taggit-browse-map-017.png)

If you want to go back to HazMapper and put all the photos on a map, click the View in HazMapper button in the upper right corner of the screen.

![](imgs/taggit-browse-map-018.png)

### References

* Kijewski-Correa et al. (2021) for PRJ-3349 StEER - 10 December 2021 Midwest Tornado Outbreak.
115 changes: 115 additions & 0 deletions user-guide/docs/tools/visualization/taggit-categorize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/// html | header

## Taggit User Guide: Grouping and Tagging Image Files

Using Taggit to categorize image files with groups and tags
///


**Fred Haan – Calvin University **

_Keywords: Taggit, HazMapper, image tagging, image grouping, image labeling_


### Resources

The example makes use of the following DesignSafe resources:

* <https://hazmapper.tacc.utexas.edu/hazmapper/>
* <https://hazmapper.tacc.utexas.edu/taggit/>

### Description

This user guide demonstrates how to use Taggit on DesignSafe to organize image files into groups and to tag images. The groups and tags can then be saved for use in other programs (for example, for machine learning applications) or be used to present a set of images in a clear and organized way.

**NOTE**: You always start a Map/Gallery file in HazMapper. HazMapper and Taggit should be considered different ways of viewing the same set of images. You see a thumbnail Gallery of those images when you use Taggit, and you see a Map of those images when you use HazMapper, but it is the same *.hazmapper file in both cases. Also, at this time you cannot publish a Map/Gallery but this functionality is coming soon.


Taggit enables you to organize images into groups and to tag images. This document shows you how to create groups and tags with Taggit.

NOTE: Galleries in Taggit and Maps in HazMapper are actually the same thing. Taggit and HazMapper are just different ways of viewing the same Gallery/Map.

All browsing/mapping starts with HazMapper and you can switch back and forth between the apps as you wish.

This example begins with a Gallery that has already been created. If you do not know how to create a Gallery yet, start with the Basic Browsing and Mapping document and then come back to this one.

### Creating Groups and Using the Taggit View

As an example workflow, we will consider a damage survey dataset from the December 2021 Midwest tornado outbreak (see below) and create some groups to organize these images.

![](imgs/taggit-categorize-001.png)

Clicking on any of the images, will put a blue border around the image and cause a Create Group to appear in the upper right corner as shown here:

<!-- ![](imgs/taggit-categorize-004.png) -->

Clicking on Create Group will bring up a window in which to type in a name for your new group as show here. I am creating a group for all the Grain bins.

![](imgs/taggit-categorize-005.png)

Two things then happen when you add this group. First, that image you selected become a part of the group, and you'll see a small colored square that indicates it is a part of the group (see below). Second, the Taggit button will appear in the upper right corner.

![](imgs/taggit-categorize-007.png)

If you hover your mouse near the colored square, you will see the name of the group like this:

<!-- ![](imgs/taggit-categorize-008.png) -->

If you click the Taggit button, the screen will switch from the Gallery view to the Taggit view as shown below. This view will show the groups you have created and the images that are in each group. You can click on each image name to show them enlarged on the left. The Gallery/Map button in the upper right will send you back to the Gallery view.

![](imgs/taggit-categorize-009.png)

### Adding Images to Groups

To add more images to a group, you have two options. One option is to hover over an image and use the icons that appear (see below). The plus icon will bring up the option to add this image to a group. The magnifying glass and recycle bin allow you to enlarge the image or remove it from the Gallery, respectively.

![](imgs/taggit-categorize-010.png)

The other option is to select a few images and then use the Add to Group button that appears when you select images as shown here. I selected two more grain bin images for this example.

![](imgs/taggit-categorize-011.png)

Any given image can belong to multiple groups as illustrated by the group icons here:

![](imgs/taggit-categorize-012.png)

When you create more groups and assign images to each group, the Taggit view will list them all as show here:

![](imgs/taggit-categorize-013.png)

### Changing icons for each group

In the list of Groups in the Taggit view (shown below), each group's icon is shown on the right. If you click on that icon, you can change use a pull-down menu to change it if you wish.

![](imgs/taggit-categorize-015.png)

Modified icons are shown below for each of the groups. These icons are then used when that group's images are plotted in HazMapper.

![](imgs/taggit-categorize-016.png)

### Creating Tags within each Group

Within a given group, you can create custom Tags by clicking on the “+” icon in the Tag Images portion of the Taggit view (see below):

![](imgs/taggit-categorize-017.png)

This will show the options for the types of Tags as shown below. You can create Tags that are just a text box (Text), a checkbox list, a radio button list, a dropdown menu of tag options, or a color tag. The color tag can be used to change the color that is displayed in HazMapper.

![](imgs/taggit-categorize-018.png)

For this example, I am creating a Checkbox tag. The Tag itself has a Label and then you add as many Options are you wish by entering the name of each Option and then pressing the “+” button to add it to the list. In what is shown below, I added “CMU” as an Option, pressed the “+” to add it. Now I am adding Red brick as an Option, and am about to press the “+” to add it.

Once I have added all my options with the “+” button, then I press Save and I now have a Checkbox for each image in my Masonry group.

![](imgs/taggit-categorize-020.png)

Clicking one of the Checkbox options will cause a Save Tags button to appear (as shown below). You do not have to click the Save Tags button between every Tag you enter, but you will need to click it before leaving the tagging of that group and going back to Gallery view.

![](imgs/taggit-categorize-023.png)

Groups and Tags can be exported using the Export Tags/Groups option in the pull-down menu. You can export to your local machine or to a folder in DesignSafe. This export option will generate one json file and also separate csv files for each group in the Gallery.


### References

* Kijewski-Correa et al. (2021) for PRJ-3349 StEER - 10 December 2021 Midwest Tornado Outbreak.
111 changes: 3 additions & 108 deletions user-guide/docs/usecases/haan/usecase-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,113 +3,8 @@
## Taggit User Guide: Grouping and Tagging Image Files

Using Taggit to categorize image files with groups and tags
///
///

{% include-markdown '../../redirect.md' %}

**Fred Haan – Calvin University **

_Keywords: Taggit, HazMapper, image tagging, image grouping, image labeling_


### Resources

The example makes use of the following DesignSafe resources:

* <https://hazmapper.tacc.utexas.edu/hazmapper/>
* <https://hazmapper.tacc.utexas.edu/taggit/>

### Description

This user guide demonstrates how to use Taggit on DesignSafe to organize image files into groups and to tag images. The groups and tags can then be saved for use in other programs (for example, for machine learning applications) or be used to present a set of images in a clear and organized way.

**NOTE**: You always start a Map/Gallery file in HazMapper. HazMapper and Taggit should be considered different ways of viewing the same set of images. You see a thumbnail Gallery of those images when you use Taggit, and you see a Map of those images when you use HazMapper, but it is the same *.hazmapper file in both cases. Also, at this time you cannot publish a Map/Gallery but this functionality is coming soon.


Taggit enables you to organize images into groups and to tag images. This document shows you how to create groups and tags with Taggit.

NOTE: Galleries in Taggit and Maps in HazMapper are actually the same thing. Taggit and HazMapper are just different ways of viewing the same Gallery/Map.

All browsing/mapping starts with HazMapper and you can switch back and forth between the apps as you wish.

This example begins with a Gallery that has already been created. If you do not know how to create a Gallery yet, start with the Basic Browsing and Mapping document and then come back to this one.

### Creating Groups and Using the Taggit View

As an example workflow, we will consider a damage survey dataset from the December 2021 Midwest tornado outbreak (see below) and create some groups to organize these images.

![](img2/image001.png)

Clicking on any of the images, will put a blue border around the image and cause a Create Group to appear in the upper right corner as shown here:

<!-- ![](img2/image004.png) -->

Clicking on Create Group will bring up a window in which to type in a name for your new group as show here. I am creating a group for all the Grain bins.

![](img2/image005.png)

Two things then happen when you add this group. First, that image you selected become a part of the group, and you'll see a small colored square that indicates it is a part of the group (see below). Second, the Taggit button will appear in the upper right corner.

![](img2/image007.png)

If you hover your mouse near the colored square, you will see the name of the group like this:

<!-- ![](img2/image008.png) -->

If you click the Taggit button, the screen will switch from the Gallery view to the Taggit view as shown below. This view will show the groups you have created and the images that are in each group. You can click on each image name to show them enlarged on the left. The Gallery/Map button in the upper right will send you back to the Gallery view.

![](img2/image009.png)

### Adding Images to Groups

To add more images to a group, you have two options. One option is to hover over an image and use the icons that appear (see below). The plus icon will bring up the option to add this image to a group. The magnifying glass and recycle bin allow you to enlarge the image or remove it from the Gallery, respectively.

![](img2/image010.png)

The other option is to select a few images and then use the Add to Group button that appears when you select images as shown here. I selected two more grain bin images for this example.

![](img2/image011.png)

Any given image can belong to multiple groups as illustrated by the group icons here:

![](img2/image012.png)

When you create more groups and assign images to each group, the Taggit view will list them all as show here:

![](img2/image013.png)

### Changing icons for each group

In the list of Groups in the Taggit view (shown below), each group's icon is shown on the right. If you click on that icon, you can change use a pull-down menu to change it if you wish.

![](img2/image015.png)

Modified icons are shown below for each of the groups. These icons are then used when that group's images are plotted in HazMapper.

![](img2/image016.png)

### Creating Tags within each Group

Within a given group, you can create custom Tags by clicking on the “+” icon in the Tag Images portion of the Taggit view (see below):

![](img2/image017.png)

This will show the options for the types of Tags as shown below. You can create Tags that are just a text box (Text), a checkbox list, a radio button list, a dropdown menu of tag options, or a color tag. The color tag can be used to change the color that is displayed in HazMapper.

![](img2/image018.png)

For this example, I am creating a Checkbox tag. The Tag itself has a Label and then you add as many Options are you wish by entering the name of each Option and then pressing the “+” button to add it to the list. In what is shown below, I added “CMU” as an Option, pressed the “+” to add it. Now I am adding Red brick as an Option, and am about to press the “+” to add it.

Once I have added all my options with the “+” button, then I press Save and I now have a Checkbox for each image in my Masonry group.

![](img2/image020.png)

Clicking one of the Checkbox options will cause a Save Tags button to appear (as shown below). You do not have to click the Save Tags button between every Tag you enter, but you will need to click it before leaving the tagging of that group and going back to Gallery view.

![](img2/image023.png)

Groups and Tags can be exported using the Export Tags/Groups option in the pull-down menu. You can export to your local machine or to a folder in DesignSafe. This export option will generate one json file and also separate csv files for each group in the Gallery.


### References

* Kijewski-Correa et al. (2021) for PRJ-3349 StEER - 10 December 2021 Midwest Tornado Outbreak.
- [**Tools: Visutalization:** Taggit User Guide: Grouping and Tagging Image Files](../tools/visualization/#taggit-user-guide-grouping-and-tagging-image-files)
Loading
Loading