Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

imageprofilefitter.getprofiles - Function

	Package	general
	Module	images
	Tool	imageprofilefitter

Get data, estimate and fit as vectors

Synopsis
getprofiles(outfile, ascii, format, dataonly, overwrite, ack)

Arguments

outfile	in	Output file
		Allowed:	String
		Default:	None
ascii	in	Save in ascii file or aips++ table ?
		Allowed:	Boolean
		Default:	F
format	in	Formatting string for ascii table
		Allowed:	String
		Default:	%e
dataonly	in	Only write out data, not estimates and/or fits
		Allowed:	Boolean
		Default:	F
overwrite	in	Overwrite output file if it exists ?
		Allowed:	Boolean
		Default:	T
ack	in	Acknowledge Table creation/writing to logger ?
		Allowed:	Boolean
		Default:	F

Returns
Record or T

Description

This function recovers vectors holding the abcissa, data, estimate, fit, residual (these three are optional) and mask for the interactive fit just done. The abcissa is saved in both absolute pixel and world coordinates. For the latter, it will be in the units (and doppler if relevant) as displayed on the plotter.

If you don't specify an output file name, these vectors are returned in a record to you with field names as above.

If you specify an output file name you can save the data as an aips++ Table (default) or an ascii file. For the latter you can specify the floating point format. For the latter the mask will be stored as 0 (bad) or 1 (good).

If you store as an AIPS++ table, the units are stored as column keywords. If you store as an ascii table, the units are written as the first line. If the abcissa units are consistent with velocity, then the doppler type is written out as well. So you will see on the first line, 'xunit yunit' or 'xunit doppler yunit'. The second line gives the column headers.

Example

- pf := imageprofilefitter(infile='ngc1313.cube', infile2='locate.image', axis=3)
-                                     # User does a fit
- r := pf.getprofiles();              # Recover into record
- field_names(r);
abcissa data estimate fit residual mask
-
- pf.getprofiles(outfile='junk.tbl')  # Save as aips++ table
- t := table('junk.tbl')              # Open
- t.browse();                         # Browse