Struct Zone 

pub struct Zone {
    pub label: Option<String>,
    pub zone_type: ZoneType,
    pub scheme: Scheme,
    pub bins: Vec<SolidAngleBin>,
    pub field_2d: Vec<ScattResult2D>,
    pub field_1d: Option<Vec<ScattResult1D>>,
    pub params: Params,
}

A zone represents a region of the scattering sphere with its own binning, results, and computed parameters.

Fields

label: Option<String>

Optional user-provided label.

zone_type: ZoneType

The type of zone (Full, Forward, Backward, Custom).

scheme: Scheme

The binning scheme for this zone.

bins: Vec<SolidAngleBin>

Generated bins for this zone.

field_2d: Vec<ScattResult2D>

2D scattering results (one per bin).

field_1d: Option<Vec<ScattResult1D>>

1D scattering results (integrated over phi), if applicable.

params: Params

Zone-specific computed parameters.

Implementations

impl Zone

pub fn new( zone_type: ZoneType, bins: Vec<SolidAngleBin>, field_2d: Vec<ScattResult2D>, field_1d: Option<Vec<ScattResult1D>>, ) -> Self

Create a new zone with explicit fields.

pub fn from_config(config: &ZoneConfig) -> Self

Create a new zone from a config, generating bins and initializing empty results.

pub fn forward() -> Self

Create a forward scattering zone (single bin at theta≈0). Uses theta=ZONE_THETA_OFFSET to avoid singularity at exact zero.

pub fn backward() -> Self

Create a backscatter zone (single bin at theta≈180). Uses theta=180-ZONE_THETA_OFFSET to avoid singularity at exact 180.

pub fn display_name(&self) -> String

Get a display name for this zone.

pub fn reset(&mut self)

Reset the zone’s results to empty state.

pub fn ones_like(&self) -> Self

Returns a Zone with all values set to 1.0 (for weights).

pub fn compute_params( &mut self, wavelength: f32, absorbed: f32, global_params: &Params, )

Compute zone-specific parameters based on zone type.

• Full: scatt_cross, ext_cross, asymmetry, albedo
• Forward: ext_cross_optical_theorem
• Backward: backscatter_cross, depolarization_ratio, lidar_ratio
• Custom: nothing (for now)

impl Zone

pub fn get_label(&self) -> Option<String>

Get the zone label

pub fn get_zone_type(&self) -> ZoneType

Get the zone type

pub fn get_name(&self) -> String

Get the display name for this zone

pub fn get_num_bins(&self) -> usize

Get the number of bins in this zone

pub fn get_bins<'py>(&self, py: Python<'py>) -> Bound<'py, PyArray2<f32>>

Get the bins as a numpy array of shape (n_bins, 2) with columns [theta, phi]

pub fn get_mueller<'py>(&self, py: Python<'py>) -> Bound<'py, PyArray2<f32>>

Get the Mueller matrix as a numpy array of shape (n_bins, 16)

pub fn get_mueller_1d<'py>( &self, py: Python<'py>, ) -> Option<Bound<'py, PyArray2<f32>>>

Get the 1D Mueller matrix as a numpy array (if available)

pub fn get_bins_1d<'py>( &self, py: Python<'py>, ) -> Option<Bound<'py, PyArray1<f32>>>

Get the 1D theta bins as a numpy array (if available)

pub fn get_params(&self) -> PyResult<Py<PyAny>>

Get zone-specific parameters as a dict

Trait Implementations

impl Add for Zone

type Output = Zone

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for Zone

fn clone(&self) -> Zone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Convergeable for Zone

fn zero_like(&self) -> Self

Create a zero/empty version with the same structure

fn weighted_add(&self, other: &Self, w1: f32, w2: f32) -> Self

Weighted addition: combines self (with weight w1) and other (with weight w2). For simple quantities: (self * w1 + other * w2) / (w1 + w2) For derived quantities like asymmetry: uses appropriate weighting (e.g., by ScatCross)

fn mul_elem(&self, other: &Self) -> Self

Element-wise multiplication (for computing x²)

fn div_elem(&self, other: &Self) -> Self

Element-wise division

fn add_elem(&self, other: &Self) -> Self

Element-wise addition

fn sub_elem(&self, other: &Self) -> Self

Element-wise subtraction

fn scale(&self, scalar: f32) -> Self

Scale by a scalar

fn sqrt_elem(&self) -> Self

Element-wise square root (for SEM computation)

fn to_weighted(&self) -> Self

Returns a pre-weighted version for convergence tracking. e.g., asymmetry becomes asymmetry * scat_cross

fn weights(&self) -> Self

Returns the weights for each field. e.g., asymmetry weight is scat_cross, powers weight is 1.0

impl Debug for Zone

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

Formats the value using the given formatter.

impl DerefToPyAny for Zone

impl Div for Zone

type Output = Zone

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl Div<f32> for Zone

type Output = Zone

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl ExtractPyClassWithClone for Zone

impl<'py> IntoPyObject<'py> for Zone

type Target = Zone

The Python output type

type Output = Bound<'py, <Zone 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 Mul for Zone

type Output = Zone

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Mul<f32> for Zone

type Output = Zone

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl Pow<f32> for Zone

type Output = Zone

The result after applying the operator.

fn pow(self, rhs: f32) -> Self

Returns self to the power rhs.

impl PyClass for Zone

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Zone

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 = /// A zone represents a region of the scattering sphere with its own binning, /// results, and computed parameters.

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<Zone>

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 PyMethods<Zone> for PyClassImplCollector<Zone>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Zone

const NAME: &'static str = "Zone"

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 Sub for Zone

type Output = Zone

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.