Struct FitsLoader

pub struct FitsLoader {
    pub path: String,
    pub hdul: HDUList,
}

Fields

path: String

hdul: HDUList

Implementations

impl FitsLoader

FitsLoader struct for loading and accessing FITS file data.

The FitsLoader struct provides methods for loading and accessing data from a FITS file. It supports retrieving individual card values, all card values, image data, and converting the data to a Polars DataFrame.

Example

extern crate pyref_core;
use pyref_core::loader::FitsLoader;

let fits_loader = FitsLoader::new("/path/to/file.fits").unwrap();

// Get a specific card value
let card_value = fits_loader.get_value("CARD_NAME");

// Get all card values
let all_cards = fits_loader.get_all_cards();

// Get image data
let image_data = fits_loader.get_image();

// Convert data to Polars DataFrame
let keys = ["KEY1", "KEY2"];
let polars_df = fits_loader.to_polars(&keys);

A struct representing a FITS loader.

pub fn new(path: &str) -> Result<Self, Box<dyn Error + Send + Sync>>

Creates a new FitsLoader instance.

Arguments

• path - The path to the FITS file.

Returns

A Result containing the FitsLoader instance if successful, or a boxed dyn std::error::Error if an error occurred.

pub fn get_card(&self, card_name: &str) -> Option<Card>

Retrieves a specific card from the FITS file.

Arguments

• card_name - The name of the card to retrieve.

Returns

An Option containing the requested card::Card if found, or None if not found.

pub fn get_value(&self, card_name: &str) -> Option<f64>

Retrieves the value of a specific card from the FITS file.

Arguments

• card_name - The name of the card to retrieve the value from.

Returns

An Option containing the value of the requested card as a f64 if found, or None if not found.

pub fn value_from_hdu(&self, card_name: &str) -> Option<f64>

pub fn get_scan_num(&self) -> i32

pub fn get_all_cards(&self) -> Vec<Card>

Retrieves all cards from the FITS file.

Returns

A Vec containing all the cards as card::Card instances.

pub fn get_image( &self, ) -> Result<(Vec<u32>, Vec<u32>), Box<dyn Error + Send + Sync>>

Retrieves the image data from the FITS file as an Array2<u32>.

Returns

A Result containing the image data as a Array2<u32> if successful, or a boxed dyn std::error::Error if an error occurred.

pub fn to_polars( &self, keys: &Vec<HeaderValue>, ) -> Result<DataFrame, Box<dyn Error + Send + Sync>>

Converts the FITS file data to a polars::prelude::DataFrame.

Arguments

• keys - The keys of the cards to include in the DataFrame. If empty, all cards will be included.

Returns

A Result containing the converted DataFrame if successful, or a boxed dyn std::error::Error if an error occurred.