Struct serialimage::OptimumExposureBuilder

pub struct OptimumExposureBuilder { /* private fields */ }

Builder for the [serialimage::OptimumExposure] calculator.

The default values are:

• percentile_pix - 0.995
• pixel_tgt - 40000. / 65536.
• pixel_uncertainty - 5000. / 65536.
• pixel_exclusion - 100
• min_allowed_exp - 1 ms
• max_allowed_exp - 10 s
• max_allowed_bin - 1

Implementations

impl OptimumExposureBuilder

pub fn percentile_pix(self, percentile_pix: f32) -> Self

Set the percentile of the pixel values to use as the target pixel value.

The pixels are sorted in ascending order and the pixel at the percentile is targeted for optimization.

pub fn pixel_tgt(self, pixel_tgt: f32) -> Self

Set the target pixel value.

The target pixel value is the value that the algorithm will try to reach.

pub fn pixel_uncertainty(self, pixel_uncertainty: f32) -> Self

Set the uncertainty of the target pixel value.

The pixel value is considered to be within the target if it is within the target value plus or minus the uncertainty.

pub fn pixel_exclusion(self, pixel_exclusion: u32) -> Self

Set the number of pixels to exclude from the top of the image.

The pixels are sorted in ascending order and the top pixel_exclusion pixels are excluded from the optimization.

pub fn min_allowed_exp(self, min_allowed_exp: Duration) -> Self

Set the minimum allowed exposure time.

The minimum allowed exposure time is the shortest exposure time that the algorithm will consider.

pub fn max_allowed_exp(self, max_allowed_exp: Duration) -> Self

Set the maximum allowed exposure time.

The maximum allowed exposure time is the longest exposure time that the algorithm will consider.

pub fn max_allowed_bin(self, max_allowed_bin: u16) -> Self

Set the maximum allowed binning.

The maximum allowed binning is the largest binning factor that the algorithm will consider to minimize the exposure time.

pub fn build(self) -> Result<OptimumExposure, &'static str>

Build the [serialimage::OptimumExposure].

Trait Implementations

impl Clone for OptimumExposureBuilder

fn clone(&self) -> OptimumExposureBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptimumExposureBuilder

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

Formats the value using the given formatter.

impl Default for OptimumExposureBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for OptimumExposureBuilder

fn eq(&self, other: &OptimumExposureBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OptimumExposureBuilder