dsp::CyclicFold Class Reference

Fold TimeSeries data into cyclic spectra. More...

#include <CyclicFold.h>

Inheritance diagram for dsp::CyclicFold:

Public Member Functions
	CyclicFold ()
	Constructor.
	~CyclicFold ()
	Destructor.
virtual void	prepare ()
	Prepare for folding.
void	set_engine (Engine *)
void	set_nlag (unsigned _nlag)
	Set the number of lags to fold.
unsigned	get_nlag () const
	Get the number of lags to fold.
void	set_mover (unsigned _mover)
	Set the amount of oversampling to improve channel isolation.
unsigned	get_mover () const
	Get the amount of oversampling.
void	set_nchan (unsigned nchan)
	Set number of channels to make.
void	set_npol (unsigned _npol)
	Set the number of polarizations to compute.
unsigned	get_npol () const
	Get the number of lags to fold.
Public Member Functions inherited from dsp::Fold
	Fold ()
	Constructor.
	~Fold ()
	Destructor.
virtual Fold *	clone () const
	Create a clonse.
PhaseSeries *	get_output () const
void	prepare (const Observation *observation)
	Prepare to fold the given Observation. More...
void	combine (const Operation *)
	If Operation is a Fold, integrate its PhaseSeries. More...
void	reset ()
	Reset the PhaseSeries.
virtual void	finish ()
	Perform any final operations.
uint64_t	bytes_storage () const override
	The number of bytes of additional storage used by the operation.
PhaseSeries *	get_result () const
	Before returning output, ensure that it is synchronized with Engine.
void	set_nbin (unsigned _nbin)
	Set the number of phase bins into which data will be folded.
unsigned	get_nbin () const
	Get the number of phase bins into which data will be folded.
void	set_force_sensible_nbin (bool _force_sensible)
bool	get_force_sensible_nbin ()
void	set_ncoef (unsigned ncoef)
	Set the number of polynomial coefficients in model.
unsigned	get_ncoef () const
	Get the number of polynomial coefficients in model.
void	set_nspan (unsigned nspan)
	Set the number of minutes over which polynomial coefficients are valid.
unsigned	get_nspan () const
	Get the number of minutes over which polynomial coefficients are valid.
void	set_change (const ObservationChange *)
	Set the attributes to be changed in the output PhaseSeries. More...
void	set_folding_period (double folding_period)
	Set the period at which to fold data for all sources. More...
void	set_reference_epoch (const MJD &)
	Set the reference epoch that defines phase = 0 when folding_period > 0.
double	get_folding_period () const
	Get the period at which data are being folded (in seconds) More...
bool	has_folding_period () const
	Returns true if data will be folded at a constant period.
const Pulsar::Predictor *	get_folding_predictor () const
	Get the phase model which is currently being used to fold data.
bool	has_folding_predictor () const
	Returns true if data will be folded using Pulsar::Predictor.
const Pulsar::Parameters *	get_pulsar_ephemeris () const
	Get the ephemeris used to create the phase model.
void	set_folding_predictor (const Pulsar::Predictor *)
	Set the phase model with which to fold data. More...
bool	has_pulsar_ephemeris () const
	use to see whether pulsar eph is stored
void	set_pulsar_ephemeris (const Pulsar::Parameters *)
	Set the ephemeris with which to create a new phase model.
virtual void	set_reference_phase (double phase)
	Set the reference phase (phase of bin zero)
double	get_reference_phase () const
	Get the reference phase (phase of bin zero)
void	set_input (const TimeSeries *input)
	Overload Transformation::set_input to set weighted_input.
unsigned	choose_nbin (bool quiet=false) const
	Return an appropriate number of pulse phase bins. More...
virtual void	set_cerr (std::ostream &os) const
	Set output cerr stream.
virtual Engine *	get_engine ()
Public Member Functions inherited from dsp::Transformation< TimeSeries, PhaseSeries >
	Transformation (const char *_name, Behaviour _type)
	All sub-classes must specify name and capacity for inplace operation.
virtual	~Transformation ()
	Destructor.
void	reserve ()
	Set the size of the output to that of the input by default.
void	set_input (const TimeSeries *input)
	Set the container from which input data will be read.
void	set_output (PhaseSeries *output)
	Set the container into which output data will be written.
Behaviour	get_type () const
	Return the Transformation type.
virtual void	set_buffering_policy (BufferingPolicy *policy)
	Set the policy for buffering input and/or output data.
bool	has_buffering_policy () const
	Returns true if buffering_policy is set.
BufferingPolicy *	get_buffering_policy () const
void	reset_min_samps ()
	Reset minimum_samps_can_process.
std::string	name (const std::string &function) const
	String preceding output in verbose mode.
Public Member Functions inherited from dsp::Operation
	Operation (const char *name)
	All sub-classes must specify a unique name. More...
	Operation (const Operation &)
	Copy constructor.
virtual	~Operation ()
	Virtual destructor.
virtual bool	operate ()
	Call this method to operate on data Returns false on failure. More...
virtual void	add_extensions (Extensions *)
	Add any extensions.
virtual void	report () const
	Report operation statistics.
std::string	get_name () const
	Return the unique name of this operation.
double	get_total_time () const
	Return the total time spent on this Operation in seconds.
double	get_elapsed_time () const
	Get the time spent in the last invocation of operate()
virtual uint64_t	get_total_weights () const
	Return the total number of timesample weights encountered. More...
virtual uint64_t	get_discarded_weights () const
	Return the number of invalid timesample weights encountered.
int	get_id ()
	Inquire the unique instantiation id.
virtual Function	get_function () const
	Get the function classification of this operation.
virtual double	get_delay_time () const
	Get the time delay of this operation, if any, in seconds.
virtual void	set_scratch (Scratch *)
	Set the scratch space.
bool	scratch_was_set () const
virtual uint64_t	bytes_scratch () const
	The number of bytes of scratch space used by the operation. More...
Public Member Functions inherited from OwnStream
	OwnStream (const OwnStream &)
const OwnStream &	operator= (const OwnStream &)
virtual void	set_cout (std::ostream &) const
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
Public Member Functions inherited from dsp::HasInput< TimeSeries >
virtual	~HasInput ()
	Destructor.
const TimeSeries *	get_input () const
	Return pointer to the container from which input data will be read.
bool	has_input () const
	Returns true if input is set.
Public Member Functions inherited from dsp::HasOutput< PhaseSeries >
virtual	~HasOutput ()
	Destructor.
virtual PhaseSeries *	get_output () const
	Return pointer to the container into which output data will be written.
bool	has_output () const
	Returns true if output is set.

Protected Member Functions
virtual void	check_input ()
	Check that the input state is appropriate.
virtual void	prepare_output ()
	Prepare the output PhaseSeries.
virtual void	setup_engine ()
	Transfer current settings to engine.
Protected Member Functions inherited from dsp::Fold
virtual void	transformation ()
	The transformation folds the data into the profile.
virtual void	fold (uint64_t nweights, const unsigned *weights, unsigned ndatperweight, unsigned weight_idat)
	Fold nblock blocks of data. More...
virtual void	set_limits (const Observation *input)
	Set the idat_start and ndat_fold attributes. More...
void	set_idat_start (uint64_t _idat_start)
	Used by the MultiFold class.
uint64_t	get_idat_start ()
	Used by the MultiFold class.
void	set_ndat_fold (uint64_t _ndat_fold)
	Used by the MultiFold class.
uint64_t	get_ndat_fold ()
	Used by the MultiFold class.
double	get_pfold (const MJD &start_time)
	Called by fold to return pfold.
double	get_phi (const MJD &start_time)
	Called by new_fold() to return phi.
void	initialise ()
	Makes sure parameters are initialised. More...
Protected Member Functions inherited from dsp::Transformation< TimeSeries, PhaseSeries >
virtual bool	can_operate ()
	Return false if the input doesn't have enough data to proceed.
virtual void	operation ()
	Define the Operation pure virtual method.
virtual void	vchecks ()
	Makes sure input & output are okay before calling transformation()
Protected Member Functions inherited from dsp::Operation
virtual void	set_name (const std::string &_name)
	Set the name!
int	timers_index (const std::string &op_name)
	Returns the index in the 'timers' array of a particular timer.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
unsigned	nlag
	Number of lags to compute when folding.
unsigned	mover
	Oversampling factor.
unsigned	npol
	Number of output polns to compute.
Protected Attributes inherited from dsp::Fold
double	folding_period
	Period at which to fold data.
Reference::To< const WeightedTimeSeries >	weighted_input
	Set when Tranformation::input is a Weighted TimeSeries.
unsigned	folding_nbin
	Number of phase bins into which the data will be integrated.
unsigned	requested_nbin
	Number of phase bins set using set_nbin.
bool	force_sensible_nbin
double	reference_phase
	Reference phase (phase of bin zero)
MJD	reference_epoch
	Reference epoch that defines phase = 0 when folding_period > 0.
unsigned	ncoef
	Number of polynomial coefficients in model.
unsigned	nspan
	Number of minutes over which polynomial coefficients are valid.
Reference::To< const ObservationChange >	change
	The attributes to be changed in the output PhaseSeries.
bool	built
	Flag that the predictor is built for the given ephemeris and input.
uint64_t	idat_start
	INTERNAL: the time sample at which to start folding.
uint64_t	ndat_fold
	INTERNAL: the number of time samples to fold.
Reference::To< Engine >	engine
	Interface to alternate processing engine (e.g. GPU)
Protected Attributes inherited from dsp::Transformation< TimeSeries, PhaseSeries >
Reference::To< BufferingPolicy >	buffering_policy
	The buffering policy in place (if any)
int64_t	minimum_samps_can_process
	If input doesn't have this many samples, operate() returns false.
Protected Attributes inherited from dsp::Operation
Scratch *	scratch
	Shared scratch space, if needed.
bool	set_scratch_called
std::string	name
	Operation name.
uint64_t	discarded_weights
	Number of time sample weights encountered that are flagged invalid.
uint64_t	total_weights
	Total number of time sample weights encountered.
RealTimer	optime
	Stop watch records the amount of time spent performing this operation.
int	id
	Unique instantiation id.
bool	prepared
	Set true when preparation optimizations are completed.
Protected Attributes inherited from dsp::HasInput< TimeSeries >
Reference::To< const TimeSeries >	input
	Container from which input data will be read.
Protected Attributes inherited from dsp::HasOutput< PhaseSeries >
Reference::To< PhaseSeries >	output
	Container into which output data will be written.

Additional Inherited Members
Public Types inherited from dsp::Operation
enum	Function { Producer, Procedural, Structural }
	The function of the operator. More...
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 ()
Public Attributes inherited from dsp::Transformation< TimeSeries, PhaseSeries >
Callback< Transformation * >	pre_transformation
	Functions called before the transformation takes place.
Callback< Transformation * >	post_transformation
	Functions called after the transformation takes place.
Static Public Attributes inherited from dsp::Fold
static unsigned	maximum_nbin = 1024
	The maximum number of phase bins returned by Fold::choose_nbin. More...
static double	minimum_bin_width = 1.2
	The minimum width of each pulse phase bin; used by Fold::choose_nbin. More...
static bool	power_of_two = true
	Controls the number of phase bins returned by Fold::choose_nbin. More...
Static Public Attributes inherited from dsp::Operation
static bool	record_time = false
	Global flag enables stopwatch to record the time spent operating. More...
static bool	report_time = true
	Global flag enables report of time spent in operation on descruction. More...
static bool	verbose = false
	Global verbosity flag.
static int	operation_status = 0
	Operations can set this to non-zero in operation() if they fail.
static bool	check_state = true
	Operations should perform internal consistency checks.
static int	instantiation_count = 0
	Counts how many Operation instantiations there have been Used for setting the unique instantiation ID. More...

Detailed Description

Fold TimeSeries data into cyclic spectra.

Folds input voltage data into periodic correlations to compute cyclic spectra, using the 'time domain' lag folding algorithm described by Demorest (2011). Output format is periodic spectra to fit into the usual pulse profile data structures.

This Operation does not modify the TimeSeries. Rather, it accumulates periodic correaltion data within its data structures, then Fourier transforms the lag dimension into spectra for the final output.

Since basically the entire algorithm for standard folding applies here, this class inherits Fold. The major differences are that voltage input is required, and the output contains a different number of channels than the input. The work is performed by CyclicFoldEngine.

---

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

• CyclicFold.h
• CyclicFold.C