Struct fitrs::Fits

pub struct Fits { /* private fields */ }

Represent an open FITS file.

Implement caching. Thread-safe.

Implementations

impl Fits

Read a FITS file

pub fn open<P: AsRef<Path>>(path: P) -> Result<Fits, Error>

Open FITS file given in provided path (read-only).

pub fn iter(&self) -> FitsIter<'_>

Iterate over references to Hdus.

pub fn iter_mut(&mut self) -> FitsIterMut<'_>

Iterate over mutable references to Hdus.

pub fn load_all(&self)

Force-read the whole FITS file and cache it.

Beware of the size of the file you are loading before doing that.

pub fn get(&self, index: usize) -> Option<&Hdu>

Get reference to Hdu by index. Use 0 for primary HDU.

pub fn get_mut(&mut self, index: usize) -> Option<&mut Hdu>

Get mutable reference to Hdu by index. Use 0 for primary HDU.

pub fn get_by_name(&self, index: &str) -> Option<&Hdu>

Get reference to Hdu by EXTNAME. Defined in FIST standard 5.4.2.6

pub fn get_mut_by_name(&mut self, index: &str) -> Option<&mut Hdu>

Get mutable reference to Hdu by EXTNAME. Defined in FIST standard 5.4.2.6

impl Fits

Create a FITS file

pub fn create<P: AsRef<Path>>(path: P, primary_hdu: Hdu) -> Result<Fits, Error>

Creates a FITS file at the given path with the provided Hdu as primary HDU.

The file and its content are immediately written on disk.

pub fn push(&mut self, hdu: Hdu) -> Result<(), Error>

Push an extension HDU and update the FITS file on disk.

Currently defaults to creating an IMAGE HDU.

Trait Implementations

impl Debug for Fits

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

Formats the value using the given formatter.

impl Drop for Fits

We must release the Hdu cache!

fn drop(&mut self)

Executes the destructor for this type.

impl<'s> Index<&'s str> for Fits

type Output = Hdu

Hdu with provided EXTNAME.

fn index(&self, index: &str) -> &Self::Output

Get Hdu by EXTNAME. Panic if EXTNAME is not found. Prefer Fits::get_by_name if you need to check.

impl Index<usize> for Fits

type Output = Hdu

Hdu at index.

fn index(&self, index: usize) -> &Self::Output

Get Hdu by index. Panic if index is larger than the number of Hdus. Prefer Fits::get if you need to check.

impl<'s> IndexMut<&'s str> for Fits

fn index_mut(&mut self, index: &str) -> &mut Self::Output

Get mutable Hdu by EXTNAME. Panic if EXTNAME is not found. Prefer Fits::get_mut_by_name if you need to check.

impl IndexMut<usize> for Fits

fn index_mut(&mut self, index: usize) -> &mut Hdu

Get mutable Hdu by index. Panic if index is larger than the number of Hdus. Prefer Fits::get_mut if you need to check.

impl<'a> IntoIterator for &'a Fits

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

The type of the elements being iterated over.

type IntoIter = FitsIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Fits

type Item = Hdu

The type of the elements being iterated over.

type IntoIter = FitsIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.