Struct Settings 

pub struct Settings {

    pub wavelength: f32,
    pub beam_power_threshold: f32,
    pub beam_area_threshold_fac: f32,
    pub cutoff: f32,
    pub medium_refr_index: Complex<f32>,
    pub particle_refr_index: Vec<Complex<f32>>,
    pub orientation: Orientation,
    pub geom_name: String,
    pub max_rec: i32,
    pub max_tir: i32,
    pub zones: Vec<ZoneConfig>,
    pub binning: Option<BinningScheme>,
    pub seed: Option<u64>,
    pub scale: f32,
    pub distortion: Option<f32>,
    pub geom_scale: Option<Vec<f32>>,
    pub directory: PathBuf,
    pub fov_factor: Option<f32>,
    pub mapping: Mapping,
    pub output: OutputConfig,
    pub coherence: bool,
    pub quiet: bool,
}

Runtime configuration for the application.

Fields

wavelength: f32

beam_power_threshold: f32

beam_area_threshold_fac: f32

cutoff: f32

medium_refr_index: Complex<f32>

particle_refr_index: Vec<Complex<f32>>

orientation: Orientation

geom_name: String

max_rec: i32

max_tir: i32

zones: Vec<ZoneConfig>

Zones for binning (new format). Takes precedence over binning.

binning: Option<BinningScheme>

Legacy binning field (deprecated, use zones instead). If present and zones is empty, this will be converted to a single zone.

seed: Option<u64>

scale: f32

Problem scaling factor - scales the entire problem (geometry, wavelength, and beam area thresholds)

distortion: Option<f32>

geom_scale: Option<Vec<f32>>

Per-axis geometry scaling [x, y, z] - scales only the geometry in each dimension

directory: PathBuf

fov_factor: Option<f32>

mapping: Mapping

output: OutputConfig

coherence: bool

quiet: bool

Suppress progress bars and status messages

Implementations

impl Settings

pub fn beam_area_threshold(&self) -> f32

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl DerefToPyAny for Settings

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtractPyClassWithClone for Settings

impl<'py> IntoPyObject<'py> for Settings

type Target = Settings

The Python output type

type Output = Bound<'py, <Settings as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for Settings

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for Settings

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Settings

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Runtime configuration for the application.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Settings>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Settings

const TEXT_SIGNATURE: &'static str = "(geom_path, wavelength=..., particle_refr_index_re=..., particle_refr_index_im=..., medium_refr_index_re=..., medium_refr_index_im=..., orientation=None, zones=None, beam_power_threshold=..., beam_area_threshold_fac=..., cutoff=..., max_rec=..., max_tir=..., scale=1.0, distortion=None, directory=\"goad_run\", mapping=..., coherence=..., quiet=..., seed=None)"

impl PyMethods<Settings> for PyClassImplCollector<Settings>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Settings

const NAME: &'static str = "Settings"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for Settings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Settings