Struct NetCDFReader 

pub struct NetCDFReader<T: Reader> {
    pub record_dimension: CDFRecordDimension,
    pub dimensions: Vec<CDFDimension>,
    pub global_attributes: CDFAttributes,
    pub variables: Vec<CDFVariable>,
    pub is64: bool,
    /* private fields */
}

NetCDF v3.x Reader

Description

Read the NetCDF v3.x file format

See specification

Implements the FeatureReader trait

Usage

The methods you have access to:

• NetCDFReader::new: Create a new NetCDFReader
• NetCDFReader::len: Returns the number of records
• NetCDFReader::is_empty: Returns true if the reader is empty
• NetCDFReader::get_properties: Returns the properties for a given index
• NetCDFReader::get_point: Get the point at a given index
• NetCDFReader::get_feature: Reads a point in at index as a feature
• NetCDFReader::get_data_variable: Retrieves the data for a given variable
• NetCDFReader::iter: Create an iterator over the features
• NetCDFReader::par_iter: Create a parallel iterator over the features

Buffer Reader

use gistools::{
    parsers::{FeatureReader, BufferReader},
    readers::{NetCDFReader, NetCDFReaderOptions},
};

// Ignore this, used to setup example
use std::path::PathBuf;
let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("tests/readers/netcdf/fixtures/ichthyop.nc");
let data: Vec<u8> = std::fs::read(path).unwrap();

let netcdf_reader = NetCDFReader::new(
    BufferReader::from(data),
    Some(NetCDFReaderOptions {
        lon_key: Some("lon".into()),
        lat_key: Some("lat".into()),
        height_key: Some("depth".into()),
        prop_fields: Some(vec!["depth".into()]),
    }),
);
assert_eq!(netcdf_reader.len(), 49);
let features: Vec<_> = netcdf_reader.iter().collect();

Links

• https://www.unidata.ucar.edu/software/netcdf/docs/file_format_specifications.html

Fields

record_dimension: CDFRecordDimension

Record dimension

dimensions: Vec<CDFDimension>

List of dimensions

global_attributes: CDFAttributes

List of global attributes

variables: Vec<CDFVariable>

List of variables

is64: bool

Describes if offsets are 32 or 64 bits

Implementations

impl<T: Reader> NetCDFReader<T>

pub fn new(reader: T, options: Option<NetCDFReaderOptions>) -> Self

Creates a new NetCDF reader

pub fn len(&self) -> u64

Returns the number of records

pub fn is_empty(&self) -> bool

Check if the reader is empty

pub fn get_properties(&self, index: u64) -> Option<MValue>

Get the properties at a given index

pub fn get_point(&self, index: u64) -> Option<VectorPoint<MValue>>

Get the point at a given index

pub fn get_feature(&self, index: u64) -> Option<CDFVectorFeature>

Reads a point in at index as a feature

pub fn get_data_variable(&self, variable_name: String) -> Option<Vec<CDFValue>>

Retrieves the data for a given variable

Parameters

• variable_name: Name of the variable to search or variable object

Returns

The variable values

Trait Implementations

impl<T: Clone + Reader> Clone for NetCDFReader<T>

fn clone(&self) -> NetCDFReader<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Reader> Debug for NetCDFReader<T>

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

Formats the value using the given formatter.

impl<T: Reader> FeatureReader<(), Map<String, ValueType>, Map<String, ValueType>> for NetCDFReader<T>

A feature reader trait with a callback-based approach

type FeatureIterator<'a> = CDFIterator<'a, T> where T: 'a

The Feature Reader should implement an iterator of some kind

fn iter(&self) -> Self::FeatureIterator<'_>

All readers have an iter function that returns a Iterator struct

fn par_iter( &self, pool_size: usize, thread_id: usize, ) -> Self::FeatureIterator<'_>

All readers have a par_iter function that returns a ParallelIterator struct