write_rmf

Synopsis

Write an RMFCrateDataset to a file.

write_rmg(rmfdataset, filename [, clobber=False])

Description

• rmfdataset - a RMF Crate Dataset
• filename - name of the file
• clobber - should an output file be over-written if it already exists (default is False)?

The write_rmf command creates an output file for the input RMF CrateDataset.

Metadata handling

As discussed in ahelp read_file, the Crate and Crate Dataset objects do not retain all the information from the input file, which means that care should be taken when using the output from write_pha() with CIAO tools.

Example

>>> rmf = read_rmf("in.rmf")
>>> write_rmf(rmf, "out.rmf")

Changes in CIAO 4.4

RMF Dataset

The value returned by read_rmf and used by write_rmf is a RMF Crate Dataset; in earleir versions it was a Crate.

Error handling

The write_rmf routine now raises an error rather than returning an integer.

The clobber argument

A clobber parameter has been added - which defaults to False - to control whether existing files will be overwritten or not.

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.

See Also

contrib

make_image_crate, make_table_crate, scale_image_crate, smooth_image_crate, write_arrays, write_columns

crates

add_col, add_crate, add_key, add_piximg, cratedataset, delete_col, delete_key, delete_piximg, get_crate, is_rmf, read_file, read_pha, read_rmf, write_file, write_pha