Update unzipping.sh developer_README.md

developer_README.md

@@ -10,12 +10,32 @@ First, clone the repository from Hugging Face to your local machine:
 # Make sure git-lfs is installed (https://git-lfs.com)
 git lfs install
 git clone https://huggingface.co/datasets/OtoroLin/HyperForensics-plus-plus
+cd ./HyperForensics-plus-plus
 ```
 ## 2. Extract the Dataset
-Unzip the data.tar.gz file into a separate local directory:
+**The `unzipping.sh` has not been done**
+Unzip the data.tar.gz file into a separate local directory. You can utilize the provided `zipping.sh` script. First, modify the `ROOT_DIR` variable to the `local_data` path
 ```bash
-[to be filled]
+# In zipping.sh
+# Defined the root directory of the whole dataset
+ROOT_DIR="/root/to/local_data"
+```
+### 2.1 Decompressing the specify method and configuration:
+```bash
+./unzipping.sh --method <method name> --config <config name>
 ```
+Replace `<method name>` with the forgery method and `<config name>` with the configuration index. This will automatically decompressed `.tar.gz` file and put it under hirarchy of the local dataset directory.
+For instance, if I want to decompress the images under `ADMM-ADAM` forgery method, `config0` configuration:
+```bash
+./unzipping.sh --method ADMM-ADAM --config 0
+```
+This will decompress `HyperForensics-plus-plus/data/ADMM-ADAM/config0/config0.tar.gz` to `/path/to/local/ADMM-ADAM/config0/*`.
+### 2.2 Decompress the entire hirarchy
+```bash
+./unzipping.sh --all
+```
+This will recursively decompress all `tar.gz` file in the `HyperForensics-plus-plus/data` and automatically put the decompressed files under hirarchy of the local dataset directory.
+
 ## 3. Modify or Generate Data
 Make changes or generate new data in the extracted directory. Ensure the data follows the required structure:
 ```
@@ -34,7 +54,7 @@ HyperForensics-plus-plus/
     |-data/
 ```
 ## 4. Zip the Directory
-After modifying or generating data, zip the directory into a `.tar.gz` file and place it in the repository.
+After modifying or generating data, zip the directory into `.tar.gz` files and place it in the repository.
 
 You can utilize the provided `zipping.sh` script. First, modify the `ROOT_DIR` variable to the `local_data` path
 ```bash
@@ -42,7 +62,7 @@ You can utilize the provided `zipping.sh` script. First, modify the `ROOT_DIR` v
 # Defined the root directory of the whole dataset
 ROOT_DIR="/root/to/local_data"
 ```
-### 4.1 Compressing specify the method and configuration:
+### 4.1 Compressing the specify method and configuration:
 ```bash
 ./zipping.sh --method <method name> --config <config name>
 ```

unzipping.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+# Defined the root directory of the whole dataset
+ROOT_DIR="/ssd2/TzuYu/data_test"
+
+# Function to display usage
+usage() {
+    echo "Usage: $0 [--method METHOD --config CONFIG] | [--all]"
+    exit 1
+}
+# Function to unzip a single directory
+unzip_config() {
+    local method=$1
+    local config=$2
+    local output_path="$ROOT_DIR/$method/$config"
+    local zipped_file="./data/$method/$config/$config.tar.gz"
+
+    # Ensure the output directory exists
+    mkdir -p "$output_path"
+
+    # Create the tar.gz file
+    echo "Decompressing $zipped_file to $output_path"
+    tar -xvzf "$zipped_file" -C "$output_path"
+    if [[ $? -ne 0 ]]; then
+        echo "Error: Failed to decompress $zipped_file"
+        exit 1
+    fi
+}
+
+# Parse arguments
+while [[ "$#" -gt 0 ]]; do
+    case $1 in
+        --help) usage ;;
+        --h) usage ;;
+        --all) ALL="true" ;;
+        --method) METHOD="$2"; shift ;;
+        --config) CONFIG="$2"; shift ;;
+        *) echo "Unknown parameter: $1"; usage ;;
+    esac
+    shift
+done
+
+# unzipping all folders
+if [[ "$ALL" == "true" ]]; then
+    # Iterate through all methods and configs
+    for method_dir in "./data/*"; do
+        if [[ -d "$method_dir" && "$(basename "$method_dir")" != "Origin" ]]; then
+            method=$(basename "$method_dir")
+            for config_dir in "$method_dir"/config*; do
+                if [[ -d "$config_dir" ]]; then
+                    config=$(basename "$config_dir")
+                    unzip_config "$method" "$config"
+                fi
+            done
+        fi
+    done
+
+    if [ -e "./data/Origin/Origin.tar.gz" ]; then
+        # Ensure the output directory exists
+        mkdir -p "$ROOT_DIR/Origin"
+
+        # decompress tar.gz file
+        echo "Decompressing ./data/Origin/Origin.tar.gz to $ROOT_DIR/Origin"
+        tar -xvzf "./data/Origin/Origin.tar.gz" -C "$ROOT_DIR"/Origin/
+        if [[ $? -ne 0 ]]; then
+            echo "Error: Failed to decompress ./data/Origin/Origin.tar.gz"
+            exit 1
+        fi
+    fi
+    echo "All configurations have been zipped successfully."
+    exit 0
+fi
+
+
+# Validate arguments
+if [[ ! -n "$METHOD" || ! -n "$CONFIG" ]]; then
+    echo "Error: Both --method and --config or --all must be specified."
+    usage
+fi
+
+OUTPUT_PATH="$ROOT_DIR/$METHOD/config$CONFIG"
+
+# Extract method and config index from the directory path
+METHOD=$(basename "$(dirname "$OUTPUT_PATH")")
+CONFIG=$(basename "$OUTPUT_PATH")
+
+INPUT_TAR="./data/$METHOD/$CONFIG/$CONFIG.tar.gz"
+
+# Ensure the output directory exists
+mkdir -p "$OUTPUT_PATH"
+
+# Create the tar.gz file
+echo "Decompressing: $INPUT_TAR to $OUTPUT_PATH"
+tar -xvzf "$INPUT_TAR" -C "$OUTPUT_PATH"
+if [[ $? -ne 0 ]]; then
+    echo "Error: Failed to create tar.gz file."
+    exit 1
+fi
+
+# Confirm completion
+echo "Decompressing $INPUT_TAR suclsit essfully to $OUTPUT_PATH"

zipping.sh

@@ -5,7 +5,7 @@ ROOT_DIR="/ssd2/TzuYu/data"
 
 # Function to display usage
 usage() {
-    echo "Usage: $0 [--method METHOD --config CONFIG] | [--dir-path DIR_PATH]"
+    echo "Usage: $0 [--method METHOD --config CONFIG] | [--dir-path DIR_PATH] | [--all]"
     exit 1
 }
 # Function to zip a single directory