dsp::LoadToFITS Class Reference

A single LoadToFITS thread. More...

#include <LoadToFITS.h>

Inheritance diagram for dsp::LoadToFITS:

Classes
class	Config
	Load, unpack, filterbank, re-digitize, and write to FITS. More...

Public Member Functions
void	set_configuration (Config *)
	Set the configuration to be used in prepare and run. More...
	LoadToFITS (Config *config=0)
	Constructor.
void	construct ()
	Create the pipeline.
void	prepare ()
	Final preparations before running.
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	construct ()
	Build the signal processing pipeline.
void	prepare ()
	Prepare the signal processing pipeline.
void	seek_epoch (const MJD &)
	Seek such that output starts at the specified epoch.
void	run ()
	Run through the data.
virtual void	share (SingleThread *)
	Share any necessary resources with the specified thread.
virtual void	combine (const SingleThread *)
	Combine the results from another processing thread.
void	finish ()
	Finish everything. More...
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< Config >	config
	Configuration parameters.
Reference::To< Filterbank >	filterbank
	The filterbank in use.
Reference::To< Dedispersion >	kernel
	The dedispersion kernel.
Reference::To< Convolution >	convolution
	The convolution operation.
Reference::To< OutputFile >	outputFile
	The output file.
Public Attributes inherited from dsp::SingleThread
std::ostream	cerr
	The verbose output stream shared by all operations.
unsigned	thread_id

Static Public Attributes
static bool	verbose = false
	Verbose output.

Friends
class	LoadToFITSN

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	end_of_data ()
	Any special operations that must be performed at the end of data.
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 LoadToFITS thread.

Member Function Documentation

set_configuration()

void dsp::LoadToFITS::set_configuration

(

Config *

configuration

)

Set the configuration to be used in prepare and run.

Run through the data.

---

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

• LoadToFITS.h
• LoadToFITS.C