write_pha

Context: crates

Synopsis

Write a PHACrateDataset to a file.

Syntax

write_pha(pha, filename, clobber=False)

Description

Argument	Description
pha	The PHACrateDataset object to write out.
filename	The output file name. To change the format from FITS add a kernel specifier as described in 'ahelp dmopt' and 'ahelp dmascii'.
clobber	Set to True if the output file already exists and you wish to over-write it, since the default behavior is to raise an IOError in this case.

The write_pha command creates an output file for the input PHACrateDataset.

Example

>>> pha = read_pha("pha.fits")
>>> cr = pha.get_crate("SPECTRUM")
>>> pi = get_colvals(cr, "PI")
>>> flag = (pi > 10) & (pi < 700)
>>> cd = CrateData()
>>> cd.name = "QUALITY"
>>> cd.values = 1 * flag
>>> add_col(cr, cd)
>>> write_pha(pha, "pha_qual.fits", clobber=True)

Here we add a QUALITY column to the SPECTRUM block; setting rows to 1 for those PI bins greater than 10 and less than 700, otherwise 0. The resulting file - including all the blocks in pha.fits - is written out to pha_qual.fits.

Bugs

See the bug pages on the CIAO website for an up-to-date listing of known bugs.

Refer to the CIAO bug pages for an up-to-date listing of known issues.