mmcamerasolve - refine and improve the comments.

Author: david-cattermole

lib/rust/mmcamerasolve-bin/src/cli.rs

@@ -17,7 +17,7 @@
 // along with mmSolver.  If not, see <https://www.gnu.org/licenses/>.
 // ====================================================================
 //
-//! Custom CLI argument parsing (no external dependencies).
+//! CLI argument parsing without external dependencies.
 
 use crate::parser;
 
@@ -55,15 +55,15 @@ const ARG_PREFIX: &str = "--prefix";
 const ARG_INTERMEDIATE_OUTPUT: &str = "--with-intermediate-output";
 const ARG_NUKE_LENS: &str = "--nuke-lens";
 
-/// Solver type for focal length adjustment
+/// Solver type for focal length adjustment.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
 pub enum SolverType {
-    /// Use provided focal length as-is (no adjustment)
+    /// Use provided focal length as-is.
     #[default]
     None,
-    /// Small refinement around provided focal length (±10%)
+    /// Small refinement around the provided focal length (±20%).
     Refine,
-    /// Large search range for unknown focal length (10-200mm)
+    /// Large search range for an unknown focal length (10-200mm).
     Unknown,
 }
 
@@ -86,63 +86,30 @@ impl std::str::FromStr for SolverType {
 /// Parsed command-line arguments.
 #[derive(Debug)]
 pub struct CliArgs {
-    /// Path to UV markers file (.uv).
     pub uv_file: String,
-
-    /// Optional path to an `.mmcamera` file for camera defaults.
     pub mmcamera_file: Option<String>,
-
-    /// Optional path to an `.mmsettings` file for solver settings.
     pub solver_settings_file: Option<String>,
-
-    /// Focal length in millimeters.
     pub focal_length_mm: f64,
-
-    /// Lens center X offset in millimeters.
     pub lens_center_x_mm: f64,
-
-    /// Lens center Y offset in millimeters.
     pub lens_center_y_mm: f64,
-
-    /// Image width in pixels.
     pub image_width: u32,
-
-    /// Image height in pixels.
     pub image_height: u32,
-
-    /// Film back width in millimeters.
     pub film_back_width_mm: f64,
-
-    /// Film back height in millimeters.
     pub film_back_height_mm: f64,
-
     /// Start frame (None = use UV file default).
     pub start_frame: Option<u32>,
-
     /// End frame (None = use UV file default).
     pub end_frame: Option<u32>,
-
-    /// Solver type for focal length adjustment.
     pub solver: SolverType,
-
-    /// Thread count (None = auto).
+    /// Thread count (None = auto-detect).
     pub threads: Option<usize>,
-
-    /// Output directory for visualizations.
     pub output_dir: String,
-
-    /// Optional prefix for output filenames.
     pub prefix: Option<String>,
-
-    /// Quiet mode - suppress progress output.
+    /// Suppress progress output.
     pub quiet: bool,
-
     /// Write intermediate results during solve.
     pub intermediate_output: bool,
-
-    /// Optional path to a Nuke .nk lens distortion file.
     pub nuke_lens_file: Option<String>,
-
 }
 
 impl Default for CliArgs {
@@ -171,7 +138,6 @@ impl Default for CliArgs {
     }
 }
 
-/// Print help message.
 pub fn print_help() {
     println!(
         "mmSolver Camera Solver - Structure from Motion camera solver.
@@ -226,7 +192,6 @@ HELP:
     );
 }
 
-/// Print version information.
 pub fn print_version() {
     println!("mmsfm {}", env!("CARGO_PKG_VERSION"));
 }
@@ -240,19 +205,13 @@ macro_rules! try_parse {
     };
 }
 
-/// Result of argument parsing.
 pub enum ParseResult {
-    /// Successfully parsed arguments.
     Args(CliArgs),
-    /// User requested help.
     Help,
-    /// User requested version.
     Version,
-    /// Parse error with message.
     Error(String),
 }
 
-/// Parse command-line arguments.
 pub fn parse_args() -> ParseResult {
     let args: Vec<String> = std::env::args().collect();
 
@@ -452,7 +411,7 @@ pub fn parse_args() -> ParseResult {
     ParseResult::Args(cli)
 }
 
-/// Tracks which CLI fields were explicitly provided by the user.
+/// Tracks which CLI fields were explicitly set, so mmcamera defaults don't override them.
 #[derive(Debug, Default)]
 struct ExplicitFlags {
     focal_length: bool,
@@ -466,8 +425,7 @@ struct ExplicitFlags {
     end_frame: bool,
 }
 
-/// Read an `.mmcamera` file and apply its values as defaults for any
-/// fields that were not explicitly set on the command line.
+/// Apply defaults from an .mmcamera file for any fields not explicitly set on the command line.
 fn apply_mmcamera_defaults(
     cli: &mut CliArgs,
     mmcamera_path: &str,

lib/rust/mmcamerasolve-bin/src/defaults.rs

@@ -22,69 +22,53 @@
 
 // --- Camera parameters ---
 
-/// Default focal length in millimeters (35mm standard lens).
+/// Default focal length in millimeters (standard 35mm lens).
 pub const DEFAULT_FOCAL_LENGTH_MM: f64 = 35.0;
 
-/// Default lens center X offset in millimeters.
 pub const DEFAULT_LENS_CENTER_X_MM: f64 = 0.0;
-
-/// Default lens center Y offset in millimeters.
 pub const DEFAULT_LENS_CENTER_Y_MM: f64 = 0.0;
 
-/// Default image width in pixels.
 pub const DEFAULT_IMAGE_WIDTH: u32 = 3600;
-
-/// Default image height in pixels.
 pub const DEFAULT_IMAGE_HEIGHT: u32 = 2400;
 
-/// Default film back width in millimeters (full-frame 35mm).
+/// Default film back width in millimeters (full-frame 35mm sensor).
 pub const DEFAULT_FILM_BACK_WIDTH_MM: f64 = 36.0;
 
-/// Default film back height in millimeters (full-frame 35mm).
+/// Default film back height in millimeters (full-frame 35mm sensor).
 pub const DEFAULT_FILM_BACK_HEIGHT_MM: f64 = 24.0;
 
-/// Default output directory.
 pub const DEFAULT_OUTPUT_DIR: &str = "./output";
 
 // --- Focal length solver bounds ---
 
-/// Absolute minimum focal length (mm) the solver can represent.
+/// Minimum focal length the solver can use.
 pub const MIN_FOCAL_LENGTH_MM: f64 = 0.1;
 
-/// Absolute maximum focal length (mm) the solver can represent.
+/// Maximum focal length the solver can use.
 pub const MAX_FOCAL_LENGTH_MM: f64 = 200.0;
 
-/// Lower multiplier for refine mode bounds (relative to input focal length).
+/// Lower bound factor for refine mode (multiplied against input focal length).
 pub const REFINE_BOUNDS_LOWER_FACTOR: f64 = 0.8;
 
-/// Upper multiplier for refine mode bounds (relative to input focal length).
+/// Upper bound factor for refine mode (multiplied against input focal length).
 pub const REFINE_BOUNDS_UPPER_FACTOR: f64 = 1.2;
 
-/// Default minimum focal length (mm) for unknown-mode search.
+/// Minimum focal length for unknown-mode search.
 pub const UNKNOWN_FL_MIN_MM: f64 = 10.0;
 
-/// Default maximum focal length (mm) for unknown-mode search.
+/// Maximum focal length for unknown-mode search.
 pub const UNKNOWN_FL_MAX_MM: f64 = 120.0;
 
-/// Default minimum focal length (mm) for uniform grid search.
+/// Minimum focal length for uniform grid search.
 pub const UNIFORM_GRID_FL_MIN_MM: f64 = 0.1;
 
-/// Default maximum focal length (mm) for uniform grid search.
+/// Maximum focal length for uniform grid search.
 pub const UNIFORM_GRID_FL_MAX_MM: f64 = 120.0;
 
 // --- Differential Evolution parameters ---
 
-/// Number of EVO generations for refine mode.
 pub const REFINE_EVO_GENERATIONS: usize = 200;
-
-/// Number of EVO generations for unknown-mode search.
 pub const UNKNOWN_EVO_GENERATIONS: usize = 500;
-
-/// EVO random seed for refine mode.
 pub const REFINE_EVO_SEED: u64 = 42;
-
-/// EVO random seed for unknown mode.
 pub const UNKNOWN_EVO_SEED: u64 = 12345;
-
-/// Default number of samples for uniform grid search.
 pub const UNIFORM_GRID_DEFAULT_SAMPLES: usize = 21;