Struct ucsf_nmr::AxisHeader

pub struct AxisHeader {
    pub nucleus_name: String,
    pub data_points: u32,
    pub tile_size: u32,
    pub frequency: f32,
    pub spectral_width: f32,
    pub center: f32,
    pub remainder: Vec<u8>,
}

128 byte axis header

Fields

nucleus_name: String

Nucleus name (1H, 13C, 15N, 31P, ...)

Format

Bytes 0-7

data_points: u32

Number of data points along this axis.

Format

Bytes 8-11 (followed by 4 unknown bytes)

tile_size: u32

Tile size along this axis.

Format

Bytes 16-19

frequency: f32

Spectrometer frequency for this nucleus (MHz)

Format

Bytes 20-23

spectral_width: f32

Spectral width (Hz)

Format

Bytes 24-27

center: f32

Center of data (ppm)

Format

Bytes 28-31

remainder: Vec<u8>

Remaining unspecified bytes

Format

Bytes: 32-127

Methods

impl AxisHeader

pub fn parse(input: &[u8]) -> Result<(&[u8], Self), UcsfError>

pub fn num_tiles(&self) -> u32

Returns the amount of tiles along this axis.

pub fn padded_size(&self) -> u32

Returns the size of the axis including zero-padding.

Useful for determining the expected size of the file.

pub fn tile_is_padded(&self, tile_n: usize) -> bool

Check whether the tile with index tile_n has padding along this axis.

pub fn tile_padding(&self, tile_n: usize) -> u32

Returns the amount of padding for tile with index tile_n along this axis.

Trait Implementations

impl Clone for AxisHeader

fn clone(&self) -> AxisHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisHeader

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

Formats the value using the given formatter.

impl PartialEq<AxisHeader> for AxisHeader

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

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

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

This method tests for !=.

impl StructuralPartialEq for AxisHeader