refimage

Trait FitsWrite

Source 
pub trait FitsWrite {
    // Required method
    fn write_fits(
        &self,
        path: &Path,
        compress: FitsCompression,
        overwrite: bool,
    ) -> Result<PathBuf, FitsError>;
}
Available on crate feature fitsio only.
Expand description

Trait for writing objects to FITS files.

Required Methods§

Source

fn write_fits( &self, path: &Path, compress: FitsCompression, overwrite: bool, ) -> Result<PathBuf, FitsError>

Write the image, with metadata, to a FITS file.

§Arguments
  • path: The path to write the FITS file to.
  • compress: The compression algorithm to use (FitsCompression).
  • overwrite: Whether to overwrite the file if it already exists.
§Returns

The path to the written FITS file.

§Errors

This function returns errors from the FITS library if the file could not be written.

Implementors§

OSZAR »