Struct AsciiReader

pub struct AsciiReader<R: BufRead + Read> { /* private fields */ }

PointReader implementation for ascii files

Implementations

impl AsciiReader<BufReader<File>>

pub fn from_path<P: AsRef<Path>>( path: P, format: &str, delimiter: &str, ) -> Result<Self>

Creates a new AsciiReader by opening the file at the given path. The delimiter string slice is the column seperation pattern. The format string slice coordinates the interpretation of each column. This functions just wraps a BufReader around a File and uses AsciiReader::from_read. For more information see AsciiReader::from_read.

Examples

use std::path::Path;
use anyhow::Result;
use pasture_io::ascii::AsciiReader;
fn main() -> Result<()> {
    let path = Path::new("foo.txt");
    let reader = AsciiReader::from_path(path, "xyzie", ", ")?;
    Ok(())
}

Errors

If path does not exist, cannot be opened or does not point to a valid file, an error is returned.

If format contains unrecoginzed literals, an error is returned.

impl<R: BufRead + Read> AsciiReader<R>

pub fn from_read(read: R, format: &str, delimiter: &str) -> Result<Self>

Creates a new AsciiReader from the given read. The delimiter string slice is the column seperation pattern. The format string slice coordinates the interpretation of each column. The following literals can be interpreted from AsciiReader:

• s → skip this column
• x → x coordinate
• y → y coordinate
• z → z coordinate
• i → intensity
• r → ReturnNumber
• n → number of returns of given pulse
• c → classification
• t → gps time
• u → user data
• p → point source ID
• R → red channel of RGB color
• G → green channel of RGB color
• B → blue channel of RGB color
• e → edge of flight line flag
• d → direction of scan flag
• a → scan angle rank
• I → NIR channel

Examples

For the following data an AsciiReader should be created. The first three columns correspondens to the position attribute. The 4th column is the intensity attribute. and the 5th is the edge_of_line_flag.

use std::io::{BufReader};
use anyhow::Result;
use pasture_io::ascii::AsciiReader;
fn main() -> Result<()> {
    let data = "0.0, 1.0, 2.0, 11, 0\n1.0, -2.0, 2.0, 22, 0".as_bytes();
    let read = BufReader::new(data);
    let reader = AsciiReader::from_read(read, "xyzie", ", ")?;
    Ok(())
}

Errors

If the given Read does not represent a valid file, an error is returned.

If format contains unrecoginzed literals, an error is returned.

pub fn print_format_literals()

Trait Implementations

impl<R: BufRead + Read> PointReader for AsciiReader<R>

fn read_into<'a, 'b, B: BorrowedMutBuffer<'a>>( &mut self, point_buffer: &'b mut B, count: usize, ) -> Result<usize>

where 'a: 'b,

Read count points from this PointReader into the given point_buffer. Uses the PointLayout of the given PointBuffer for reading. If no conversion from the default PointLayout to this new layout are possible, an error is returned. On success, returns the number of points that were read. Overwrites existing data in point_buffer starting at the first point, so the length of point_buffer must be greater than or equal to count

fn get_metadata(&self) -> &dyn Metadata

Returns the Metadata of the associated PointReader

fn get_default_point_layout(&self) -> &PointLayout

Returns the default PointLayout of the associated PointReader

fn read<'a, B: OwningBuffer<'a> + MakeBufferFromLayout<'a> + 'a>( &mut self, count: usize, ) -> Result<B>

Reads at most count points from this PointReader into a new buffer of type B. The PointLayout this new buffer will be equal to self.get_default_point_layout