#include <LoadToFold1.h>

Inheritance diagram for dsp::LoadToFold:

Classes
class	Config
	Load, unpack, process and fold data into phase-averaged profile(s) More...

Public Member Functions
void	set_configuration (Config *)
	Set the configuration to be used in prepare and run.

	LoadToFold (Config *config=0)
	Constructor.

	~LoadToFold ()
	Destructor.

void	construct ()
	Create the pipeline.

void	prepare ()
	Finish preparing.

void	run ()
	Run through the data.

void	finish ()
	Finish everything. More...

void	share (SingleThread *)
	Share any necessary resources with the specified thread.

void	end_of_data ()
	Wrap up tasks at end of data.

bool	output_subints () const
	Return true if the output will be divided into sub-integrations.

TimeSeries *	construct_inverse_filterbank (TimeSeries *, bool run_on_gpu=false)
	Construct an inverse filterbank.

TimeSeries *	construct_filterbank (TimeSeries *, bool run_on_gpu=false)
	Construct a filterbank.

TimeSeries *	construct_convolution (TimeSeries *, bool run_on_gpu=false)
	Construct a convolution operation.

TimeSeries *	construct_interchan (TimeSeries *, bool run_on_gpu=false)
	Construct interchannel dispersive delay correction operation.

TimeSeries *	construct_spectral_kurtosis (TimeSeries *data, bool run_on_gpu=false)
	Construct generalized spectral kurtosis estimator.

void	construct_phased_filterbank (TimeSeries *input)
	Construct phase-locked filterbank.

void	build_fold (TimeSeries *)
	Build to fold the given TimeSeries.

void	build_fold (Reference::To< Fold > &, PhaseSeriesUnloader *)

void	configure_fold (unsigned ifold, TimeSeries *to_fold)

void	configure_detection (Detection *, unsigned)

PhaseSeriesUnloader *	get_unloader (unsigned ifold)

void	prepare_fold ()
	Prepare all fold instances.

void	prepare_archiver (Archiver *)
	Prepare the given Archiver.

MJD	parse_epoch (const std::string &)
	Parse the epoch string into a reference epoch.

Public Member Functions inherited from dsp::SingleThread
	SingleThread ()
	Constructor.

	~SingleThread ()
	Destructor.

void	set_configuration (Config *)
	Set the configuration.

void	set_source (Source *)
	Set the Source from which data are obtained. More...

Source *	get_source ()
	Get the Source from which data are obtained.

void	initialize ()
	Initialize resources required by signal procesing pipline.

void	seek_epoch (const MJD &)
	Seek such that output starts at the specified epoch.

virtual void	combine (const SingleThread *)
	Combine the results from another processing thread.

uint64_t	get_minimum_samples () const
	Get the minimum number of samples required to process.

void	take_ostream (std::ostream *newlog)
	Take and manage a new ostream instance.

void	set_affinity (int core)

const std::vector< Reference::To< Operation > >	get_operations ()
	get the operations being performed

uint64_t	set_block_size (uint64_t minimum_samples, uint64_t input_overlap=0)
	Set the number of time samples per block, based on RAM constraints.

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 Attributes
Reference::To< PlasmaResponse >	kernel
	The dedispersion and/or derotation kernel.

Reference::To< Dedispersion >	dedisp
	The dedispersion kernel.

Reference::To< Derotation >	derotate
	The derotation kernel.

std::vector< Reference::To< Fold > >	fold
	A folding algorithm for each pulsar to be folded.

Reference::To< FoldManager >	fold_manager
	Manages the execution of multiple Fold algorithms.

std::vector< Reference::To< OperationThread > >	asynch_fold
	Wrap each folder in a separate thread of execution.

std::vector< Reference::To< PhaseSeriesUnloader > >	unloader
	An unloader for each pulsar to be folded.

std::vector< Reference::To< SignalPath > >	path
	An unique signal path for each pulsar to be folded.

bool	manage_archiver
	Manage the archivers.

Reference::To< RFIFilter >	rfi_filter
	The RFI filter.

Reference::To< Config >	config
	Configuration parameters.

Reference::To< Response >	passband
	Integrates the passband.

Reference::To< Response >	frequency_response
	The frequency response applied during convolution.

Reference::To< Apodization >	temporal_apodization
	Optional window applied in time domain before forward FFT.

Reference::To< Apodization >	spectral_apodization
	Optional window applied in frequency domain before backward FFT.

Reference::To< SpectralKurtosis >	skestimator
	Optional SK filterbank. More...

Reference::To< TimeSeries >	zero_DM_time_series
	Optional zero DM TimeSeries for Spectral Kurtosis.

Reference::To< Resize >	skresize
	Optional SK Resizer.

Reference::To< Filterbank >	filterbank
	Creates the filterbank.

Reference::To< Filterbank::Engine >	filterbank_engine
	Optional filterbank engine.

Reference::To< InverseFilterbank >	inverse_filterbank
	reference to inverse filterbank

Reference::To< InverseFilterbank::Engine >	inverse_filterbank_engine
	Optional inverse filterbank engine.

Reference::To< Convolution >	convolution
	Performs coherent dedispersion.

Reference::To< ResponseProduct >	response_product
	The product of the RFIFilter and Dedispersion kernel.

Reference::To< SampleDelay >	sample_delay
	Removes inter-channel dispersion delays.

Reference::To< PhaseLockedFilterbank >	phased_filterbank
	Creates a filterbank in phase with the pulsar signal. More...

Reference::To< Detection >	detect
	Detects the phase-coherent signal.

bool	fold_prepared

Public Attributes inherited from dsp::SingleThread
std::ostream	cerr
	The verbose output stream shared by all operations.

unsigned	thread_id

Friends
class	LoadToFoldN

Additional Inherited Members
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 Types inherited from dsp::SingleThread
enum	State { Fail, Idle, Construct, Constructed, Prepare, Prepared, Run, Done, Joined }
	Processing thread states. More...

Protected Member Functions inherited from dsp::SingleThread
virtual void	prepare (Source *)
	Configure the source, if possible.

void	configure_overlap (Source , Memory )
	Configure overlap memory, if possible.

TimeSeries *	new_time_series ()
	Create a new TimeSeries instance.

TimeSeries *	new_TimeSeries ()

void	insert_dump_point (const std::string &transformation_name)
	Insert a dump point before the named operation.

void	insert_mask (const std::string &transformation_name)
	Insert a mask before the named operation.

const std::string &	app ()
	The name of the application running this thread.

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

void	__dereference (bool auto_delete=true) const

Protected Attributes inherited from dsp::SingleThread
std::ostream *	log
	Pointer to the ostream.

State	state
	Processing state.

Error	error
	Error status.

ThreadContext *	state_change
	State change communication.

ThreadContext *	source_context
	Mutex protecting source.

SingleThread *	colleague
	Processing thread with whom sharing will occur.

Reference::To< Source >	source
	Manages loading and unpacking.

Reference::To< TimeSeries >	source_output
	The TimeSeries into which the Source outputs data.

Reference::To< Config >	config
	Configuration information.

std::vector< Reference::To< Operation > >	operations
	The operations to be performed.

Reference::To< Scratch >	scratch
	The scratch space shared by all operations.

uint64_t	minimum_samples
	The minimum number of samples required to process.

Reference::To< Memory >	device_memory

void *	gpu_stream

int	gpu_device

Detailed Description

A single LoadToFold thread.

Member Function Documentation

◆ finish()

void dsp::LoadToFold::finish ( )

virtual

Finish everything.

Run through the data.

Reimplemented from dsp::SingleThread.

References dsp::Archiver::unload().

Member Data Documentation

◆ phased_filterbank

Reference::To<PhaseLockedFilterbank> dsp::LoadToFold::phased_filterbank

Creates a filterbank in phase with the pulsar signal.

Useful when trying to squeeze frequency resolution out of a short period pulsar for the purposes of scintillation measurments

◆ skestimator

Reference::To<SpectralKurtosis> dsp::LoadToFold::skestimator

Optional SK filterbank.

Optional Spectral Kurtosis (for convolution)

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

LoadToFold1.h
LoadToFold1.C

Classes

Public Member Functions

Public Attributes