dsp::Subint< Op > Class Template Reference

Unload PhaseSeries data into sub-integrations. More...

#include <Subint.h>

Inherits Op.

Public Member Functions
	Subint ()
	Constructor.
	~Subint ()
	Destructor.
Op *	clone () const
	Create a clonse.
void	finish ()
	Emit any unfinished profiles.

PhaseSeries events
The attached callback methods should be of the form: void method (const PhaseSeries& data);
Callback< PhaseSeries * >	complete
	Attach methods to receive completed PhaseSeries instances.
Callback< PhaseSeries * >	partial
	Attach methods to receive partially completed PhaseSeries instances.
void	set_start_time (const MJD &start_time)
	Set the start time from which to begin counting sub-integrations.
MJD	get_start_time () const
	Get the start time from which to begin counting sub-integrations.
void	set_subint_seconds (double subint_seconds)
	Set the number of seconds to fold into each sub-integration.
double	get_subint_seconds () const
	Get the number of seconds to fold into each sub-integration.
void	set_subint_reference_epoch (const MJD &epoch)
	Set the start time of the first sub-integration.
MJD	get_subint_reference_epoch () const
	Get the start time of the first sub-integration.
void	set_subint_turns (unsigned subint_turns)
	Set the number of turns to fold into each sub-integration.
unsigned	get_subint_turns () const
	Get the number of turns to fold into each sub-integration.
void	set_fractional_pulses (bool flag)
	Attach methods to receive completed PhaseSeries instances.
void	set_reference_phase (double phase)
	Attach methods to receive completed PhaseSeries instances.

deprecated methods
Use of these methods is deprecated in favour of attaching callback methods to the completed event.
Reference::To< PhaseSeriesUnloader >	unloader
	File unloading flag.
TimeDivide	divider
	The time divider.
bool	built
	Flag set when time divider is initialized.
void	set_unloader (PhaseSeriesUnloader *unloader)
	Set the file unloader.
PhaseSeriesUnloader *	get_unloader () const
	Get the file unloader.
virtual bool	keep (PhaseSeries *data)
	Decide wether or not to keep the folded profile.
const TimeDivide *	get_divider () const
	Access to the divider.
void	set_cerr (std::ostream &os) const
	Set verbosity ostream.
virtual void	unload_partial ()
	Unload any partially completed integrations.
virtual void	transformation ()
	Folds the TimeSeries data into one or more sub-integrations.
virtual void	set_limits (const Observation *input)
	Set the idat_start and ndat_fold attributes. More...
void	prepare ()
	Initialize the time divider.
void	zero_output ()
	Reset all outputs to null values.

Detailed Description

template<class Op>
class dsp::Subint< Op >

Unload PhaseSeries data into sub-integrations.

The Subint class is useful for producing multiple sub-integrations from a single observation. Given a Predictor and the number of pulses to integrate, this class can be used to produce single pulse profiles.

This class has been reimplemented from SubFold as a template to allow the subintegration division code to apply to any base class that produces PhaseSeries output.

Member Function Documentation

set_limits()

template<class Op >

void dsp::Subint< Op >::set_limits ( const Observation *  input )

protectedvirtual

Set the idat_start and ndat_fold attributes.

sets the Fold::idat_start and Fold::ndat_fold attributes

---

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

• Subint.h