Skip to main content

NetcdfTrajectoryBuilder

Struct NetcdfTrajectoryBuilder 

Source
pub struct NetcdfTrajectoryBuilder {
    pub title: String,
    pub application: String,
    pub frames: Vec<TrajectoryFrame>,
    pub use_angstroms: bool,
}
Expand description

Fluent builder for writing NetCDF-convention trajectories.

Fields§

§title: String

Title / description of the trajectory.

§application: String

Application name that produced this trajectory.

§frames: Vec<TrajectoryFrame>

Frames in insertion order.

§use_angstroms: bool

Whether positions are stored in Å (true) or nm (false).

Implementations§

Source§

impl NetcdfTrajectoryBuilder

Source

pub fn new() -> Self

Create an empty builder.

Source

pub fn with_title(self, title: &str) -> Self

Set the trajectory title.

Source

pub fn with_application(self, app: &str) -> Self

Set the application name.

Source

pub fn in_angstroms(self) -> Self

Use Å as the position unit.

Source

pub fn in_nanometres(self) -> Self

Use nm as the position unit.

Source

pub fn add_frame(&mut self, frame: TrajectoryFrame)

Append a frame to the trajectory.

Source

pub fn frame_count(&self) -> usize

Number of frames stored.

Source

pub fn n_atoms(&self) -> usize

Number of atoms (taken from the first frame; 0 if empty).

Source

pub fn rmsd_series(&self) -> Vec<f64>

Compute the RMSD trajectory (each frame vs. frame 0).

Source

pub fn write_cdl<W: Write>(&self, writer: &mut W) -> Result<()>

Write a minimal CDL representation to a writer.

Source

pub fn time_series(&self) -> Vec<f64>

Extract the time series (ps) of all frames.

Source

pub fn com_trajectory(&self) -> Vec<[f64; 3]>

Compute per-frame centre-of-mass trajectories.

Source

pub fn frame(&self, idx: usize) -> &TrajectoryFrame

Get frame at a specific index (panics if out of range).

Trait Implementations§

Source§

impl Clone for NetcdfTrajectoryBuilder

Source§

fn clone(&self) -> NetcdfTrajectoryBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NetcdfTrajectoryBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NetcdfTrajectoryBuilder

Source§

fn default() -> NetcdfTrajectoryBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.