Struct fitrs::Hdu

pub struct Hdu { /* fields omitted */ }

Represent an HDU as defined in FITS standard 4.1.

Methods

impl Hdu

Read HDU

pub fn value(&self, key: &str) -> Option<&HeaderValue>

Get HeaderValue by key. Return None if value is not found in Hdu.

pub fn read_data(&self) -> FitsData

Get data array stored in the Hdu.

impl Hdu

Iterate over HeaderValue in HDU

Important traits for HduIter<'a>

impl<'a> Iterator for HduIter<'a> type Item = (&'a String, Option<&'a HeaderValue>);

pub fn iter(&self) -> HduIter

impl Hdu

Create HDU

pub fn new<T: FitsDataType>(shape: &[usize], data: Vec<T>) -> Hdu

Create a new HDU with the shape and data given as parameters.

The HDU must be added to a Fits object to be written persistently to disk.

pub fn empty() -> Hdu

Make an Hdu with an empty data array.

pub fn insert<K: Into<String>, V: Into<HeaderValue>>(
    &mut self,
    key: K,
    value: V
)

Insert a value into header.

FITS file is saved with the header in the order of insertion. Keys longer than 8 bytes are truncated on writing to disk.

Example

use fitrs::{Hdu};
let mut hdu = Hdu::empty();
hdu.insert("KEYSTR", "My string");
hdu.insert("KEYSTR2", "Strings longer than 68 characters are supported as well, following the continued string convention.");
hdu.insert("KEYFLOAT", 3.14);
hdu.insert("KEYINT", 42);

Trait Implementations

impl<'a> IntoIterator for &'a Hdu

type Item = <HduIter<'a> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = HduIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Clone for Hdu

fn clone(&self) -> Hdu

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hdu

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

Formats the value using the given formatter.