image.adddegaxes - Function

Add degenerate axes of the specified type to the image

Synopsis
adddegaxes(outfile, direction, spectral, stokes, linear, tabular, overwrite)

Arguments

outfile	in	Output image file name
		Allowed:	String
		Default:	unset
direction	in	Add direction axes ?
		Allowed:	T or F
		Default:	F
spectral	in	Add spectral axis ?
		Allowed:	T or F
		Default:	F
stokes	in	Add Stokes axis ?
		Allowed:	Stokes
		Default:	''
linear	in	Add linear axis ?
		Allowed:	T or F
		Default:	F
tabular	in	Add tabular axis ?
		Allowed:	T or F
		Default:	F
overwrite	in	Overwrite (unprompted) pre-existing output file ?
		Allowed:	T or F
		Default:	F

Returns
Image tool or fail

Description

This function (short-hand name ada) adds degenerate axes (i.e. axes of length 1) of the specified type. Sometimes this can be useful although you will generally need to modify the coordinate system of the added axis to give it the coordinate you want (do this with the Coordsys tool).

You specify which type of axes you want to add. You can't add an axis type that already exists in the image. For the Stokes axis, the allowed value (a string such as I, Q, XX, RR) can be found in the Coordsys constructor.

If outfile is given, the image is written to the specified disk file. If outfile is unset, the Image tool is associated with a temporary image. This temporary image may be in memory or on disk, depending on its size. When you destroy the Image tool (with the done function) this temporary image is deleted.

Example

- im1 := imagemaketestimage() 
- im1.shape()
[113 76]
- im1.coordsys().axiscoordinatetypes()
Direction Direction 
-
- im2 := im1.adddegaxes(spectral=T)
- im2.shape()
[113 76 1] 
- im2.coordsys().axiscoordinatetypes()
Direction Direction Spectral
-
- im3 := im2.adddegaxes(stokes='Q')
- im3.shape()
[113 76 1 1]
- im3.coordsys().axiscoordinatetypes()
Direction Direction Spectral Stokes

In this example, all the images are virtual (temporary images).

Next: image.addnoise - Function Up: image - Tool Previous: imagemaketestimage - Constructor Contents Index

	Package	general
	Module	images
	Tool	image