Struct las::header::Header [−][src]
Metadata describing the layout, source, and interpretation of the points.
Headers include all las metadata, including regular and extended variable length records and any file padding (e.g. extra bytes after the header).
Implementations
impl Header
[src]
pub fn from_raw(raw_header: Header) -> Result<Header>
[src]
Creates a new header from a raw header.
Examples
use las::{raw, Header}; let raw_header = raw::Header::default(); let header = Header::from_raw(raw_header).unwrap();
pub fn clear(&mut self)
[src]
Clears this header's point counts and bounds.
Examples
use las::{Header, Point, Bounds}; let mut header = Header::default(); header.add_point(&Point { return_number: 1, ..Default::default() }); assert_eq!(1, header.number_of_points()); assert_eq!(1, header.number_of_points_by_return(1).unwrap()); header.clear(); assert_eq!(0, header.number_of_points()); assert_eq!(None, header.number_of_points_by_return(1)); assert_eq!(Bounds::default(), header.bounds());
pub fn add_point(&mut self, point: &Point)
[src]
Adds a point to this header, incrementing the point counts and growing the bounds.
Examples
use las::Header; let mut header = Header::default(); header.add_point(&Default::default()); assert_eq!(1, header.number_of_points());
pub fn file_source_id(&self) -> u16
[src]
Returns this header's file source id.
For airborne data, this is often the flight line number.
Examples
use las::Header; assert_eq!(0, Header::default().file_source_id());
pub fn gps_time_type(&self) -> GpsTimeType
[src]
Returns the gps time type.
This affects what the gps time values on points means. GpsTimeType::Week
means that the
time values are seconds from the start of the week. GpsTimeType::Standard
means that the
time values are standard GPS time (satellite gps time) minus 10e9.
Examples
use las::{GpsTimeType, Header}; assert_eq!(GpsTimeType::Week, Header::default().gps_time_type());
pub fn has_synthetic_return_numbers(&self) -> bool
[src]
Returns true if the return numbers on the point data records have been synthetically generated.
Only supported in later las versions.
Examples
use las::Header; assert!(!Header::default().has_synthetic_return_numbers());
pub fn guid(&self) -> Uuid
[src]
pub fn version(&self) -> Version
[src]
Returns this header's version.
Examples
use las::{Header, Version}; assert_eq!(Version::new(1, 2), Header::default().version());
pub fn system_identifier(&self) -> &str
[src]
Returns this header's system identifier.
Describes the source of the data, whether it is a sensor or a processing operation.
Examples
use las::Header; println!("{}", Header::default().system_identifier());
pub fn generating_software(&self) -> &str
[src]
Returns this header's generating software.
Examples
use las::Header; assert!(Header::default().generating_software().starts_with("las-rs"));
pub fn date(&self) -> Option<Date<Utc>>
[src]
Returns this header's file creation date.
Can be None
, which is against spec but happens with files in the wild.
Examples
use las::Header; let date = Header::default().date().unwrap();
pub fn padding(&self) -> &Vec<u8>
[src]
Returns this header's padding.
These are bytes that are after the header but before the vlr. Not recommended to use.
Examples
use las::Header; assert!(Header::default().padding().is_empty());
pub fn point_format(&self) -> &Format
[src]
Returns this header's point format.
Point formats are used to describe the attributes and extra bytes of each point.
Examples
use las::Header; let header = Header::default(); assert_eq!(0, header.point_format().to_u8().unwrap());
pub fn transforms(&self) -> &Vector<Transform>
[src]
Returns this header's transforms.
The transforms are the scales and offsets used to convert floating point numbers to i16
.
Las data stores point coordinates as i16
s internally.
Examples
use las::Header; let header = Header::default(); let transforms = header.transforms(); assert_eq!(0.001, transforms.x.scale);
pub fn bounds(&self) -> Bounds
[src]
Returns the bounds of this header.
The bounds describe the min and max values in each dimension.
Examples
use las::Header; let bounds = Header::default().bounds();
pub fn number_of_points(&self) -> u64
[src]
Returns this header's number of points.
Examples
use las::Header; let header = Header::default(); assert_eq!(0, header.number_of_points());
pub fn number_of_points_by_return(&self, n: u8) -> Option<u64>
[src]
Returns this header's number of points for a given return number.
Note that return numbers are 1-indexed.
Examples
use las::Header; let header = Header::default(); assert_eq!(None, header.number_of_points_by_return(1));
pub fn vlr_padding(&self) -> &Vec<u8>
[src]
Returns a reference to this header's vlr padding.
These are bytes after the vlrs but before the points. Again, not recommended for use.
Examples
use las::Header; assert!(Header::default().vlr_padding().is_empty());
pub fn point_padding(&self) -> &Vec<u8>
[src]
Returns a reference to this header's point padding.
These are the bytes after the points but before eof/any evlrs. Not recommended.
Examples
use las::Header; assert!(Header::default().point_padding().is_empty());
pub fn vlrs(&self) -> &Vec<Vlr>
[src]
Returns a reference to this header's vlrs.
Examples
use las::{Vlr, Builder}; let mut builder = Builder::default(); builder.vlrs.push(Vlr::default()); let header = builder.into_header().unwrap(); assert_eq!(1, header.vlrs().len());
pub fn evlrs(&self) -> &Vec<Vlr>
[src]
Returns a reference to header's extended variable length records.
Examples
use las::{Vlr, Builder}; let mut builder = Builder::from((1, 4)); builder.evlrs.push(Vlr::default()); let header = builder.into_header().unwrap(); assert_eq!(1, header.evlrs().len());
pub fn all_vlrs(&self) -> Vlrs<'_>ⓘ
[src]
Returns an iterator over all this header's vlrs, both extended and regular.
Examples
use las::{Vlr, Builder}; let mut builder = Builder::from((1, 4)); builder.vlrs.push(Vlr::default()); builder.evlrs.push(Vlr::default()); let header = builder.into_header().unwrap(); assert_eq!(2, header.all_vlrs().count());
pub fn into_raw(self) -> Result<Header>
[src]
Converts this header into a raw header.
Examples
use las::Header; let raw_header = Header::default().into_raw().unwrap();
Trait Implementations
impl Clone for Header
[src]
impl Debug for Header
[src]
impl Default for Header
[src]
impl From<Header> for Builder
[src]
impl<V: Into<Version>> From<V> for Header
[src]
impl PartialEq<Header> for Header
[src]
impl StructuralPartialEq for Header
[src]
Auto Trait Implementations
impl RefUnwindSafe for Header
[src]
impl Send for Header
[src]
impl Sync for Header
[src]
impl Unpin for Header
[src]
impl UnwindSafe for Header
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,