Pulsar::SimplePolnProfile Class Reference

Simulates a simple Gaussian with a standard RVM and zero circular. More...

#include <SimplePolnProfile.h>

Inheritance diagram for Pulsar::SimplePolnProfile:

Public Member Functions
	SimplePolnProfile ()
	Default constructor.
	~SimplePolnProfile ()
	Destructor.
MEAL::RotatingVectorModel *	get_RVM ()
	Get the Rotating Vector Model used to simulate linear polarization.
MEAL::ScaledVonMises *	get_Intensity ()
	Get the Scaled Von Mises function used to simulate the total intensity.
void	set_centre (double)
	Centre the phase centre of the profile. More...
Public Member Functions inherited from Pulsar::SyntheticPolnProfile
	SyntheticPolnProfile ()
	Default constructor.
	~SyntheticPolnProfile ()
	Destructor.
void	set_total_intensity (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the total intensity.
void	set_degree (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the degree of polarization.
void	set_degree (float)
	Set the constant degree of polarization.
void	set_noise_variance (float)
	Set the variance of the noise.
void	set_position_angle (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the position angle.
void	set_position_angle (float)
	Set the constant position angle.
void	set_linear (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the linear polarization.
void	set_circular (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the circular polarization.
PolnProfile *	get_PolnProfile (unsigned nbin) const
	Get the polarimetric profile.
	SyntheticPolnProfile ()
	Default constructor.
	~SyntheticPolnProfile ()
	Destructor.
void	set_total_intensity (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the total intensity.
void	set_degree (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the degree of polarization.
void	set_degree (float)
	Set the constant degree of polarization.
void	set_noise_variance (float)
	Set the variance of the noise.
void	set_noise (float)
	Set the standard deviation of the noise.
void	set_swims_variance (float)
	Set the peak variance of the simulated SWIMS/jitter noise.
void	set_swims (float)
	Set the peak standard deviation of the simulated SWIMS/jitter noise.
void	set_baseline (float)
	The the off-pulse baseline mean.
void	set_position_angle (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the position angle.
void	set_position_angle (float)
	Set the constant position angle.
void	set_linear (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the linear polarization.
void	set_circular (MEAL::Univariate< MEAL::Scalar > *)
	Set the functional form of the circular polarization.
PolnProfile *	get_PolnProfile (unsigned nbin) const
	Get the polarimetric profile.
void	get_PolnProfile (PolnProfile *) const
	Get the polarimetric profile.
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 Attributes
MEAL::ScaledVonMises	svm
	The gaussian total intensity profile.
MEAL::RotatingVectorModel	rvm
	The rotating vector model used to describe the position angle.
Protected Attributes inherited from Pulsar::SyntheticPolnProfile
Reference::To< MEAL::Univariate< MEAL::Scalar > >	total_intensity
	The functional form of the total intensity.
float	noise_variance
	The variance of the noise.
Reference::To< MEAL::Univariate< MEAL::Scalar > >	degree
	The functional form of the degree of polarization.
float	constant_degree
	The constant degree of polarization.
Reference::To< MEAL::Univariate< MEAL::Scalar > >	position_angle
	The functional form of the position angle.
float	constant_position_angle
	The constant position angle.
Reference::To< MEAL::Univariate< MEAL::Scalar > >	linear
	The functional form of the linear polarization.
Reference::To< MEAL::Univariate< MEAL::Scalar > >	circular
	The functional form of the circular polarization.
float	swims_variance
	The peak variance of the SWIMS noise.
float	baseline
	The off-pulse baseline mean intensity.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::SyntheticPolnProfile
static void	set_Profile (Profile *profile, MEAL::Univariate< MEAL::Scalar > *function)
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 Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Simulates a simple Gaussian with a standard RVM and zero circular.

Member Function Documentation

set_centre()

void Pulsar::SimplePolnProfile::set_centre

(

double

centre

)

Centre the phase centre of the profile.

Set the phase of the standard profile centre.

---

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

• SimplePolnProfile.h
• SimplePolnProfile.C