Struct CalibrationSession 

pub struct CalibrationSession<P>
where
    P: ProblemType,
{
    pub metadata: SessionMetadata,
    pub config: <P as ProblemType>::Config,
    pub state: <P as ProblemType>::State,
    pub exports: Vec<ExportRecord<<P as ProblemType>::Export>>,
    pub log: Vec<LogEntry>,
    /* private fields */
}

A calibration session container with mutable state.

The session stores configuration, input data, intermediate state, and the final output. Step functions mutate the session in-place.

Design Principles

• Single output: Only one final result is stored.
• Embedded input: Input data is stored directly in the session.
• Config changes don’t auto-clear: Changing config doesn’t invalidate output.
• Exports collection: Multiple exports can be generated and stored.

Example

use vision_calibration_pipeline::session::CalibrationSession;
use vision_calibration_pipeline::planar_intrinsics::{PlanarIntrinsicsProblem, step_init, step_optimize};

let mut session = CalibrationSession::<PlanarIntrinsicsProblem>::new();
session.set_input(dataset)?;

step_init(&mut session, None)?;
step_optimize(&mut session, None)?;

let export = session.export()?;

Fields

metadata: SessionMetadata

Session metadata (problem type, schema version, timestamps, description).

config: <P as ProblemType>::Config

Configuration parameters (always present, defaults if not explicitly set).

state: <P as ProblemType>::State

Problem-specific intermediate state (default until computed).

exports: Vec<ExportRecord<<P as ProblemType>::Export>>

Collection of generated exports.

log: Vec<LogEntry>

Operation log (lightweight audit trail).

Implementations

impl<P> CalibrationSession<P>

where P: ProblemType,

pub fn new() -> CalibrationSession<P>

Create a new empty session with default configuration.

pub fn with_description(description: impl Into<String>) -> CalibrationSession<P>

Create a new session with a description.

pub fn with_input( input: <P as ProblemType>::Input, ) -> Result<CalibrationSession<P>, Error>

Create a new session with input data.

Errors

Returns an error if input validation fails.

pub fn set_input( &mut self, input: <P as ProblemType>::Input, ) -> Result<(), Error>

Set input data, applying validation and invalidation policy.

Errors

Returns an error if ProblemType::validate_input fails.

pub fn input(&self) -> Option<&<P as ProblemType>::Input>

Get a reference to the input, if set.

pub fn input_mut(&mut self) -> Option<&mut <P as ProblemType>::Input>

Get a mutable reference to the input, if set.

pub fn require_input(&self) -> Result<&<P as ProblemType>::Input, Error>

Get a reference to the input, or error if not set.

Errors

Returns an error if input is not set.

pub fn require_input_mut( &mut self, ) -> Result<&mut <P as ProblemType>::Input, Error>

Get a mutable reference to the input, or error if not set.

Errors

Returns an error if input is not set.

pub fn has_input(&self) -> bool

Check if input is set.

pub fn clear_input(&mut self)

Clear input data, applying invalidation policy.

pub fn set_config( &mut self, config: <P as ProblemType>::Config, ) -> Result<(), Error>

Set configuration, applying validation and invalidation policy.

Errors

Returns an error if ProblemType::validate_config fails.

pub fn update_config<F>(&mut self, f: F) -> Result<(), Error>

where F: FnOnce(&mut <P as ProblemType>::Config),

Update configuration with a closure.

The closure receives a mutable reference to the current config. After the closure returns, validation and invalidation policy are applied.

Errors

Returns an error if validation fails after the update.

pub fn output(&self) -> Option<&<P as ProblemType>::Output>

Get a reference to the output, if computed.

pub fn output_mut(&mut self) -> Option<&mut <P as ProblemType>::Output>

Get a mutable reference to the output, if computed.

pub fn require_output(&self) -> Result<&<P as ProblemType>::Output, Error>

Get a reference to the output, or error if not computed.

Errors

Returns an error if output is not computed.

pub fn set_output(&mut self, output: <P as ProblemType>::Output)

Set the output (typically called by step functions).

pub fn has_output(&self) -> bool

Check if output is computed.

pub fn clear_output(&mut self)

Clear output.

pub fn export(&mut self) -> Result<<P as ProblemType>::Export, Error>

Export the current output and add to exports collection.

Errors

Returns an error if output is not computed or if export conversion fails.

pub fn export_with_notes( &mut self, notes: impl Into<String>, ) -> Result<<P as ProblemType>::Export, Error>

Export the current output with notes and add to exports collection.

Errors

Returns an error if output is not computed or if export conversion fails.

pub fn export_peek(&self) -> Result<<P as ProblemType>::Export, Error>

Export without adding to collection (peek).

Useful for inspecting the export without modifying the session.

Errors

Returns an error if output is not computed or if export conversion fails.

pub fn validate(&self) -> Result<(), Error>

Validate that the session is ready for processing.

Checks:

1. Input is set and valid
2. Config is valid
3. Input and config are compatible (cross-validation)

Errors

Returns an error if any validation check fails.

pub fn log_success(&mut self, operation: impl Into<String>)

Log a successful operation.

pub fn log_success_with_notes( &mut self, operation: impl Into<String>, notes: impl Into<String>, )

Log a successful operation with notes.

pub fn log_failure( &mut self, operation: impl Into<String>, error: impl Into<String>, )

Log a failed operation.

pub fn reset_state(&mut self)

Reset state to default, keeping input, config, and output.

pub fn reset_output(&mut self)

Reset output, keeping input, config, and state.

pub fn reset(&mut self)

Reset everything except config and description.

pub fn to_json(&self) -> Result<String, Error>

Serialize session to JSON string.

Errors

Returns an error if serialization fails.

pub fn from_json(json: &str) -> Result<CalibrationSession<P>, Error>

Deserialize session from JSON string.

Errors

Returns an error if:

• Deserialization fails
• Problem type does not match P::name()
• Schema version does not match P::schema_version()

Trait Implementations

impl<P> Clone for CalibrationSession<P>

where P: Clone + ProblemType, <P as ProblemType>::Config: Clone, <P as ProblemType>::Input: Clone, <P as ProblemType>::State: Clone, <P as ProblemType>::Output: Clone, <P as ProblemType>::Export: Clone,

fn clone(&self) -> CalibrationSession<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for CalibrationSession<P>

where P: Debug + ProblemType, <P as ProblemType>::Config: Debug, <P as ProblemType>::Input: Debug, <P as ProblemType>::State: Debug, <P as ProblemType>::Output: Debug, <P as ProblemType>::Export: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<P> Default for CalibrationSession<P>

where P: ProblemType,

fn default() -> CalibrationSession<P>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for CalibrationSession<P>

where P: ProblemType,

fn deserialize<__D>( __deserializer: __D, ) -> Result<CalibrationSession<P>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P> Serialize for CalibrationSession<P>

where P: ProblemType,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.