Pulsar::ConfigurableProjectionExtension Class Reference

Stores ConfigurableProjection parameters in an Archive instance. More...

#include <ConfigurableProjectionExtension.h>

Inheritance diagram for Pulsar::ConfigurableProjectionExtension:

Classes
class	Transformation
	Intermediate storage of MEAL::Complex parameters. More...

Public Member Functions
	ConfigurableProjectionExtension ()
	Default constructor.
	ConfigurableProjectionExtension (const ConfigurableProjectionExtension &)
	Copy constructor.
const ConfigurableProjectionExtension &	operator= (const ConfigurableProjectionExtension &)
	Operator =.
	~ConfigurableProjectionExtension ()
	Destructor.
ConfigurableProjectionExtension *	clone () const
	Clone method.
TextInterface::Parser *	get_interface ()
	get the text ineterface
	ConfigurableProjectionExtension (const ConfigurableProjection *)
	Construct from a ConfigurableProjection instance.
std::string	get_short_name () const
	Return a short name.
void	set_configuration (const std::string &text)
	Set the string that configures this projection.
const std::string &	get_configuration () const
	Get the string that configures this projection.
void	set_nchan (unsigned nchan)
	Set the number of frequency channels.
unsigned	get_nchan () const
	Get the number of frequency channels.
void	remove_chan (unsigned first, unsigned last)
	Remove the inclusive range of channels.
void	set_weight (unsigned ichan, float weight)
	Set the weight of the specified channel.
float	get_weight (unsigned ichan) const
	Get the weight of the specified channel.
unsigned	get_nparam () const
	Get the number of parameters describing each transformation.
void	set_nparam (unsigned)
	Set the number of parameters describing each transformation.
bool	get_has_covariance () const
	Get if the covariances of the transformation parameters.
void	set_has_covariance (bool)
	Set if the covariances of the transformation parameters.
bool	get_valid (unsigned ichan) const
	Return true if the transformation for the specified channel is valid.
void	set_valid (unsigned ichan, bool valid)
Transformation *	get_transformation (unsigned c)
	Get the transformation for the specified frequency channel.
const Transformation *	get_transformation (unsigned c) const
	Get the transformation for the specified frequency channel.
void	frequency_append (Archive *to, const Archive *from)
	Append ConfigurableProjection Extension data from another Archive.
void	fscrunch (unsigned factor=0)
void	fscrunch_to_nchan (unsigned new_nchan)
Estimate< float >	get_Estimate (unsigned iparam, unsigned ichan) const
void	set_Estimate (unsigned iparam, unsigned ichan, const Estimate< float > &)
Public Member Functions inherited from Pulsar::HasChannels
	HasChannels (const char *name)
Public Member Functions inherited from Pulsar::Archive::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
std::string	get_extension_name () const
	Return the name of the Extension.
virtual bool	has_data () const
	Returns true if the Extension contains useful data.
virtual void	resize (unsigned nsubint, unsigned npol=0, unsigned nchan=0, unsigned nbin=0)
	Resize the Extension.
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

Protected Member Functions
void	construct ()
	Construct the response array according to the current attributes.
void	range_check (unsigned ichan, const char *method) const
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
std::string	configuration
	Configures this projection.
std::vector< Transformation >	response
	The instrumental response as a function of frequency.
unsigned	nparam
	The number of parameters that describe the transformation.
bool	has_covariance
	The covariances of the transformation parameters are available.
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::Archive::Extension
static Extension *	factory (const std::string &name)
	Derived type factory.
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 ()

Detailed Description

Stores ConfigurableProjection parameters in an Archive instance.

This Archive::Extension implements the storage of ConfigurableProjection data.

Member Function Documentation

clone()

ConfigurableProjectionExtension * Pulsar::ConfigurableProjectionExtension::clone ( ) const

inlinevirtual

Clone method.

Implements Pulsar::Archive::Extension.

References ConfigurableProjectionExtension().

frequency_append()

void ConfigurableProjectionExtension::frequency_append ( Archive * to, const Archive * from )

virtual

Append ConfigurableProjection Extension data from another Archive.

Reimplemented from Pulsar::Archive::Extension.

References ConfigurableProjectionExtension(), Pulsar::Archive::get(), has_covariance, Pulsar::in_frequency_order(), nparam, and response.

get_interface()

TextInterface::Parser * ConfigurableProjectionExtension::get_interface ( void )

virtual

get the text ineterface

Get the text interface.

Reimplemented from Pulsar::Archive::Extension.

get_nchan()

unsigned ConfigurableProjectionExtension::get_nchan ( void ) const

virtual

Get the number of frequency channels.

Implements Pulsar::HasChannels.

References response.

Referenced by Pulsar::ConfigurableProjection::ConfigurableProjection(), and Pulsar::FITSArchive::unload().

get_short_name()

std::string Pulsar::ConfigurableProjectionExtension::get_short_name ( ) const

inlinevirtual

Return a short name.

Reimplemented from Pulsar::Archive::Extension.

get_valid()

bool ConfigurableProjectionExtension::get_valid

(

unsigned

ichan

)

const

Return true if the transformation for the specified channel is valid.

Get the weight of the specified channel.

References response.

Referenced by get_weight(), and Pulsar::FITSArchive::unload().

get_weight()

float ConfigurableProjectionExtension::get_weight

(

unsigned

ichan

)

const

Get the weight of the specified channel.

Set the weight of the specified channel.

References get_valid().

remove_chan()

void ConfigurableProjectionExtension::remove_chan ( unsigned first, unsigned last )

virtual

Remove the inclusive range of channels.

Implements Pulsar::HasChannels.

References response.

set_nchan()

void ConfigurableProjectionExtension::set_nchan ( unsigned nchan )

virtual

Set the number of frequency channels.

Implements Pulsar::HasChannels.

References construct(), and response.

Referenced by ConfigurableProjectionExtension(), and operator=().

---

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

• ConfigurableProjectionExtension.h
• ConfigurableProjectionExtension.C
• ConfigurableProjectionExt.C