Retrospective Formatting - Revision history

Dean Whittaker at 09:49, 1 September 2008

2008-09-01T09:49:33Z

Dean Whittaker: /* Finding Points on a Plot */

2008-08-08T15:39:30Z

Finding Points on a Plot

Dean Whittaker: /* Changing the Scale to Log */

2008-03-31T08:29:02Z

Changing the Scale to Log

Dean Whittaker: /* Changing Plot Axes */

2008-03-31T08:28:45Z

Changing Plot Axes

Dean Whittaker: /* Advanced Controls */

2008-03-31T08:24:51Z

Advanced Controls

Dean Whittaker: /* Advanced Controls */

2008-03-31T08:24:37Z

Advanced Controls

Dean Whittaker: /* Figure Control Functions */

2008-03-31T08:13:12Z

Figure Control Functions

Dean Whittaker: /* Optional Properties */

2008-03-20T17:09:18Z

Optional Properties

Dean Whittaker: /* Optional Properties */

2008-03-20T17:05:58Z

Optional Properties

Dean Whittaker: /* Optional Properties */

2008-03-20T17:03:43Z

Optional Properties

@@ Line 124: / Line 124: @@
 * If on a [[Plot Commands#Two Dimensional Plots|surface]], the point chosen will be the (x,y,z/c) coordinate of the first face of the surface which intersects the selection ray (which is a "ray that goes into the screen). If no face intersects then NaN is returned.
 * If on an [[Plot Commands#Two Dimensional Plots|area]] plot, dxyz and dxyc give the same result - then the z value will be the intensity value of the pixel that was selected
-* If on a [[Plot Commands#Two Dimensional Plots|multiplot] then the returned values will be the x,y,z/c points that corresponds to the closest data point on the closest intersecting face to the selection ray.
+* If on a [[Plot Commands#Two Dimensional Plots|multiplot]] then the returned values will be the x,y,z/c points that corresponds to the closest data point on the closest intersecting face to the selection ray.

@@ Line 96: / Line 96: @@
 ==Finding Points on a Plot==
-Finding and labelling points on a plot is done using the dxyz command. This can also place text on the plot at the desired point. A set of crosshairs will appear on the currently selected figure. By clicking on a point the x, y and z coordinates are found and returned through the function, any text is placed at the point.
+Finding and labelling points on a plot is done using the dxy, dxyz and dxyc commands. These can also place text on the plot at the desired point. A set of crosshairs will appear on the currently selected figure. By clicking on a point the x, y and z coordinates are found and returned through the function, any text is placed at the point.
@@ Line 103: / Line 103: @@
 >> [x, y] = dxyz
 >> [x, y, z] = dxyz
->> [x, y, z] = dxyz('text')
+>> [x, y] = dxy('text')
 >> [x, y, z] = dxyz('property', value)
->> [x, y, z] = dxyz('text', 'propterty', value)</pre>
+>> [x, y, z] = dxyc('text', 'propterty', value)</pre>
 where 'property' and value relate to [[General Behaviour#Property-Value Paris|property-value pairs]] which are given below.
 * By default, points will be returned until the return key is pressed on the keyboard
 * If no output arguments are requested then the co-ordinates of the points are added as text at the point selected
 * If text is given it is added to the plot (before the co-ordinates if they are to be added)
-* If the plot is [[Plot Commands#One Dimensional Plots|one dimensional]] then the returned z value will always be 0
-* Function can be called without the z output
+===dxy===
-* If on a [[Plot Commands#Two Dimensional Plots|surface]], the point chosen will be the (x,y,z) coordinate of the first face of the surface which intersects the selection ray (which is a "ray that goes into the screen). If no face intersects then NaN is returned.
+Use this command for finding just the x and y coordinates of a point. This can be used on any plot type but is most useful on [[Plot Commands#One Dimensional Plots |one dimensional plots]] and [[Plot Commands#Two Dimensional Plots|area]] plots. It is the ONLY option for one dimensional plots.
 * If on an [[Plot Commands#Two Dimensional Plots|area]] plot then the z value will be the intensity value of the pixel that was selected
-* If on a [[Plot Commands#Two Dimensional Plots|multiplot] or [[Plot Commands#One Dimensional Plots|one dimensional]] plot then the returned values will be the x,y,z points that corresponds to the closest data point on the closest intersecting face to the selection ray.
+* Only an x and a y value are returned

@@ Line 40: / Line 40: @@
 * linz and linc are not applicable for [[Plot Commands#One Dimensional Plots|one dimensional]] plots and will simply do nothing
 * If the scale is already linear then nothing happens (i.e. no warning or error is given)
 Buttons or a menu can be added to the current figure using the commands
@@ Line 48: / Line 49: @@
 * A log / linear button or menu will be added to the current figure window.
 * When pressed the axes will become logarithmic.
 * Only available for the x and y axes.
 ===Changing the Aspect Ratio===

@@ Line 40: / Line 40: @@
 * linz and linc are not applicable for [[Plot Commands#One Dimensional Plots|one dimensional]] plots and will simply do nothing
 * If the scale is already linear then nothing happens (i.e. no warning or error is given)
@@ Line 63: / Line 72: @@
 <pre>>> aspect(axesHandle, 'auto')
 >> aspect('name', 'tag', 'auto')</pre>
 ==Adding a Legend==

@@ Line 226: / Line 226: @@
 OR names and tags can be used
-<pre>>> set_plot('name', 'tag', 'property', value)
+<pre>>> set_plot('name', 'tag', 'property', value)</pre>
 * Ident may be either figure, axes or plot handle

← Older revision		Revision as of 08:24, 31 March 2008
Line 218:		Line 218:

	==Advanced Controls==		==Advanced Controls==
		+
		+	The advanced controls are really intended for programming use. They perform the same functions as the basic Matlab controls set and get. However, the commands may be used with name tags and all three commands can be given either the figure, axes or plot handle related to the object in question. For instance
		+
		+	<pre>>> set_axes(ident, 'property', value)
		+	>> set_plot(ident, 'property', value)
		+	>> set_figure(ident, 'property', value)</pre>
		+
		+	OR names and tags can be used
		+	<pre>>> set_plot('name', 'tag', 'property', value)
		+
		+	* Ident may be either figure, axes or plot handle
		+	* set_axes with a figure handle will set the property 'property' to the value 'value' for all axes objects contained in the figure
		+	* set_ axes with an axes handle will set the property 'property' to the value 'value' in the axes object
		+	* set_axes with a plot handle will set the 'property' to the value 'value' for the parent axes of the plot
		+	* set_figure with a figure object will set the 'property' to the value 'value' for the figure
		+	* set_figure with axes or plot handle will set the 'property' to the value 'value' for the figure that contains that axes or plot
		+	* set_plot with a figure or axes handle will set the 'property' to the value 'value' for all plots contained within the figure or axes given.
		+	* set_plot with a plot handle will set 'property' to the value 'value' for the plot handle given
		+	* Giving a name and tag is equivilent to giving a figure handle

← Older revision		Revision as of 08:13, 31 March 2008
Line 181:		Line 181:

	==Figure Control Functions==		==Figure Control Functions==
		+
		+	The figure windows can be controlled using [[Name Tags and Default Properties \|name tags]] or the keep figure function. By default plots of the same type ([[Plot Commands#One Dimensional Plots\|one dimensional]], [[Plot Commands#Two Dimensional Plots\|surface, area, multiplot]] and [[Plot Commands#Three Dimensional Plots\|sliceomatic]] appear in the same window and replace each other. The easiest way to get a handle on how this works is to play around with some simple plots.
		+
		+	However, if you want to keep the current plot and prevent any new plot replacing it, then use the command
		+
		+
		+	<pre>>> kf</pre>
		+
		+	or
		+
		+	<pre>>> keep_figure</pre>
		+
		+
		+	The title bar of the plot will now contain "(HOLD)" and any new plots will go to a new window. However, if a plot is on hold and you would like to use the figure to plot into again, then it can be released (the reverse of kf)
		+
		+	<pre>>> rf</pre>
		+
		+	or
		+
		+	<pre>>> release_figure</pre>
		+
		+
		+	Using name tags is a little more complicated. Each figure has a name and tag (some [[Plot Commands#Name Tags\|default]] names and tags are used for various types of plot). Now windows are represented by their names and tags. For instance, a program that builds on top of libisis may have two plots that need to be permanently open and updated. By giving them two different names and/or tags, it is easy to keep track of which one will be updated. A script might be written such that
		+
		+
		+	<pre>for i = 1:20
		+	monitor = get_monitor_function(i)
		+	data = get_data_function(i)
		+	dl (monitor, 'name','monitor1')
		+	dm (data, 'name', 'data')
		+	pause
		+	end</pre>
		+
		+
		+	Here, a user will see two plots, one titled 'monitor1', and the other titled 'data'. When the user clicks, a new monitor will replace the 'monitor1' figure window and new data will replace the 'data' figure window. The functions get_monitor_function and get_data_function are written by the user to get the data in the form of [[IXTdataset_1d]] objects.

	==Advanced Controls==		==Advanced Controls==

@@ Line 168: / Line 168: @@
 [[image:dxyzpartc.png|300px|rotated view]]
 ==Figure Control Functions==
 ==Advanced Controls==

@@ Line 111: / Line 111: @@
 * If on an [[Plot Commands#Two Dimensional Plots|area]] plot then the z value will be the intensity value of the pixel that was selected
 * If on a [[Plot Commands#Two Dimensional Plots|multiplot] or [[Plot Commands#One Dimensional Plots|one dimensional]] plot then the returned values will be the x,y,z points that corresponds to the closest data point on the closest intersecting face to the selection ray.
 ===Optional Properties===
@@ Line 141: / Line 142: @@
 | False
 |}
@@ Line 150: / Line 152: @@
 The user will see
 [[image:dxyzparta.jpg|300px|user selects a point]]
@@ Line 158: / Line 161: @@
-[[image:dxyzpartb.jpg|300px|label is placed at the point]]
+[[image:dxyzpartb.png|300px|label is placed at the point]]
 <pre>user rotates the view</pre>
-[[image:dxyzpartc.jpg|300px|rotated view]]
 ==Figure Control Functions==
 ==Advanced Controls==

@@ Line 146: / Line 146: @@
-<pre>>> [x,y,z] = dxyz('label')<pre>
+<pre>>> [x,y,z] = dxyz('label')</pre>
@@ Line 164: / Line 164: @@
 [[image:dxyzpartc.jpg|300px|rotated view]]
 ==Figure Control Functions==
 ==Advanced Controls==