Loads and unloads PSRFITS archives. More...

#include <FITSArchive.h>

Inheritance diagram for Pulsar::FITSArchive:

Public Member Functions
	FITSArchive ()
	Default constructor.

	FITSArchive (const FITSArchive &archive)
	Copy constructor.

	~FITSArchive ()
	Destructor.

const FITSArchive &	operator= (const FITSArchive &archive)
	Assignment operator.

	FITSArchive (const Archive &archive)
	Base copy constructor.

void	copy (const Archive &archive)
	Copy all of the class attributes and the selected Integration data. More...

FITSArchive *	clone () const
	Return a pointer to a new copy constructed instance equal to this. More...

void	update_history ()
	Add a new row to the history, reflecting the current state.

void	unload (fitsfile , const Pointing , int row) const
	Unload Pointing to the specified row of the subint table. More...

double	get_offs_sub (unsigned int isub) const
	Get the offs_sub value (only present in fits files)

void	refmjd_rounding_correction ()

void	set_search_mode ()
	Indicate the FITSArchive contains search mode data.

Public Member Functions inherited from Pulsar::BasicArchive
	BasicArchive ()
	null constructor

	BasicArchive (const BasicArchive &archive)
	copy constructor

const BasicArchive &	operator= (const BasicArchive &archive)
	assignment operator

	~BasicArchive ()
	destructor

virtual std::string	get_telescope () const
	�Get the name of the telescope

virtual void	set_telescope (const std::string &)
	�Set the name of the telescope

virtual Signal::State	get_state () const
	Get the state of the profiles. More...

virtual void	set_state (Signal::State state)
	Set the state of the profiles. More...

virtual Signal::Scale	get_scale () const
	Get the scale in which flux density is measured. More...

virtual void	set_scale (Signal::Scale scale)
	Set the scale in which flux density is measured. More...

virtual Signal::Source	get_type () const
	Get the observation type (psr, cal) More...

virtual void	set_type (Signal::Source type)
	Set the observation type (psr, cal) More...

virtual std::string	get_source () const
	Get the source name.

virtual void	set_source (const std::string &source)
	Set the source name.

virtual sky_coord	get_coordinates () const
	Get the coordinates of the source.

virtual void	set_coordinates (const sky_coord &coordinates)
	Set the coordinates of the source.

virtual unsigned	get_nbin () const
	Get the number of pulsar phase bins used. More...

virtual unsigned	get_nchan () const
	Get the number of frequency channels used. More...

virtual unsigned	get_npol () const
	Get the number of frequency channels used. More...

virtual unsigned	get_nsubint () const
	Get the number of sub-integrations stored in the file. More...

virtual double	get_bandwidth () const
	Get the overall bandwidth of the observation. More...

virtual void	set_bandwidth (double bw)
	Set the overall bandwidth of the observation. More...

virtual double	get_centre_frequency () const
	Get the centre frequency of the observation. More...

virtual void	set_centre_frequency (double cf)
	Set the centre frequency of the observation.

virtual double	get_dispersion_measure () const
	Get the dispersion measure (in ${\rm pc\, cm}^{-3}$ ) More...

virtual void	set_dispersion_measure (double dm)
	Set the dispersion measure (in ${\rm pc\, cm}^{-3}$ ) More...

virtual bool	get_dedispersed () const
	Inter-channel dispersion delay has been removed.

virtual void	set_dedispersed (bool done=true)
	Set the status of the dispersion delay flag. More...

virtual double	get_rotation_measure () const
	Get the rotation measure (in ${\rm rad\, m}^{-2}$ )

virtual void	set_rotation_measure (double rm)
	Set the rotation measure (in ${\rm rad\, m}^{-2}$ )

virtual bool	get_faraday_corrected () const
	data have been corrected for ISM faraday rotation More...

virtual void	set_faraday_corrected (bool done=true)
	Set the status of the ISM RM flag. More...

virtual bool	get_poln_calibrated () const
	Data has been poln calibrated.

virtual void	set_poln_calibrated (bool done=true)
	Set the status of the poln calibrated flag.

Public Member Functions inherited from Pulsar::Archive
	Archive ()
	Default constructor.

	Archive (const Archive &archive)
	Copy constructor. More...

virtual	~Archive ()
	Destructor.

Archive &	operator= (const Archive &a)
	Assignment operator. More...

template<class T >
const T *	get () const

template<class T >
T *	get ()

template<class T >
T *	getadd ()

void	copy (const Archive &)
	Copy all base class attributes, Extensions, and Integrations.

void	copy (const Archive *)
	Copy all base class attributes, Extensions, and Integrations.

Archive *	total (bool tscrunch=true) const
	Return pointer to a new fscrunched, tscrunched and pscrunched clone. More...

Archive *	tscrunched () const
	Return pointer to a new tscrunched clone. More...

Archive *	extract (std::vector< unsigned > &subints) const
	Return pointer to a new instance with only the specified subints.

Profile *	get_Profile (unsigned subint, unsigned pol, unsigned chan)
	Return pointer to the specified profile. More...

const Profile *	get_Profile (unsigned subint, unsigned pol, unsigned chan) const
	Return pointer to the specified profile.

void	set_ephemeris (const Parameters *ephemeris, bool update=true)
	Install the given ephemeris and call update_model. More...

const Parameters *	get_ephemeris () const
	Return a pointer to the current archive ephemeris.

bool	has_ephemeris () const
	Return true if the Archive has an ephemeris.

void	set_model (const Predictor *model, bool apply=true)
	Install the given predictor and shift profiles to align.

const Predictor *	get_model () const
	Return a pointer to the current phase predictor.

bool	has_model () const
	Returns true if the Archive has a model.

void	update_model ()
	Create a new predictor and align the Integrations to the new model. More...

void	bscrunch (unsigned nscrunch)
	Integrate pulse profiles in phase. More...

void	fold (unsigned nfold)
	Integrate neighbouring sections of the pulse profiles. More...

void	pscrunch ()
	Integrate profiles in polarization. More...

void	fscrunch (unsigned nscrunch=0)
	Integrate profiles in frequency. More...

void	tscrunch (unsigned nscrunch=0)
	Integrate profiles in time. More...

void	rotate (double time)
	Phase rotate each profile by time seconds.

void	rotate_phase (double phase)
	Rotate each profile by phase.

void	append (const Archive *archive)
	Append the Integrations from the specifed archive. More...

void	remove_chan (unsigned first, unsigned last)
	Delete the specified inclusive channel range from the Archive.

void	update_centre_frequency ()
	Update the centre frequency.

void	centre (double phase_offset=0.5)
	Phase rotate pulsar Integrations so that pulse phase zero is centred. More...

void	centre_max_bin (double phase_offset=0.5)
	Phase rotate pulsar Integrations so centre the maximum amplitude. More...

void	convert_state (Signal::State state)
	Convert data to the specified state. More...

Signal::Basis	get_basis () const
	Convenience interface to Receiver::get_basis.

void	dedisperse ()
	Rotate the Profiles to remove dispersion delays b/w chans. More...

void	defaraday ()
	Correct the Faraday rotation of Q into U. More...

void	transform (const Jones< float > &)
	Perform the transformation on each polarimetric profile.

void	transform (const std::vector< Jones< float > > &)
	Perform frequency response on each polarimetric profile.

void	transform (const std::vector< std::vector< Jones< float > > > &)
	Perform the time and frequency response on each polarimetric profile.

void	invint ()
	Transform Stokes I,Q,U,V into the polarimetric invariant interval.

PhaseWeight *	baseline () const
	Return a new PhaseWeight instance with the baseline phase bins masked.

void	remove_baseline ()
	Remove the baseline from all profiles.

void	uniform_weight (float new_weight=1.0)
	Set the weight of each profile to the given number.

bool	standard_match (const Archive *arch, std::string &reason) const
	Test if arch matches (enough for a pulsar - standard match)

bool	calibrator_match (const Archive *arch, std::string &reason) const
	Test if arch matches (enough for a pulsar - calibrator match)

bool	processing_match (const Archive *arch, std::string &reason) const
	Test if arch matches (enough for a pulsar - pulsar match)

bool	mixable (const Archive *arch, std::string &reason) const
	Test if arch is mixable (enough for append)

double	weighted_frequency (unsigned ichan, unsigned start, unsigned end) const
	Computes the weighted channel frequency over an Integration interval. More...

void	bscrunch_to_nbin (unsigned new_nbin)
	Call bscrunch with the appropriate value. More...

void	fscrunch_to_nchan (unsigned new_nchan)
	Call fscrunch with the appropriate value. More...

void	tscrunch_to_nsub (unsigned new_nsub)
	Call tscrunch with the appropriate value. More...

MJD	start_time () const
	Return the MJD at the start of the first sub-integration.

MJD	end_time () const
	Return the MJD at the end of the last sub-integration.

double	integration_length () const
	Returns the total time integrated into all Integrations (in seconds)

bool	type_is_cal () const
	Return true if the observation is a calibrator.

void	find_transitions (int &hi2lo, int &lo2hi, int &buffer) const
	Find the transitions between high and low states in total intensity. More...

void	find_peak_edges (int &rise, int &fall) const
	Find the bins in which the total intensity exceeds a threshold. More...

float	find_max_phase () const
	Returns the centre phase of the region with maximum total intensity. More...

float	find_min_phase (float dc=0.15) const
	Returns the centre phase of the region with minimum total intensity. More...

float	rms_baseline (float dc=0.4)
	Returns geometric mean of baseline RMS for each Integration. More...

virtual Interface *	get_interface ()
	Return a text interface that can be used to access this instance.

void	unload (const char *filename=0) const
	Write the archive to filename. More...

void	unload (const std::string &filename) const
	Convenience interface to Archive::unload (const char*)

std::string	get_filename () const
	Get the name of the file to which the archive will be unloaded.

void	set_filename (const std::string &filename)
	Set the filename of the Archive. More...

void	update ()
	Update the current archive, saving current Integration data.

void	refresh ()
	Completely reload the archive, deleting all data.

virtual void	resize (unsigned nsubint, unsigned npol=0, unsigned nchan=0, unsigned nbin=0)
	Resize the Integration vector with new_Integration instances. More...

virtual void	erase (unsigned isubint)
	Remove the specified sub-integration.

void	reverse_chan ()
	Reverse the order of frequency channels.

virtual unsigned	get_nextension () const
	Return the number of extensions available.

virtual const Extension *	get_extension (unsigned iextension) const
	Return a pointer to the specified extension. More...

virtual Extension *	get_extension (unsigned iextension)
	Return a pointer to the specified extension. More...

template<class ExtensionType >
const ExtensionType *	get () const
	Template method searches for an Extension of the specified type.

template<class ExtensionType >
ExtensionType *	get ()
	Template method searches for an Extension of the specified type.

template<class ExtensionType >
ExtensionType *	getadd ()
	Template method returns an Extension of the specified type.

virtual void	add_extension (Extension *extension)
	Add an Extension to the Archive instance. More...

Expert *	expert ()
	Provide access to the expert interface.

const Expert *	expert () const
	The default baseline removal strategy.

const Match *	get_standard_match () const
	Policy determines if a standard/template matches an observation.

void	set_standard_match (Match *)
	The default baseline removal strategy.

const Match *	get_calibrator_match () const
	Policy determines if a calibrator matches an observation.

void	set_calibrator_match (Match *)
	The default baseline removal strategy.

const Match *	get_processing_match () const
	Policy determines if data were processed identically.

void	set_processing_match (Match *)
	The default baseline removal strategy.

const Match *	get_mixable () const
	Policy determines if data can be combined/integrated.

void	set_mixable (Match *)
	The default baseline removal strategy.

StrategySet *	get_strategy () const
	Returns the strategy manager.

Public Member Functions inherited from Pulsar::IntegrationManager
	IntegrationManager ()
	null constructor

	IntegrationManager (const IntegrationManager &archive)
	copy constructor

IntegrationManager &	operator= (const IntegrationManager &archive)
	operator =

virtual	~IntegrationManager ()
	destructor

Integration *	get_Integration (unsigned subint)
	Return pointer to the specified Integration. More...

Integration *	get_last_Integration ()
	Return a pointer to the last Integration.

Integration *	get_first_Integration ()
	Return a pointer to the first Integration.

const Integration *	get_Integration (unsigned subint) const
	Return const pointer to the specified Integration.

const Integration *	get_last_Integration () const
	Return a const pointer to the last Integration.

const Integration *	get_first_Integration () const
	Return a const pointer to the first Integration.

template<class StrictWeakOrdering >
void	sort (StrictWeakOrdering comp=temporal_order)
	Sort the Integrations according to the specified order.

void	shuffle ()
	Randomly rearrange the sub-integrations.

Expert *	expert ()
	Provide access to the expert interface. More...

Public Member Functions inherited from Reference::Able
	Able (const Able &)

Able &	operator= (const Able &)

unsigned	get_reference_count () const

Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)

HeapTracked &	operator= (const HeapTracked &)

bool	__is_on_heap () const

Static Public Member Functions
static std::string	get_template_name ()
	Return the name of the PSRFITS definition template file.

static void	unload (fitsfile , const FITSHdrExtension )
	Unload FITSHdrExtension to the current HDU of the specified FITS file.

static void	unload (fitsfile , const ObsExtension )
	Unload ObsExtension to the current HDU of the specified FITS file.

static void	unload (fitsfile , const Receiver )
	Unload Receiver to the current HDU of the specified FITS file.

static void	unload (fitsfile , const WidebandCorrelator )
	Unload WidebandCorrelator to the current HDU of the specified FITS file.

static void	unload (fitsfile , const ITRFExtension )
	Unload ITRFExtension to the current HDU of the specified FITS file.

static void	unload (fitsfile , const CalInfoExtension )
	Unload CalInfoExtension to the current HDU of the specified FITS file.

static void	unload (fitsfile , const ProcHistory )
	Unload ProcHistory to the HISTORY HDU.

static void	unload (fitsfile , const Passband )
	Unload Passband to the BANDPASS HDU.

static void	unload (fitsfile , const DigitiserStatistics )
	Unload DigitiserStatistics to the DIG_STAT HDU.

static void	unload (fitsfile , const DigitiserCounts )
	Unload DigitiserCounts to DIG_CNTS HDU. More...

static void	unload (fitsfile , const PolnCalibratorExtension )
	Unload PolnCalibratorExtension to the FEEDPAR HDU.

static void	unload (fitsfile , const FluxCalibratorExtension )
	Unload FluxCalibratorExtension to the FLUX_CAL HDU.

static void	unload (fitsfile , const CalibratorStokes )
	Unload CalibratorStokes to the CAL_POLN HDU.

static void	unload (fitsfile , const CalibrationInterpolatorExtension )
	Unload CalibrationInterpolatorExtension to the PCMINTER HDU.

static void	unload (fitsfile , const FITSSUBHdrExtension )
	Unload FITSSUBHdrExtension.

static void	unload (fitsfile , const CoherentDedispersion )
	Unload CoherentDedispersion.

static void	unload (fitsfile , const AuxColdPlasmaMeasures , int row)
	Unload AuxColdPlasmaMeausres to the specified row of the subint table. More...

static void	unload (fitsfile , const ObsDescription )
	Unload the observation description.

static void	unload (fitsfile , const CrossCovarianceMatrix )
	Unload the Cross-Covariance Matrix Data.

Static Public Member Functions inherited from Pulsar::BasicArchive
static void	ensure_linkage ()
	Ensure that BasicArchive code is linked. More...

Static Public Member Functions inherited from Pulsar::Archive
static Archive *	new_Archive (const std::string &class_name)
	Factory returns a null-constructed instance of the named class. More...

static Archive *	load (const std::string &name)
	Factory returns a new instance loaded from filename.

static unsigned	get_instance_count ()
	Returns the number of Archive instances currently in existence.

static void	agent_report ()
	Report on the status of the plugins.

static void	agent_list ()
	List the successfully loaded plugins.

static void	set_verbosity (unsigned level)
	Set the verbosity level (0 to 3)

Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()

Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)

static void	operator delete (void location, void ptr)

static void	operator delete (void *location)

static size_t	get_heap_queue_size ()

Protected Member Functions
virtual void	load_header (const char *filename)
	Load the FITS header information from filename. More...

virtual Integration *	load_Integration (const char *filename, unsigned subint)
	Load the specified Integration from filename, returning new instance. More...

bool	can_unload () const
	The unload_file method is implemented.

virtual void	unload_file (const char *filename) const
	Unload the FITSArchive (header and Integration data) to filename.

template<typename T >
void	load_amps (fitsfile , Integration , unsigned isubint, int colnum)
	Load data of any type.

void	load_Parameters (fitsfile *)

void	unload_Parameters (fitsfile *) const

void	load_Predictor (fitsfile *)

void	unload_Predictor (fitsfile *) const

void	load_ProcHistory (fitsfile *)

void	no_ProcHistory (fitsfile *)

void	load_DigitiserStatistics (fitsfile *)

void	load_DigitiserCounts (fitsfile *)
	FITSArchive::load_DigitiserCounts Creates a DigitiserCounts extension and loads it from the fits file given. More...

void	load_Passband (fitsfile *)

void	load_PolnCalibratorExtension (fitsfile *)

void	load_FluxCalibratorExtension (fitsfile *)

void	load_CalibratorStokes (fitsfile *)

void	load_CalibrationInterpolatorExtension (fitsfile *)

void	load_Receiver (fitsfile *)

void	load_ITRFExtension (fitsfile *)

void	load_CalInfoExtension (fitsfile *)

void	load_WidebandCorrelator (fitsfile *)

void	load_FITSSUBHdrExtension (fitsfile *)

void	load_CoherentDedispersion (fitsfile *)

void	load_ObsDescription (fitsfile *)

void	load_CrossCovarianceMatrix (fitsfile *)

template<class Ext >
void	unload (fitsfile , const char hdu_name) const

void	load_integration_state (fitsfile *)

void	load_state (fitsfile *)

void	load_Pointing (fitsfile , int row, Integration )

void	load_Plasma (fitsfile , int row, Integration )

void	load_SpectralKurtosis (fitsfile , int row, Integration )

void	interpret_scale ()

void	interpret_pol_type ()

void	unload_Integration (fitsfile , int row, const Integration ) const
	A function to write an integration to a row in a FITS file on disk.

void	unload_integrations (fitsfile *) const
	Unload Integration data to the SUBINT HDU of the specified FITS file.

void	clean_Pointing_columns (fitsfile *) const
	Delete Pointing-related columns, if not needed.

void	add_Pointing_columns (fitsfile *) const
	Add additional Pointing::Info columns, if needed.

void	load_Pointing_columns (fitsfile *fptr)
	Load additional Pointing::Info column information, if any.

int	get_last_pointing_column (fitsfile *fptr) const
	Get the column past which to write/read additional Pointing::Info.

void	unload_sk_integrations (fitsfile *) const
	Unload Spectral Kurtosis Integration data to the SPECKURT HDU.

Protected Member Functions inherited from Pulsar::BasicArchive
virtual void	set_nbin (unsigned nbin)
	Set the number of pulsar phase bins used. More...

virtual void	set_nchan (unsigned nchan)
	Set the number of frequency channels used. More...

virtual void	set_npol (unsigned npol)
	Set the number of frequency channels used. More...

virtual void	set_nsubint (unsigned nsubint)
	Set the number of sub-integrations stored in the file. More...

Integration *	new_Integration (const Integration *copy_this=0)
	Return a pointer to a new BasicIntegration. More...

Protected Member Functions inherited from Pulsar::Archive
Integration *	use_Integration (Integration *)
	Return the given Integration ready for use.

void	init_Integration (Integration *subint, bool check_phase=false)
	Initialize an Integration to reflect Archive attributes. More...

void	resize_Integration (Integration *integration)
	Provide Integration::resize access to Archive-derived classes.

void	apply_model (Integration subint, const Predictor old=0)
	Apply the current model to the Integration. More...

void	update_model (unsigned old_nsubint, bool clear_model=false)
	Update the predictor model and correct the Integration set. More...

void	update_model (const MJD &time, bool clear_model=false)
	Update the predictor to include the specifed MJD.

void	create_updated_model (bool clear_model)
	Creates polynomials to span the Integration set. More...

bool	good_model (const Predictor *test_model) const
	Returns true if the given model spans the Integration set. More...

bool	zero_phase_aligned () const
	Return true if all Integration::zero_phase_aligned flags are set.

Protected Member Functions inherited from Pulsar::IntegrationManager
virtual void	_resize (unsigned nsubint, bool instances=true)
	Resize the Integration vector. More...

void	append (const IntegrationManager *more_subints)
	Append new_Integration copies of Integration objects to self.

void	manage (IntegrationManager *more_subints)
	Append use_Integration modifications of Integration objects to self.

void	manage (Integration *integration)
	Directly append the Integration instance (no copy)

void	insert (unsigned isubint, Integration *integration)
	Insert the Integration instance into the specified location.

void	unmanage (const Integration *)
	Remove the Integration instance.

void	unmanage (unsigned isubint)
	Remove the Integration at the specified index.

void	load_all ()
	Load all sub-integrations.

Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const

void	__dereference (bool auto_delete=true) const

Static Protected Member Functions
static void	delete_hdu (fitsfile , const char hdu_name)
	Delete the HDU with the specified name. More...

Static Protected Member Functions inherited from Pulsar::Archive
static std::string	get_revision (const char *revision)
	Parses the revision number out of the CVS Revision string.

Protected Attributes
float	psrfits_version
	The PSRFITS version.

double	chanbw
	Channel bandwidth.

bool	scale_cross_products
	Double cross coherence term.

std::string	state_scale
	String describing scale.

std::string	state_pol_type
	String describing polarization state.

double	predicted_phase
	Extra polyco information stored in POLYCO HDU.

Reference::To< Predictor >	hdr_model
	The polyco parsed from the PSRFITS file.

Protected Attributes inherited from Pulsar::BasicArchive
std::string	telescope
	�The name of the telescope

Signal::Basis	basis
	The feed configuration of the receiver.

Signal::State	state
	The state of the profiles.

Signal::Scale	scale
	The scale in which flux density is measured.

Signal::Source	type
	The observation type (psr, cal)

std::string	source
	The source name.

sky_coord	coordinates
	The coordinates of the source.

unsigned	nbin
	The number of pulsar phase bins used. More...

unsigned	nchan
	The number of frequency channels used. More...

unsigned	npol
	The number of frequency channels used. More...

unsigned	nsubint
	The number of sub-integrations stored in the file. More...

double	bandwidth
	The overall bandwidth of the observation.

double	centre_frequency
	The centre frequency of the observation.

double	dispersion_measure
	The dispersion measure (in ${\rm pc\, cm}^{-3}$ )

double	rotation_measure
	The rotation measure (in ${\rm rad\, m}^{-2}$ )

bool	dedispersed
	data have been dedispersed

bool	faraday_corrected
	data have been corrected for ISM faraday rotation

bool	poln_calibrated
	Data has been poln calibrated.

Protected Attributes inherited from Pulsar::Archive
std::string	unload_filename
	Name of file to which the archive will be written on call to unload()

Reference::To< Parameters >	ephemeris
	The pulsar ephemeris, as used by TEMPO.

Reference::To< Predictor >	model
	The pulsar phase model, as created using TEMPO.

Reference::To< Expert >	expert_interface
	Expert interface.

Reference::To< Interface >	text_interface
	Text interface.

Reference::To< Match >	standard_match_policy
	The pulsar ephemeris, as used by TEMPO.

Reference::To< Match >	calibrator_match_policy
	The pulsar ephemeris, as used by TEMPO.

Reference::To< Match >	processing_match_policy
	The pulsar ephemeris, as used by TEMPO.

Reference::To< Match >	mixable_policy
	The pulsar ephemeris, as used by TEMPO.

Friends
class	Archive::Advocate< FITSArchive >

Additional Inherited Members
Static Public Attributes inherited from Pulsar::Archive
static Functor< void(Archive *) >	remove_baseline_strategy
	The default baseline removal strategy.

Static Public Attributes inherited from Pulsar::IntegrationManager
static unsigned	verbose = 1
	A verbosity flag that can be set for debugging purposes.

Static Protected Attributes inherited from Pulsar::Archive
static Option< std::string >	unload_class
	Name of class to which data are converted if unload_file unimplemented.

static Option< bool >	no_clobber
	Default policy for overwriting archive files.

Detailed Description

Loads and unloads PSRFITS archives.

This class implements load and unload functions to read/write data from PSRFITS files into an Archive class. It also defines variables to store some of the extra information provided by the PSRFITS file format.

PSRFITS template was developed by Dick Manchester and collaborators at the ATNF, ASTRON, and Swinburne. It is used primarily with the wideband pulsar correlator at the Parkes radio telescope.

Member Function Documentation

◆ clone()

Pulsar::FITSArchive * Pulsar::FITSArchive::clone ( ) const

virtual

Return a pointer to a new copy constructed instance equal to this.

Returns a pointer to a new copy-constructed FITSArchive instance.

Implements Pulsar::Archive.

◆ copy()

void Pulsar::FITSArchive::copy ( const Archive & archive )

Copy all of the class attributes and the selected Integration data.

The Integration subset can contain anywhere between none and all of integrations in the source Archive

References chanbw, and scale_cross_products.

◆ delete_hdu()

void Pulsar::FITSArchive::delete_hdu	(	fitsfile *	ffptr,
		const char *	name
	)

staticprotected

Delete the HDU with the specified name.

Parameters

ffptr	reference to the PSRFITS file to be modified
hdu_name	name of the HDU to remove from ffptr

References Pulsar::warning.

Referenced by unload().

◆ load_DigitiserCounts()

void FITSArchive::load_DigitiserCounts ( fitsfile * fptr )

protected

FITSArchive::load_DigitiserCounts Creates a DigitiserCounts extension and loads it from the fits file given.

Parameters

fptr	The fitsfile to load the extension from.

References Pulsar::Archive::add_extension(), and Pulsar::IntegrationManager::verbose.

◆ load_header()

void Pulsar::FITSArchive::load_header ( const char * filename )

protectedvirtual

Load the FITS header information from filename.

Read FITS header info from a file into a FITSArchive object.

Implements Pulsar::Archive.

◆ load_Integration()

Pulsar::Integration * Pulsar::FITSArchive::load_Integration	(	const char *	filename,
		unsigned	isubint
	)

protectedvirtual

Load the specified Integration from filename, returning new instance.

A function to read a single integration from a FITS file on disk.

This function assumes that the Integration will have the global attributes of the file.

Implements Pulsar::Archive.

References Pulsar::CalInfoExtension::cal_frequency, Signal::Coherence, Pulsar::FITSHdrExtension::get_start_time(), Reference::To< class, active >::release(), Pulsar::MoreProfiles::resize(), and Pulsar::warning.

◆ load_Plasma()

void Pulsar::FITSArchive::load_Plasma	(	fitsfile *	fptr,
		int	row,
		Pulsar::Integration *	integ
	)

protected

Precondition: The current HDU is the SUBINT HDU

References Pulsar::Integration::add_extension(), and Pulsar::IntegrationManager::verbose.

◆ load_Pointing()

void Pulsar::FITSArchive::load_Pointing	(	fitsfile *	fptr,
		int	row,
		Pulsar::Integration *	integ
	)

protected

Precondition: The current HDU is the SUBINT HDU

References Pulsar::Integration::add_extension(), and Pulsar::Pointing::Info::get_name().

◆ load_SpectralKurtosis()

void Pulsar::FITSArchive::load_SpectralKurtosis	(	fitsfile *	fptr,
		int	row,
		Pulsar::Integration *	integ
	)

protected

Precondition: The current HDU is the SUBINT HDU

References Pulsar::Integration::add_extension().

◆ load_state()

void Pulsar::FITSArchive::load_state ( fitsfile * fptr )

protected

Precondition: the current HDU is the SUBINT binary table

◆ unload() [1/3]

void Pulsar::FITSArchive::unload	(	fitsfile *	fptr,
		const AuxColdPlasmaMeasures *	ext,
		int	row
	)

static

Unload AuxColdPlasmaMeausres to the specified row of the subint table.

Precondition: The current HDU is the SUBINT HDU

References Pulsar::AuxColdPlasmaMeasures::get_dispersion_measure(), and Pulsar::AuxColdPlasmaMeasures::get_rotation_measure().

◆ unload() [2/3]

void Pulsar::FITSArchive::unload	(	fitsfile *	fptr,
		const DigitiserCounts *	const_ext
	)

static

Unload DigitiserCounts to DIG_CNTS HDU.

FITSArchive::unload Unload the DigitierCounts extension to the fits file given.

Parameters

fptr	The fits file to unload to
const_ext	The DigitiserCounts extension to unload

References delete_hdu(), and Pulsar::IntegrationManager::verbose.

◆ unload() [3/3]

void Pulsar::FITSArchive::unload	(	fitsfile *	fptr,
		const Pointing *	ext,
		int	row
	)		const

Unload Pointing to the specified row of the subint table.

Precondition: The current HDU is the SUBINT HDU

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

FITSArchive.h
add_Pointing_columns.C
clean_Pointing_columns.C
delete_hdu.C
extra_Pointing_columns.C
FITSArchive.C
load_CalibrationInterpolatorExtension.C
load_CalibratorStokes.C
load_CalInfoExtension.C
load_CoherentDedispersion.C
load_CrossCovarianceMatrix.C
load_DigitiserCounts.C
load_DigitiserStatistics.C
load_FITSSUBHdrExtension.C
load_FluxCalibratorExtension.C
load_Integration.C
load_integration_state.C
load_ITRFExtension.C
load_ObsDescription.C
load_Parameters.C
load_Passband.C
load_Plasma.C
load_Pointing.C
load_Pointing_columns.C
load_PolnCalibratorExtension.C
load_Predictor.C
load_ProcHistory.C
load_Receiver.C
load_SpectralKurtosis.C
load_WidebandCorrelator.C
P236_reference_epoch_correction.C
refmjd_rounding_correction.C
setup_io.C
unload_CalibrationInterpolatorExtension.C
unload_CalibratorStokes.C
unload_CalInfoExtension.C
unload_CoherentDedispersion.C
unload_CrossCovarianceMatrix.C
unload_DigitiserCounts.C
unload_DigitiserStatistics.C
unload_FITSHdrExtension.C
unload_FITSSUBHdrExtension.C
unload_FluxCalibratorExtension.C
unload_Integration.C
unload_integrations.C
unload_ITRFExtension.C
unload_ObsDescription.C
unload_ObsExtension.C
unload_Parameters.C
unload_Passband.C
unload_Plasma.C
unload_Pointing.C
unload_PolnCalibratorExtension.C
unload_Predictor.C
unload_ProcHistory.C
unload_Receiver.C
unload_SpectralKurtosis.C
unload_WidebandCorrelator.C
update_history.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ copy()

◆ delete_hdu()

◆ load_DigitiserCounts()

◆ load_header()

◆ load_Integration()

◆ load_Plasma()

◆ load_Pointing()

◆ load_SpectralKurtosis()

◆ load_state()

◆ unload() [1/3]

◆ unload() [2/3]

◆ unload() [3/3]