template<typename dataT>
class mx::fits::fitsFile< dataT >

Class to manage interactions with a FITS file.

This class wraps the functionality of cfitsio.

Template Parameters

dataT is the datatype to use for in-memory storage of the image. This does not have to match the data type stored on disk for reading, but will be the type used for writing.

Definition at line 51 of file fitsFile.hpp.

#include <ioutils/fits/fitsFile.hpp>

Public Member Functions
	fitsFile ()
	Default constructor.

	fitsFile (const std::string &fname, bool doopen=true)
	Constructor with m_fileName, and option to open.

	~fitsFile ()
	Destructor.

std::string	fileName ()
	Get the current value of m_fileName.

int	fileName (const std::string &fname, bool doopen=true)
	Set the file path, and optionally open the file.

int	naxis ()
	Get the current value of m_naxis.

long	naxes (int dim)
	Get the current value of m_naxes for the specified dimension.

int	open ()
	Open the file and gets its dimensions.

int	open (const std::string &fname)
	Open the file, first setting the file path.

int	close ()
	Close the file.

int	getDimensions ()
	Get the number of dimensions (i.e. m_naxis)

long	getSize ()
	Get the total size.

long	getSize (size_t axis)
	Get the size of a specific dimension.

Reading Eigen Arrays
These methods read FITS data into array types with an Eigen-like interface.
template<typename arrT >
int	read (arrT &data)
	Read the contents of the FITS file into an Eigen array type (not a simple pointer).

template<typename arrT >
int	read (arrT &data, fitsHeader &head)
	Read the contents of the FITS file into an Eigen array type (not a simple pointer).

template<typename arrT >
int	read (arrT &data, const std::string &fname)
	Read the contents of the FITS file into an Eigen array type (not a simple pointer).

template<typename arrT >
int	read (arrT &data, fitsHeader &head, const std::string &fname)
	Read the contents of the FITS file into an Eigen array type (not a simple pointer).

template<typename cubeT >
int	read (cubeT &cube, const std::vector< std::string > &flist, std::vector< fitsHeader > *heads=0)
	Read data from a vector list of files into an image cube.

template<typename cubeT >
int	read (cubeT &cube, std::vector< fitsHeader > &heads, const std::vector< std::string > &flist)
	Read data from a vector of files into an image cube with individual headers.

Reading Headers
int	readHeader (fitsHeader &head)
	Read the header from the fits file.

int	readHeader (fitsHeader &head, const std::string &fname)
	Read the header from the fits file.

int	readHeader (std::vector< fitsHeader > &heads, const std::vector< std::string > &flist)
	Read the headers from a list of FITS files.

Writing Basic Arrays
These methods write basic arrays specified by a pointer to FITS.
int	write (const dataT im, int d1, int d2, int d3, fitsHeader head)
	Write the contents of a raw array to the FITS file.

int	write (const dataT *im, int d1, int d2, int d3)
	Write the contents of a raw array to the FITS file.

int	write (const dataT *im, int d1, int d2, int d3, fitsHeader &head)
	Write the contents of a raw array to the FITS file.

int	write (const std::string &fname, const dataT *im, int d1, int d2, int d3)
	Write the contents of a raw array to the FITS file.

int	write (const std::string &fname, const dataT *im, int d1, int d2, int d3, fitsHeader &head)
	Write the contents of a raw array to the FITS file.

Writing Eigen Arrays
These methods write array types with an Eigen-like interface.
template<typename arrT >
int	write (const std::string &fname, const arrT &im)
	Write the contents of an Eigen-type array to a FITS file.

template<typename arrT >
int	write (const std::string &fname, const arrT &im, fitsHeader &head)
	Write the contents of an Eigen-type array to a FITS file.

Reading Subsets
It is often desirable to read only a subset of an image or images into memory. These methods allow you to specify this.
void	setReadSize ()
	Set to read all the pixels in the file.

void	setReadSize (long x0, long y0, long xpix, long ypix)
	Set to read only a subset of the pixels in the file.

void	setCubeReadSize ()
	Set to read all frames from a cube.

void	setCubeReadSize (long z0, long zframes)
	Set the number of frames to read from a cube.

Protected Member Functions
void	construct ()
	One time initialization common to all constructors.

Protected Attributes
std::string	m_fileName
	The path to the file.

fitsfile *	m_fptr { nullptr }
	The cfitsio data structure.

int	m_naxis
	The dimensions of the image (1D, 2D, 3D etc)

long *	m_naxes { nullptr }
	The size of each dimension.

bool	m_isOpen { false }
	Flag indicating whether the file is open or not.

dataT	m_nulval { 0 }
	The value to replace null values with.

int	m_anynul { 0 }
	Records whether any null values were replaced.

int	m_noComment { 0 }
	Flag to control whether the comment string is read.

long	m_x0 { -1 }
	The starting x-pixel to read from.

long	m_y0 { -1 }
	The starting y-pixel to read from.

long	m_xpix { -1 }
	The number of x-pixels to read.

long	m_ypix { -1 }
	The number of y-pixels to read.

long	m_z0 { -1 }
	The starting frame to read from a cube.

long	m_zframes { -1 }
	The number of frames to read from a cube.

Reading Basic Arrays
These methods read FITS data into basic or raw arrays specified by a pointer.
void	pixarrs (long fpix, long lpix, long **inc)
	Fill in the read-size arrays for reading a subset (always used)

int	read (dataT *data)
	Read the contents of the FITS file into an array.

int	read (dataT *data, fitsHeader &head)
	Read the contents of the FITS file into an array.

int	read (dataT *data, const std::string &fname)
	Read the contents of the FITS file into an array.

int	read (dataT *data, fitsHeader &head, const std::string &fname)
	Read the contents of the FITS file into an array and read the header.

int	read (dataT *im, const std::vector< std::string > &flist)
	Read data from a vector list of files into an image cube.

int	read (dataT *im, std::vector< fitsHeader > &heads, const std::vector< std::string > &flist)
	Read data from a vector of files into an image cube with individual headers.

Constructor & Destructor Documentation

◆ fitsFile() [1/2]

template<typename dataT >

mx::fits::fitsFile< dataT >::fitsFile ( )

Default constructor.

Definition at line 554 of file fitsFile.hpp.

◆ fitsFile() [2/2]

template<typename dataT >

mx::fits::fitsFile< dataT >::fitsFile	(	const std::string &	fname,
		bool	doopen = `true`
	)

Constructor with m_fileName, and option to open.

Parameters

fname	File name to set on construction
doopen	If true, then the file is opened (the default).

Definition at line 560 of file fitsFile.hpp.

◆ ~fitsFile()

template<typename dataT >

mx::fits::fitsFile< dataT >::~fitsFile ( )

Destructor.

Definition at line 567 of file fitsFile.hpp.

Member Function Documentation

◆ close()

template<typename dataT >

int mx::fits::fitsFile< dataT >::close ( )

Close the file.

Returns: 0 on success; -1 on error

Definition at line 678 of file fitsFile.hpp.

References mx::fits::fitsErrText().

◆ construct()

template<typename dataT >

void mx::fits::fitsFile< dataT >::construct ( )

protected

One time initialization common to all constructors.

Definition at line 549 of file fitsFile.hpp.

◆ fileName() [1/2]

template<typename dataT >

std::string mx::fits::fitsFile< dataT >::fileName ( )

Get the current value of m_fileName.

Returns: the current value of m_fileName.

Definition at line 577 of file fitsFile.hpp.

◆ fileName() [2/2]

template<typename dataT >

int mx::fits::fitsFile< dataT >::fileName	(	const std::string &	fname,
		bool	doopen = `true`
	)

Set the file path, and optionally open the file.

Returns: 0 on success; -1 on success

Parameters

fname	The new file name.
doopen	If true, then the file is opened (the default).

Definition at line 583 of file fitsFile.hpp.

◆ getDimensions()

template<typename dataT >

int mx::fits::fitsFile< dataT >::getDimensions ( )

Get the number of dimensions (i.e. m_naxis)

Definition at line 710 of file fitsFile.hpp.

◆ getSize() [1/2]

template<typename dataT >

long mx::fits::fitsFile< dataT >::getSize ( )

Get the total size.

Definition at line 719 of file fitsFile.hpp.

◆ getSize() [2/2]

template<typename dataT >

long mx::fits::fitsFile< dataT >::getSize ( size_t axis )

Get the size of a specific dimension.

Definition at line 740 of file fitsFile.hpp.

◆ naxes()

template<typename dataT >

long mx::fits::fitsFile< dataT >::naxes ( int dim )

Get the current value of m_naxes for the specified dimension.

Returns: the current value of m_naxes for the specified dimension. -1 if no such dimension

Test:: Scenario: fitsFile calculating subimage sizes [test doc]

Parameters

[in] dim the dimension

Definition at line 607 of file fitsFile.hpp.

◆ naxis()

template<typename dataT >

int mx::fits::fitsFile< dataT >::naxis ( )

Get the current value of m_naxis.

Returns: the current value of m_naxis

Test:: Scenario: fitsFile calculating subimage sizes [test doc]

Definition at line 601 of file fitsFile.hpp.

◆ open() [1/2]

template<typename dataT >

int mx::fits::fitsFile< dataT >::open ( )

Open the file and gets its dimensions.

File name needs to already have been set. If the file has already been opened, this returns immediately with no re-open.

Returns: 0 on success; -1 on error

Definition at line 619 of file fitsFile.hpp.

References mx::fits::fitsErrText().

◆ open() [2/2]

template<typename dataT >

int mx::fits::fitsFile< dataT >::open ( const std::string & fname )

Open the file, first setting the file path.

Returns: 0 on success; -1 on error

Parameters

fname The name of the file to open.

Definition at line 672 of file fitsFile.hpp.

◆ pixarrs()

template<typename dataT >

void mx::fits::fitsFile< dataT >::pixarrs	(	long **	fpix,
		long **	lpix,
		long **	inc
	)

protected

Fill in the read-size arrays for reading a subset (always used)

Note: this allocates with new. You are responsible for calling delete.

Test:: Scenario: fitsFile calculating subimage sizes [test doc]

Parameters

fpix	Populated with the lower left pixel to read. Is allocated.
lpix	Populated with the upper right pixel to read. Is allocated.
inc	The increment. Is allocated.

Definition at line 758 of file fitsFile.hpp.

◆ read() [1/12]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::read ( arrT & data )

Read the contents of the FITS file into an Eigen array type (not a simple pointer).

The type arrT can be any type with the following members defined:

resize(int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef arrT::Scalar (is the data type, does not have to be dataT)

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Todo:: this can probably be made part of one read function (or call read(data *)) with a call to resize with SFINAE

Parameters

[out] data is the array, which will be resized as necessary using its resize(int, int) member

Definition at line 983 of file fitsFile.hpp.

References mx::fits::fitsErrText().

◆ read() [2/12]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::read	(	arrT &	data,
		const std::string &	fname
	)

Read the contents of the FITS file into an Eigen array type (not a simple pointer).

The type arrT can be any type with the following members defined:

resize(int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef arrT::Scalar (is the data type, does not have to be dataT)

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[out]	data	is the array, which will be resized as necessary using its resize(int, int) member
[in]	fname	is the file path, which is passed to fileName

Definition at line 1052 of file fitsFile.hpp.

◆ read() [3/12]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::read	(	arrT &	data,
		fitsHeader &	head
	)

Read the contents of the FITS file into an Eigen array type (not a simple pointer).

The type arrT can be any type with the following members defined:

resize(int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef arrT::Scalar (is the data type, does not have to be dataT)

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[out]	data	is the array, which will be resized as necessary using its resize(int, int) member
[out]	head	is a fitsHeader object which is passed to readHeader

Definition at line 1041 of file fitsFile.hpp.

◆ read() [4/12]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::read	(	arrT &	data,
		fitsHeader &	head,
		const std::string &	fname
	)

Read the contents of the FITS file into an Eigen array type (not a simple pointer).

The type arrT can be any type with the following members defined:

resize(int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef arrT::Scalar (is the data type, does not have to be dataT)

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[out]	data	the array, which will be resized as necessary using its resize(int, int) member
[out]	head	a fitsHeader object which is passed to readHeader
[in]	fname	the file path, which is passed to fileName

Definition at line 1063 of file fitsFile.hpp.

◆ read() [5/12]

template<typename dataT >

template<typename cubeT >

int mx::fits::fitsFile< dataT >::read	(	cubeT &	cube,
		const std::vector< std::string > &	flist,
		std::vector< fitsHeader > *	heads = `0`
	)

Read data from a vector list of files into an image cube.

The type cubeT can be any type with the following members defined:

resize(int, int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef cubeT::Scalar (is the data type, does not have to be dataT)

Note: The images must all be the same size, or all be as large or larger than the subset specified.

Template Parameters

cubeT is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[out]	cube	A cube which will be resized using its resize(int, int, int) member.
[in]	flist	The list of files to read.
[out]	heads	[optional] A vector of fits headers, allocated to contain one per image.

Definition at line 1077 of file fitsFile.hpp.

References mx::fits::fitsErrText().

◆ read() [6/12]

template<typename dataT >

template<typename cubeT >

int mx::fits::fitsFile< dataT >::read	(	cubeT &	cube,
		std::vector< fitsHeader > &	heads,
		const std::vector< std::string > &	flist
	)

Read data from a vector of files into an image cube with individual headers.

The type cubeT can be any type with the following members defined:

resize(int, int, int) (allocates memory)
data() (returns a pointer to the underlying array)
typedef cubeT::Scalar (is the data type, does not have to be dataT)

Template Parameters

cubeT is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[out]	cube	A cube which will be resized using its resize(int, int, int) member.
[out]	heads	The vector of fits headers, allocated to contain one per image.
[in]	flist	The list of files to read.

Definition at line 1176 of file fitsFile.hpp.

◆ read() [7/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read ( dataT * data )

Read the contents of the FITS file into an array.

The array pointed to by data must have been allocated.

Returns: 0 on success; -1 on error

Todo:: test if there is a speed difference for full reads for fits_read_pix/subset

Parameters

[out] data an allocated arrray large enough to hold the entire image

Definition at line 829 of file fitsFile.hpp.

References mx::fits::fitsErrText().

Referenced by mx::AO::analysis::calculatedWFS< realT, iosT >::beta_p(), mx::AO::analysis::calculatedWFS< realT, iosT >::beta_r(), mx::AO::sim::turbAtmosphere< _aoSystemT >::genLayers(), mx::AO::ifPInv(), mx::AO::sim::simulatedAOSystem< _realT, _wfsT, _reconT, _filterT, _dmT, _turbSeqT, _coronT >::initSystem(), mx::improc::ADIobservation< _realT, _derotFunctObj >::injectFake(), mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::intensityPSD(), mx::wfp::lyotCoronagraph< _realT, _fpmaskFloatT >::loadApodizer(), mx::wfp::lyotCoronagraph< _realT, _fpmaskFloatT >::loadFocalMask(), mx::wfp::lyotCoronagraph< _realT, _fpmaskFloatT >::loadLyotStop(), mx::wfp::idealCoronagraph< _realT >::loadPupil(), mx::AO::sim::directPhaseReconstructor< realT >::loadRecon(), mx::AO::m2cMatrix(), mx::AO::modalDMM2cMatrix(), mx::AO::modesOnDM(), mx::improc::HCIobservation< _realT >::readFiles(), mx::improc::HCIobservation< _realT >::readMask(), mx::improc::ADIobservation< _realT, _derotFunctObj >::readPSFSub(), mx::improc::HCIobservation< _realT >::readPSFSub(), and mx::improc::HCIobservation< _realT >::readRDIFiles().

◆ read() [8/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read	(	dataT *	data,
		const std::string &	fname
	)

Read the contents of the FITS file into an array.

The array pointed to by data must have been allocated.

Returns: 0 on success; -1 on error

Parameters

[out]	data	is an allocated arrray large enough to hold the entire image
[in]	fname	is the file path, which is passed to fileName

Definition at line 878 of file fitsFile.hpp.

◆ read() [9/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read	(	dataT *	data,
		fitsHeader &	head
	)

Read the contents of the FITS file into an array.

The array pointed to by data must have been allocated.

Returns: 0 on success; -1 on error

Parameters

[out]	data	an allocated arrray large enough to hold the entire image
[out]	head	a fitsHeader object which is passed to readHeader

Definition at line 867 of file fitsFile.hpp.

◆ read() [10/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read	(	dataT *	data,
		fitsHeader &	head,
		const std::string &	fname
	)

Read the contents of the FITS file into an array and read the header.

The array pointed to by data must have been allocated.

Returns: 0 on success; -1 on error

Parameters

[out]	data	an allocated arrray large enough to hold the entire image
[out]	head	a fitsHeader object which is passed to readHeader
[in]	fname	the file path, which is passed to fileName

Definition at line 888 of file fitsFile.hpp.

◆ read() [11/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read	(	dataT *	im,
		const std::vector< std::string > &	flist
	)

Read data from a vector list of files into an image cube.

Parameters

[out]	im	An allocated array large enough to hold all the images
[in]	flist	The list of files to read.

Definition at line 900 of file fitsFile.hpp.

◆ read() [12/12]

template<typename dataT >

int mx::fits::fitsFile< dataT >::read	(	dataT *	im,
		std::vector< fitsHeader > &	heads,
		const std::vector< std::string > &	flist
	)

Read data from a vector of files into an image cube with individual headers.

Parameters

[out]	im	An allocated array large enough to hold all the images
	heads	[in.out] The vector of fits headers, allocated to contain one per image.
[in]	flist	The list of files to read.

Definition at line 927 of file fitsFile.hpp.

◆ readHeader() [1/3]

template<typename dataT >

int mx::fits::fitsFile< dataT >::readHeader ( fitsHeader & head )

Read the header from the fits file.

If head is not empty, then only the keywords already in head are updated. Otherwise the complete header is read.

Returns: 0 on success; -1 on error

Parameters

[out] head a fitsHeader object

Definition at line 1182 of file fitsFile.hpp.

References mx::fits::fitsHeader::append(), mx::fits::fitsHeader::begin(), mx::fits::fitsHeader::end(), mx::fits::fitsHeader::erase(), mx::fits::fitsErrText(), and mx::fits::fitsHeader::size().

◆ readHeader() [2/3]

template<typename dataT >

int mx::fits::fitsFile< dataT >::readHeader	(	fitsHeader &	head,
		const std::string &	fname
	)

Read the header from the fits file.

If head is not empty, then only the keywords already in head are updated. Otherwise the complete header is read.

Returns: 0 on success; -1 on error

Parameters

[out]	head	a fitsHeader object
[in]	fname	the file path, which is passed to fileName

Definition at line 1306 of file fitsFile.hpp.

◆ readHeader() [3/3]

template<typename dataT >

int mx::fits::fitsFile< dataT >::readHeader	(	std::vector< fitsHeader > &	heads,
		const std::vector< std::string > &	flist
	)

Read the headers from a list of FITS files.

In each case, if the header is not empty then only the keywords already in head are updated. Otherwise the complete header is read.

Returns: 0 on success; -1 on error

Parameters

flist A vector of fitsHeader objects to read into. [in] A list of files, each of which is passed to fileName

Definition at line 1315 of file fitsFile.hpp.

◆ setCubeReadSize() [1/2]

template<typename dataT >

void mx::fits::fitsFile< dataT >::setCubeReadSize ( )

Set to read all frames from a cube.

Definition at line 1490 of file fitsFile.hpp.

◆ setCubeReadSize() [2/2]

template<typename dataT >

void mx::fits::fitsFile< dataT >::setCubeReadSize	(	long	z0,
		long	zframes
	)

Set the number of frames to read from a cube.

Test:: Scenario: fitsFile calculating subimage sizes [test doc]

Parameters

z0	is the starting frame to read
zframes	is the number of frames to read

Definition at line 1497 of file fitsFile.hpp.

◆ setReadSize() [1/2]

template<typename dataT >

void mx::fits::fitsFile< dataT >::setReadSize ( )

Set to read all the pixels in the file.

Definition at line 1472 of file fitsFile.hpp.

Referenced by mx::improc::HCIobservation< _realT >::readFiles(), mx::improc::HCIobservation< _realT >::readPSFSub(), and mx::improc::HCIobservation< _realT >::readRDIFiles().

◆ setReadSize() [2/2]

template<typename dataT >

void mx::fits::fitsFile< dataT >::setReadSize	(	long	x0,
		long	y0,
		long	xpix,
		long	ypix
	)

Set to read only a subset of the pixels in the file.

Test:: Scenario: fitsFile calculating subimage sizes [test doc]

Parameters

x0	is the starting x-pixel to read
y0	is the starting y-pixel to read
xpix	is the number of x-pixels to read
ypix	is the number of y-pixels to read

Definition at line 1481 of file fitsFile.hpp.

◆ write() [1/7]

template<typename dataT >

int mx::fits::fitsFile< dataT >::write	(	const dataT *	im,
		int	d1,
		int	d2,
		int	d3
	)

Write the contents of a raw array to the FITS file.

Returns: 0 on success; -1 on error

Parameters

[in]	im	is the array
[in]	d1	is the first dimension
[in]	d2	is the second dimension
[in]	d3	is the third dimenesion (minimum value is 1)

Definition at line 1426 of file fitsFile.hpp.

◆ write() [2/7]

template<typename dataT >

int mx::fits::fitsFile< dataT >::write	(	const dataT *	im,
		int	d1,
		int	d2,
		int	d3,
		fitsHeader &	head
	)

Write the contents of a raw array to the FITS file.

Note: the type of the array must match dataT

Returns: 0 on success; -1 on error

Parameters

[in]	im	is the array
[in]	d1	is the first dimension
[in]	d2	is the second dimension
[in]	d3	is the third dimenesion (minimum value is 1)
[in]	head	is the header

Definition at line 1432 of file fitsFile.hpp.

◆ write() [3/7]

template<typename dataT >

int mx::fits::fitsFile< dataT >::write	(	const dataT *	im,
		int	d1,
		int	d2,
		int	d3,
		fitsHeader *	head
	)

Write the contents of a raw array to the FITS file.

Returns: 0 on success; -1 on error

Parameters

[in]	im	is the array
[in]	d1	is the first dimension
[in]	d2	is the second dimension
[in]	d3	is the third dimenesion (minimum value is 1)
[in]	head	a pointer to the header. Set to 0 if not used.

Definition at line 1329 of file fitsFile.hpp.

References mx::fits::fitsHeader::begin(), mx::fits::fitsHeader::end(), and mx::fits::fitsErrText().

Referenced by mx::AO::sim::simulatedAOSystem< _realT, _wfsT, _reconT, _filterT, _dmT, _turbSeqT, _coronT >::~simulatedAOSystem(), mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::analyzePSDGrid(), mx::AO::circularApodizedPupil(), mx::AO::circularPupil(), mx::AO::analysis::fourierCovarMap(), mx::AO::sim::turbAtmosphere< _aoSystemT >::genLayers(), mx::AO::ifPInv(), mx::AO::influenceFunctionsGaussian(), mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::intensityPSD(), mx::AO::m2cMatrix(), mx::improc::ADIobservation< _realT, _derotFunctObj >::makeMaskCube(), mx::AO::makeModfBasis(), mx::AO::modalDMM2cMatrix(), mx::AO::modesOnDM(), mx::wfp::lyotCoronagraph< _realT, _fpmaskFloatT >::optimizeAPLCMC(), mx::wfp::lyotCoronagraph< _realT, _fpmaskFloatT >::optimizeAPLCMC(), mx::improc::HCIobservation< _realT >::outputPreProcessed(), mx::improc::HCIobservation< _realT >::outputPSFSub(), mx::improc::KLIPreduction< _realT, _derotFunctObj, _evCalcT >::regions(), mx::AO::sim::directPhaseReconstructor< realT >::saveRMat(), SCENARIO(), SCENARIO(), SCENARIO(), mx::improc::KLIPreduction< _realT, _derotFunctObj, _evCalcT >::worker(), mx::improc::HCIobservation< _realT >::writeFinim(), and mx::AO::analysis::zernikeCovarMap().

◆ write() [4/7]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::write	(	const std::string &	fname,
		const arrT &	im
	)

Write the contents of an Eigen-type array to a FITS file.

The type arrT can be any type with the following members defined:

data() (returns a pointer to the underlying array)
rows() (returrns the number of rows)
cols() (returns the number of columns)
may have planes() defined

Note: as with all write methods, the Scalar type of the array must match dataT

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[in]	fname	is the name of the file.
[in]	im	is the array

Definition at line 1455 of file fitsFile.hpp.

◆ write() [5/7]

template<typename dataT >

template<typename arrT >

int mx::fits::fitsFile< dataT >::write	(	const std::string &	fname,
		const arrT &	im,
		fitsHeader &	head
	)

Write the contents of an Eigen-type array to a FITS file.

The type arrT can be any type with the following members defined:

data() (returns a pointer to the underlying array)
rows() (returrns the number of rows)
cols() (returns the number of columns)
may have planes() defined.

Note: as with all write methods, the Scalar type of the array must match dataT

Template Parameters

arrT	is the type of array, see requirements above.

Returns: 0 on success; -1 on error

Parameters

[in]	fname	is the file path, which is passed to fileName
[in]	im	is the array
[in]	head	is a fitsHeader object which is passed to readHeader

Definition at line 1464 of file fitsFile.hpp.

◆ write() [6/7]

template<typename dataT >

int mx::fits::fitsFile< dataT >::write	(	const std::string &	fname,
		const dataT *	im,
		int	d1,
		int	d2,
		int	d3
	)

Write the contents of a raw array to the FITS file.

Returns: 0 on success; -1 on error

Parameters

[in]	fname	is the name of the file.
[in]	im	is the array
[in]	d1	is the first dimension
[in]	d2	is the second dimension
[in]	d3	is the third dimenesion (minimum value is 1)

Definition at line 1438 of file fitsFile.hpp.

◆ write() [7/7]

template<typename dataT >

int mx::fits::fitsFile< dataT >::write	(	const std::string &	fname,
		const dataT *	im,
		int	d1,
		int	d2,
		int	d3,
		fitsHeader &	head
	)

Write the contents of a raw array to the FITS file.

Returns: 0 on success; -1 on error

Parameters

[in]	fname	is the name of the file.
[in]	im	is the array
[in]	d1	is the first dimension
[in]	d2	is the second dimension
[in]	d3	is the third dimenesion (minimum value is 1)
[in]	head	is the header

The number of frames to read from a cube.

Definition at line 97 of file fitsFile.hpp.

The documentation for this class was generated from the following file:

ioutils/fits/fitsFile.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Reading Basic Arrays

Constructor & Destructor Documentation

◆ fitsFile() [1/2]

◆ fitsFile() [2/2]

◆ ~fitsFile()

Member Function Documentation

◆ close()

◆ construct()

◆ fileName() [1/2]

◆ fileName() [2/2]

◆ getDimensions()

◆ getSize() [1/2]

◆ getSize() [2/2]

◆ naxes()

◆ naxis()

◆ open() [1/2]

◆ open() [2/2]

◆ pixarrs()

◆ read() [1/12]

◆ read() [2/12]

◆ read() [3/12]

◆ read() [4/12]

◆ read() [5/12]

◆ read() [6/12]

◆ read() [7/12]

◆ read() [8/12]

◆ read() [9/12]

◆ read() [10/12]

◆ read() [11/12]

◆ read() [12/12]

◆ readHeader() [1/3]

◆ readHeader() [2/3]

◆ readHeader() [3/3]

◆ setCubeReadSize() [1/2]

◆ setCubeReadSize() [2/2]

◆ setReadSize() [1/2]

◆ setReadSize() [2/2]

◆ write() [1/7]

◆ write() [2/7]

◆ write() [3/7]

◆ write() [4/7]

◆ write() [5/7]

◆ write() [6/7]

◆ write() [7/7]

Member Data Documentation

◆ m_anynul

◆ m_fileName

◆ m_fptr

◆ m_isOpen

◆ m_naxes

◆ m_naxis

◆ m_noComment

◆ m_nulval

◆ m_x0

◆ m_xpix

◆ m_y0

◆ m_ypix

◆ m_z0

◆ m_zframes