PsrfitsFile

your.formats.psrfits.PsrfitsFile(psrfitslist)

Simple functions for reading psrfits files from python. Not all possible features are implemented.

Original Source from Scott Ransom's psrfits.

Args:

psrfitslist (str): list of files

Attributes:

filename (str): Name of the first file

filelist (list): List of files

fileid (int): Index of the current file

fits (obj): fits object of the current file read

specinfo (obj): Object of class SpectraInfo for the given file list

header (list): Header of the fits file

source_name (str): Source Name

machine_id (int) : Machine ID

barycentric (int): If 1 the data is barycentered

pulsarcentric (int): Is the data in pulsar's frame of reference?

src_raj (float): RA of the source (HHMMSS.SS)

src_deg (float): Dec of the source (DDMMSS.SS)

az_start (float): Telescope Azimuth (degrees)

za_start (float): Telescope Zenith Angle (degrees)

fch1 (float): Frequency of first channel (MHz))

foff (float): Channel bandwidth (MHz)

nchans (int): Number of channels

nbeams (int): Number of beams in the rcvr.

ibeam (int): Beam number

nbits (int): Number of bits the data are recorded in.

tstart (float): Start MJD of the data

tsamp (float): Sampling interval (seconds)

nifs (int): Number of IFs in the data.

read_subint

PsrfitsFile.read_subint(isub, apply_weights=True, apply_scales=True, apply_offsets=True, pol=0)

Read a PSRFITS subint from a open pyfits file object. Applys scales, weights, and offsets to the data.

Args:

isub: index of subint (first subint is 0)

apply_weights: If True, apply weights. (Default: apply weights)

apply_scales: If True, apply scales. (Default: apply scales)

apply_offsets: If True, apply offsets. (Default: apply offsets)

Returns:

Subint data with scales, weights, and offsets applied in float32 dtype with shape (nsamps,nchan).

get_data

PsrfitsFile.get_data(nstart, nsamp, pol=0)

Return 2D array of data from PSRFITS files.

Args:

nstart: Starting sample

nsamp: number of samples to read

Returns:

data: Time-Frequency numpy array

SpectraInfo

your.formats.psrfits.SpectraInfo(filenames)

Class to read the header of fits files

Args:

filenames: list of fits files

unpack_2bit

your.formats.psrfits.unpack_2bit(data)

Unpack 2-bit data that has been read in as bytes.

Args:

data: array of unsigned 2-bit ints packed into an array of bytes.

Returns:

unpacked array. The size of this array will be four times the size of the input data.

unpack_2bit

your.formats.psrfits.unpack_2bit(data)

Unpack 2-bit data that has been read in as bytes.

Args:

data: array of unsigned 2-bit ints packed into an array of bytes.

Returns:

unpacked array. The size of this array will be four times the size of the input data.

unpack_4bit

your.formats.psrfits.unpack_4bit(data)

Unpack 4-bit data that has been read in as bytes.

Args:

data: array of unsigned 4-bit ints packed into an array of bytes.

Returns:

unpacked array. The size of this array will be twice the size of the input data.