Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
Show 21 fields pub image_root: PathBuf, pub gps: Vec<GpsRecord>, pub span: usize, pub overlap: usize, pub total_positions: Option<usize>, pub incremental_triangulation: bool, pub fixed_enu_origin: bool, pub seed: Option<u64>, pub extraction: ExtractionOptions, pub sift: Arc<dyn SiftEngine>, pub matcher: Arc<dyn MatcherBackend>, pub ba_backend: Arc<dyn BaBackend>, pub sparse: SparseBackends, pub dense: Option<DenseConfig>, pub history: usize, pub decode_frames: bool, pub stable_display: bool, pub gps_prior_sigma: f64, pub settle_tol: f64, pub settle_max_zone: usize, pub intrinsics_prior: Option<Arc<IntrinsicsPrior>>,
}
Expand description

Session settings.

Fields§

§image_root: PathBuf

Input image folder (base of the image names).

§gps: Vec<GpsRecord>

GPS records (alignment order = this order).

§span: usize

Zone size and overlap (in units of positions).

§overlap: usize

Zone overlap (number of positions).

§total_positions: Option<usize>

Total number of known positions. If set, the last zones are closed at the last position; if not, they are closed in finish.

§incremental_triangulation: bool

Triangulate only newly registered images.

§fixed_enu_origin: bool

Fix the ENU origin to the first GPS record (default: the first common record at each alignment).

§seed: Option<u64>

RANSAC seed for two-view geometry and GPS alignment.

§extraction: ExtractionOptions

Feature extraction options.

§sift: Arc<dyn SiftEngine>

SIFT backend.

§matcher: Arc<dyn MatcherBackend>

Descriptor matching backend.

§ba_backend: Arc<dyn BaBackend>

Bundle adjustment backend (zone refinement BA, BA of the first model’s global mapper).

§sparse: SparseBackends

Sparse-stage backends (geometric verification, registration, triangulation).

§dense: Option<DenseConfig>

Densification settings (None = skip densification, point-cloud events carry dense: false).

§history: usize

Number of per-position rewind points kept for Command::ResetFrom (0 = no rewind, saves memory).

§decode_frames: bool

Decode input frames to RGB and emit them as Event::FrameDecoded before processing (off by default).

§stable_display: bool

Stable display (default off). No preview densification; the refinement of zone K waits for zone K−1, takes the cameras already shown by it (pose and intrinsics, copied exactly) as fixed in its bundle adjustment, and is not re-aligned to GPS, so a zone never moves after it is shown and the space only grows. The coordinate frame is the first refined zone’s (local). AllRefinedDone::chain is the final model aligned to GPS (ENU) once.

§gps_prior_sigma: f64

Stable display: standard deviation (m) of the GPS position prior on each newly placed camera. ≤ 0 disables the prior (then the shown frame is local and drifts with the chain).

§settle_tol: f64

Stable display: until settled, every refined zone re-adjusts all earlier cameras and the intrinsics (shown zones are re-placed). Once the largest relative focal change between two consecutive refined models is below this (default 0.01 = 1 %), the display settles: from then on shown cameras and intrinsics are frozen.

§settle_max_zone: usize

Stable display: the display settles by force at this zone at the latest (default 3).

§intrinsics_prior: Option<Arc<IntrinsicsPrior>>

Soft intrinsics prior (see crate::intrinsics): every camera starts from the prior values as soon as it exists and each refinement pulls its refined parameters back towards them. None = off.

Implementations§

Source§

impl SessionConfig

Source

pub fn new(image_root: impl Into<PathBuf>) -> Self

Defaults: zone 12 / overlap 2, SIFT up to 8192 features and input 3200, CPU SIFT and matching, no densification, rewind 8.

Examples found in repository?
examples/hooks.rs (line 61)
49fn main() -> Result<(), String> {
50    let out = std::env::args().nth(1).map(PathBuf::from).unwrap_or_else(|| std::env::temp_dir().join("cumulus3d_hooks"));
51    let src = out.with_extension("src");
52    if !src.join("gps_ref.txt").exists() {
53        common::make_dataset(&src);
54    }
55    if out.exists() {
56        std::fs::remove_dir_all(&out).map_err(|e| e.to_string())?;
57    }
58    let layout = Layout::discover(&src, 1)?;
59    let npos = layout.frames.len();
60
61    let mut cfg = SessionConfig::new(src.join("images"));
62    cfg.gps = read_gps_file(src.join("gps_ref.txt")).map_err(|e| e.to_string())?;
63    (cfg.span, cfg.overlap, cfg.total_positions, cfg.seed) = (4, 1, Some(npos), Some(7));
64    if cumulus3d_cuda::is_available() {
65        let mut d = DenseConfig::new(make_pm_backend("cuda"), parse_profile("fast")?);
66        d.undistort.max_image_size = 160;
67        cfg.dense = Some(d);
68    }
69
70    // Hook: print event text, zone point-cloud point counts, warnings and errors; plus the default output hook (files).
71    let pipeline = Pipeline::new(Session::new(cfg))
72        .on_any(|e: &Event| {
73            if let Some(t) = e.timeline_text() {
74                println!("[event v{}] {t}", e.meta().version);
75            }
76        })
77        .on(EventKind::ZonePreview, |e: &Event| {
78            if let Event::ZonePreview { range, cloud, model, .. } = e {
79                println!("  초벌 {}: 조밀 점 {} / 희소 점 {}", range.zone, cloud.len(), model.num_points3d());
80            }
81        })
82        .on(EventKind::ZoneRefined, |e: &Event| {
83            if let Event::ZoneRefined { range, cloud, model, .. } = e {
84                println!("  정밀 {}: 조밀 점 {} / 희소 점 {}", range.zone, cloud.len(), model.num_points3d());
85            }
86        })
87        .on_message(|k, m| eprintln!("  {k:?}: {m}"));
88    let mut pipeline = sinks::attach(pipeline, &out, &SinkOptions::default()).map_err(|e| e.to_string())?;
89
90    for p in 0..npos {
91        pipeline.push(Input::Frames(FrameSet::new(CAMS.iter().map(|c| (*c, layout.name(c, p))))));
92    }
93    let (_, summary) = pipeline.finish();
94    println!("이벤트 {} 개, 훅 호출 {} 번, 훅 패닉 {}", summary.events, summary.hook_calls, summary.hook_panics);
95
96    for f in ["timeline.txt", "run.log", "snapshots/manifest.json", "snapshots/timeline.txt", "DONE"] {
97        let p = out.join(f);
98        println!("{} {}", if p.exists() { "있음" } else { "없음" }, p.display());
99    }
100    Ok(())
101}

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V