CPPxDIC
C++ Digital Image Correlation library for fingertip 3D reconstruction
Loading...
Searching...
No Matches
StagePlan Struct Reference

StagePlan — selects which pipeline sub-steps a single process executes. More...

#include <stage_plan.h>

Public Member Functions

bool anyStepD () const
 True if any Step-D sub-step is requested.
 

Static Public Member Functions

static bool parse (const std::string &spec, StagePlan &out, std::string *err)
 Parse a comma-separated stage spec into out (stage booleans only; only_pair/only_cam are left untouched so the caller can set them from –pair/–cam).
 

Public Attributes

bool match = true
 ROI/seed + REF->trial matching + camera-to-camera matching.
 
bool track = true
 per-camera NCorr tracking
 
bool format = true
 combine ncorr outputs -> myDIC2DpairResults
 
bool recon = true
 Step E: 3D reconstruction.
 
bool deform = true
 Step F: deformation / strain.
 
int only_pair = 0
 0 = all stereopairs; otherwise restrict to this pair
 
int only_cam = 0
 0 = both cameras; otherwise restrict tracking to this camera id
 

Detailed Description

StagePlan — selects which pipeline sub-steps a single process executes.

The full pipeline is preprocessing -> Step D (matching + per-camera tracking + format) -> Step E (3D reconstruction) -> Step F (deformation). Because every sub-step already checkpoints its outputs to disk (and downstream sub-steps load those checkpoints), the pipeline can be decomposed into independently schedulable processes — e.g. one SLURM array task per stage. A StagePlan tells a run which sub-steps to perform; everything else is satisfied from existing checkpoints on disk.

All fields default to "do everything", so a run with no --stages selection behaves exactly as before (full pipeline).

Definition at line 21 of file stage_plan.h.

Member Function Documentation

◆ anyStepD()

bool StagePlan::anyStepD ( ) const
inline

True if any Step-D sub-step is requested.

Definition at line 35 of file stage_plan.h.

◆ parse()

static bool StagePlan::parse ( const std::string &  spec,
StagePlan &  out,
std::string *  err 
)
inlinestatic

Parse a comma-separated stage spec into out (stage booleans only; only_pair/only_cam are left untouched so the caller can set them from –pair/–cam).

When a spec is given, selection is explicit: every stage starts false and is enabled by the tokens below.

Tokens (case-insensitive): all -> match,track,format,recon,deform d -> match,track,format (full Step D) match | matching -> match track | tracking -> track format -> format e | recon -> recon f | deform -> deform

Returns
false (and sets *err) on an unrecognised token.

Definition at line 54 of file stage_plan.h.

Member Data Documentation

◆ deform

bool StagePlan::deform = true

Step F: deformation / strain.

Definition at line 28 of file stage_plan.h.

◆ format

bool StagePlan::format = true

combine ncorr outputs -> myDIC2DpairResults

Definition at line 25 of file stage_plan.h.

◆ match

bool StagePlan::match = true

ROI/seed + REF->trial matching + camera-to-camera matching.

Definition at line 23 of file stage_plan.h.

◆ only_cam

int StagePlan::only_cam = 0

0 = both cameras; otherwise restrict tracking to this camera id

Definition at line 32 of file stage_plan.h.

◆ only_pair

int StagePlan::only_pair = 0

0 = all stereopairs; otherwise restrict to this pair

Definition at line 31 of file stage_plan.h.

◆ recon

bool StagePlan::recon = true

Step E: 3D reconstruction.

Definition at line 27 of file stage_plan.h.

◆ track

bool StagePlan::track = true

per-camera NCorr tracking

Definition at line 24 of file stage_plan.h.


The documentation for this struct was generated from the following file: