Detailed Description

A class to wrap the SWIG-wrapped lalpulsar.PulsarParameters structure.

This class lets you access the structure in a more Pythonic way, as well as providing a nice format for holding pulsar (.par) parameter files.

The class can be used to set numerical values (double precision, unsigned integers), strings, or vectors of floating point values, e.g.:

>>> from lalpulsar.PulsarParametersWrapper import PulsarParametersPy
>>> pppy = PulsarParametersPy() # an empty structure
>>> pppy['DECJ'] = 0.23         # set a numerical value
>>> pppy['BINARY'] = 'BT'       # set a string value
>>> pppy['F'] = [10.2, 1.4e-11] # set a vector of float values

Args: pp (PulsarParameters, str): a lalpulsar.PulsarParameters structure, or a string giving the path to a TEMPO-style (.par) pulsar parameter file. If nothing is given then an empty lalpulsar.PulsarParameters structure is created. The read() method can subsequently be used to read in a .par file, or parameters can be added.

Examples: An example of initialising the class with a previously created lalpulsar.PulsarParameters structure is:

>>> import lalpulsar
>>> from lalpulsar.PulsarParametersWrapper import PulsarParametersPy
>>> # read in a pulsar parameter file
>>> pp = lalpulsar.ReadTEMPOParFile('apulsar.par')
>>> # view as a PulsarParametersPy object
>>> pppy = PulsarParametersPy(pp)

The same thing could be achieved more directly using:

>>> pppy = PulsarParametersPy('apulsar.par')

or, equivalently with:

>>> pppy = PulsarParametersPy()
>>> pppy.read('apulsar.par')

Definition at line 254 of file PulsarParametersWrapper.py.

Inherits object.

Public Member Functions
def	__init__ (self, pp=None)

def	__len__ (self)

def	__str__ (self)

def	__getitem__ (self, key)
	Get value from pulsar parameters. More...

def	__setitem__ (self, key, value)
	Set the value of a key. More...

def	convert_to_units (self, name, value)
	Convert parameter values to equivalent dimensional versions. More...

def	convert_to_tempo_units (self, name, value, iserr=False)
	Convert from PulsarParameter units to TEMPO-par-file units. More...

def	parameter (self, name, withunits=False, tempounits=False)
	Return the parameter given by name. More...

def	keys (self)
	Return a list of the parameter names stored in the PulsarParameters structure. More...

def	values (self)
	Return the values of each parameter in the structure. More...

def	as_dict (self)
	Return the contents (not error at the moment) of the structure as a dictionary. More...

def	items (self)
	Return list of item tuples for each parameter in the structure. More...

def	read (self, filename)
	Read a TEMPO-style parameter file into a PulsarParameters structure. More...

def	get_error (self, name)
	Return the error value for a particular parameter. More...

def	get_fitflag (self, name)
	Return the "fit flag" (a 1 or 0 depending whether the parameter with fit for by TEMPO(2) in the `.par` file). More...

def	pp_to_str (self, precision=19)
	Convert the PulsarParameter structure to a string in the format of a TEMPO-style `.par` file. More...

def	pp_to_par (self, filename, precision=19)
	Output the PulsarParameter structure to a `.par` file. More...

def	PulsarParameters (self)
	Return the PulsarParameters structure. More...

def	__deepcopy__ (self, memo)
	Create a copy of the parameters. More...

Data Fields
	keynames

	length

Static Public Attributes
list	keynames = []

int	length = 0

Constructor & Destructor Documentation

◆ init()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.__init__	(	self,
		pp = `None`
	)

Definition at line 260 of file PulsarParametersWrapper.py.

Member Function Documentation

◆ len()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.__len__ ( self )

Definition at line 279 of file PulsarParametersWrapper.py.

◆ str()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.__str__ ( self )

Definition at line 284 of file PulsarParametersWrapper.py.

◆ getitem()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.__getitem__	(	self,
		key
	)

Get value from pulsar parameters.

Definition at line 290 of file PulsarParametersWrapper.py.

◆ setitem()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.__setitem__	(	self,
		key,
		value
	)

Set the value of a key.

Definition at line 382 of file PulsarParametersWrapper.py.

◆ convert_to_units()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.convert_to_units	(	self,
		name,
		value
	)

Convert parameter values to equivalent dimensional versions.

Args: name (str): the name of the parameter to convert value: the value to the parameter to convert

Returns: :class:astropy.unit.Unit: a unit class with dimensions for a float parameters, or a list containing unit classes for a list or :class:numpy.ndarray

Definition at line 419 of file PulsarParametersWrapper.py.

◆ convert_to_tempo_units()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.convert_to_tempo_units	(	self,
		name,
		value,
		iserr = `False`
	)

Convert from PulsarParameter units to TEMPO-par-file units.

Args: name (str): a parameter name value (float, list, :class:numpy.ndarray): the value of the parameter iserr (bool): state whether where converting the parameter's error value

Returns: :class:astropy.unit.Unit: a unit class with dimensions for a float parameters, or a list containing unit classes for a list or :class:numpy.ndarray

Definition at line 455 of file PulsarParametersWrapper.py.

◆ parameter()

def lalpulsar.PulsarParametersWrapper.PulsarParametersPy.parameter	(	self,
		name,
		withunits = `False`,
		tempounits = `False`
	)

Return the parameter given by name.

Args: name (str): the name of the parameter to return withunits (bool): if True return the parameter in a form with its appropriate units tempounits (bool): of True return the parameter converted into the units required in a TEMPO-style parameter file

Definition at line 567 of file PulsarParametersWrapper.py.