Docs + Polish + Remove bw mode

Author: nx10

src/app.rs

@@ -14,6 +14,7 @@ pub struct App {
     /// Is the application running?
     pub running: bool,
 
+    pub verbose: bool,
     pub file_path: String,
     pub volume: utils::brain_volume::BrainVolume,
     pub image_cache: utils::slice_cache::SliceCache,
@@ -30,6 +31,7 @@ pub struct App {
 impl App {
     /// Constructs a new instance of [`App`].
     pub fn new(
+        verbose: bool,
         file_path: &str,
         color_mode: utils::colors::ColorMode,
     ) -> std::result::Result<Self, Box<dyn error::Error + Send + Sync>> {
@@ -52,9 +54,12 @@ impl App {
             utils::colors::ColorMap::Inferno
         };
 
-        println!("Data loaded in: {:?}", duration);
+        if verbose {
+            println!("Data loaded in: {:?}", duration);
+        }
 
         Ok(Self {
+            verbose,
             running: true,
             file_path: file_path.to_string(),
             volume: volume,

src/main.rs

@@ -9,9 +9,20 @@ use std::io;
 use tui::backend::CrosstermBackend;
 use tui::Terminal;
 
-/// headjack - Terminal UI 3D volume brain imaging viewer
+
+static LONG_ABOUT: &'static str =
+"headjack - Interactive NIfTI Viewer for the Terminal\n\n\
+Interactive controls:\n\
+\t- Arrow keys / WSAD: Move slice (Post.-Ant. / Left-Right)\n\
+\t\tNavigate metadata\n\
+\t- ZX: Move slice (Inf.-Sup.)\n\
+\t- Tab: Toggle metadata view\n\
+\t- C: Toggle color map\n\
+\t- Q / Esc / Ctrl+C: Quit";
+
+/// headjack - Interactive NIfTI Viewer for the Terminal
 #[derive(Parser, Debug)]
-#[command(author, version, about, long_about = None)]
+#[command(author, version, about, long_about=LONG_ABOUT)]
 struct Args {
     /// Image file name (.nii or .nii.gz)
     #[arg(index = 1)]
@@ -20,26 +31,24 @@ struct Args {
     /// ANSI color mode for terminals not supporting true color (24bit).
     #[arg(short, long, action)]
     ansi: bool,
-
-    /// Black and white color mode for terminals not supporting any color (what year is this?).
+    
+    /// Verbose (debug) output.
     #[arg(short, long, action)]
-    bw: bool,
+    verbose: bool,
 }
 
 fn main() -> anyhow::Result<()> {
     // Read args
     let args = Args::parse();
 
-    let color_mode = if args.bw {
-        ColorMode::Bw
-    } else if args.ansi {
+    let color_mode = if args.ansi {
         ColorMode::Ansi256
     } else {
         ColorMode::TrueColor
     };
 
     // Create an application.
-    let mut app = App::new(&args.input, color_mode)
+    let mut app = App::new(args.verbose, &args.input, color_mode)
         .map_err(|e| anyhow!(e))
         .with_context(|| format!("Failed to load data '{}'", &args.input))?;
 

src/utils/colors.rs

@@ -2,7 +2,6 @@
 pub enum ColorMode {
     TrueColor,
     Ansi256,
-    Bw,
 }
 
 struct HjColor(colorous::Color);
@@ -41,9 +40,6 @@ pub fn calc_termcolor_rational(mode: ColorMode, map: colorous::Gradient, val: us
         ColorMode::Ansi256 => {
             tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
         },
-        ColorMode::Bw => {
-            if val > (val_max/2) { tui::style::Color::White } else { tui::style::Color::Black }
-        },
     }
 }
 
@@ -57,9 +53,6 @@ pub fn calc_termcolor_continuous(mode: ColorMode, map: colorous::Gradient, val:
         ColorMode::Ansi256 => {
             tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
         },
-        ColorMode::Bw => {
-            if val > 0.5 { tui::style::Color::White } else { tui::style::Color::Black }
-        },
     }
 }
 
@@ -73,9 +66,6 @@ pub fn calc_termcolor_inverted_rational(mode: ColorMode, map: colorous::Gradient
         ColorMode::Ansi256 => {
             tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
         },
-        ColorMode::Bw => {
-            if val <= (val_max/2) { tui::style::Color::White } else { tui::style::Color::Black }
-        },
     }
 }
 
@@ -89,9 +79,6 @@ pub fn calc_termcolor_inverted_continuous(mode: ColorMode, map: colorous::Gradie
         ColorMode::Ansi256 => {
             tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
         },
-        ColorMode::Bw => {
-            if val <= 0.5 { tui::style::Color::White } else { tui::style::Color::Black }
-        },
     }
 }
 
@@ -128,9 +115,6 @@ impl ColorMapper {
             ColorMode::Ansi256 => {
                 tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
             },
-            ColorMode::Bw => {
-                if value > 0.5 { tui::style::Color::White } else { tui::style::Color::Black }
-            },
         }
     }
 
@@ -144,9 +128,6 @@ impl ColorMapper {
             ColorMode::Ansi256 => {
                 tui::style::Color::Indexed(ansi_colours::ansi256_from_rgb(rgb))
             },
-            ColorMode::Bw => {
-                if value <= 0.5 { tui::style::Color::White } else { tui::style::Color::Black }
-            },
         }
     }
 }