#include <pfitsio.h>

Collaboration diagram for purify::pfitsio::header_params:

Public Member Functions
	header_params (const std::string &fits_name_, const std::string &pix_units_, const t_real channels_total_, const t_real ra_, const t_real dec_, const stokes pol, const t_real cellx_, const t_real celly_, const t_real mean_frequency_, const t_real channel_width_, const t_uint niters_, const bool hasconverged_, const t_real relative_variation_, const t_real residual_convergence_, const t_real epsilon_)
	create fits header object and fill More...

	header_params ()
	create empty fits header More...

bool	operator== (const header_params &h2) const

bool	operator!= (const header_params &h2) const

Public Attributes
std::string	fits_name = "output_image.fits"

t_real	mean_frequency = 0

t_real	cell_x = 1

t_real	cell_y = 1

t_real	ra = 0

t_real	dec = 0

t_int	pix_ref_x = 0

t_int	pix_ref_y = 0

std::string	pix_units = "Jy/BEAM"

t_real	channels_total = 1

t_real	channel_width = 8

t_real	polarisation = 1

t_int	niters = 0

bool	hasconverged = false

t_real	relative_variation = 0

t_real	residual_convergence = 0

t_real	epsilon = 0

Detailed Description

Definition at line 13 of file pfitsio.h.

Constructor & Destructor Documentation

◆ header_params() [1/2]

purify::pfitsio::header_params::header_params	(	const std::string &	fits_name_,
		const std::string &	pix_units_,
		const t_real	channels_total_,
		const t_real	ra_,
		const t_real	dec_,
		const stokes	pol,
		const t_real	cellx_,
		const t_real	celly_,
		const t_real	mean_frequency_,
		const t_real	channel_width_,
		const t_uint	niters_,
		const bool	hasconverged_,
		const t_real	relative_variation_,
		const t_real	residual_convergence_,
		const t_real	epsilon_
	)

inline

create fits header object and fill

Definition at line 33 of file pfitsio.h.

       : fits_name(fits_name_),
         pix_units(pix_units_),
         channels_total(channels_total_),
         mean_frequency(mean_frequency_),
         channel_width(channel_width_),
         cell_x(cellx_),
         cell_y(celly_),
         ra(ra_),
         dec(dec_),
         niters(niters_),
         hasconverged(hasconverged_),
         epsilon(epsilon_),
         relative_variation(relative_variation_),
         residual_convergence(residual_convergence_) {
     try {
       this->polarisation = stokes_int.at(pol);
     } catch (std::out_of_range &e) {
       PURIFY_LOW_LOG("Polarisation type not recognised by FITS, assuming Stokes I.");
       this->polarisation = stokes_int.at(stokes::I);
     };
   };

References purify::I, PURIFY_LOW_LOG, and purify::stokes_int.

◆ header_params() [2/2]

purify::pfitsio::header_params::header_params ( )

inline

create empty fits header

Definition at line 61 of file pfitsio.h.

61 {};

Member Function Documentation

◆ operator!=()

bool purify::pfitsio::header_params::operator!= ( const header_params & h2 ) const

inline

Definition at line 74 of file pfitsio.h.

74 { return not(*this == h2); }

◆ operator==()

bool purify::pfitsio::header_params::operator== ( const header_params & h2 ) const

inline

Definition at line 63 of file pfitsio.h.

                                                  {
     return PURIFY_MACRO(mean_frequency, h2) and PURIFY_MACRO(cell_x, h2) and
            PURIFY_MACRO(cell_y, h2) and PURIFY_MACRO(ra, h2) and PURIFY_MACRO(dec, h2) and
            PURIFY_MACRO(pix_ref_x, h2) and PURIFY_MACRO(pix_ref_y, h2) and
            PURIFY_MACRO(pix_units, h2) and PURIFY_MACRO(channels_total, h2) and
            PURIFY_MACRO(channel_width, h2) and PURIFY_MACRO(polarisation, h2) and
            PURIFY_MACRO(niters, h2) and PURIFY_MACRO(hasconverged, h2) and
            PURIFY_MACRO(relative_variation, h2) and PURIFY_MACRO(residual_convergence, h2) and
            PURIFY_MACRO(epsilon, h2);
   }