Struct helixiser::wavefront::Wavefront

pub struct Wavefront {
    pub values: Array2<Complex64>,
    // some fields omitted
}

Fields

values: Array2<Complex64>

A wavefront is a 2D array of complex value where each point corresponds to a coordinate in 2D space. The array indices correspond to a point in space.

Implementations

impl Wavefront

pub fn new(values: Array2<Complex64>) -> Self

Instantiate a new Wavefront struct

pub fn rescale(&mut self, factor: f64)

rescale the (complex) values of the wavefront by a (real) scalar value.

Examples

use assert_approx_eq::assert_approx_eq;
use helixiser::wavefront::Wavefront;
use num::traits::Pow;
use ndarray::arr2;
use num::complex::Complex64;
let mut my_wavefront = Wavefront::new( arr2(&[[Complex64::new(5., 1.),
                                          Complex64::new(0., 0.)],
                                         [Complex64::new(0., 0.),
                                          Complex64::new(4., 2.)]]));
// Rescale the wavefront
my_wavefront.rescale(10.5);

assert_eq!(my_wavefront.values, arr2(&[[Complex64::new(52.5, 10.5),
                                        Complex64::new(0., 0.)],
                                       [Complex64::new(0., 0.),
                                        Complex64::new(42., 21.)]]))

pub fn intensities(&self) -> Array2<f64>

Convert the complex valued wavefront into (real valued) intensities.

Real values are obtained by squaring the norm of the complex values.

pub fn save_image(&self, path: &str)

Save wavefront intensities as image using the image crate

Panics

This function uses the image::save_buffer function which can panic