Struct fitsio::FitsFile

pub struct FitsFile {
    pub filename: String,
    // some fields omitted
}

Main entry point to the FITS file format

Fields

filename: String

Methods

impl FitsFile

fn open(filename: &str) -> Result<Self>

Open a fits file from disk

Examples

use fitsio::FitsFile;

let f = FitsFile::open("../testdata/full_example.fits").unwrap();

// Continue to use `f` afterwards

fn create(path: &str) -> Result<Self>

Create a new fits file on disk

fn change_hdu<T: DescribesHdu>(&self, hdu_description: T) -> Result<()>

Change the current HDU

fn hdu_type(&self) -> Result<HduType>

Get the current HDU type

fn hdu_number(&self) -> usize

fn read_key<T: ReadsKey>(&self, name: &str) -> Result<T>

Read header key

fn write_key<T: WritesKey>(&self, name: &str, value: T) -> Result<()>

Write header key

fn read_col<T: ReadsCol>(&self, name: &str) -> Result<Vec<T>>

Read a binary table column

fn read_section<T: ReadsImage>(&self,
                               start: usize,
                               end: usize)
                               -> Result<Vec<T>>

Read an image between pixel a and pixel b into a Vec

fn read_region<T: ReadsImage>(&self,
                              lower_left: &Coordinate,
                              upper_right: &Coordinate)
                              -> Result<Vec<T>>

Read a square region into a Vec

fn columns(&self) -> ColumnIterator

fn fetch_hdu_info(&self) -> Result<HduInfo>

Get the current hdu info

Trait Implementations

impl Clone for FitsFile

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for FitsFile

fn drop(&mut self)

A method called when the value goes out of scope.