xy_plots curve create
Allows you to add new curves to an existing plot template, or create a new template and curves at the same time.
Format:
xy_plots curve create | |
|---|---|
plot_name = | a new or existing plot |
curve_name = | a new curve |
vaxis_data = | an existing component |
vmeasure = | an existing measure |
y_expression_text = | string |
y_values = | real |
ddata = | an existing component |
dmeasure = | an existing measure |
dvalues = | real |
haxis_data = | an existing component |
hmeasure = | an existing measure |
x_expression_text = | string |
x_values = | real |
idata = | an existing component |
imeasure = | an existing measure |
iexpression_text = | string |
ivalues = | real |
x_units = | string |
y_units = | string |
d_units = | string |
i_units = | string |
run_name = | an existing analysis |
vertical_axis_name = | an existing axis |
auto_vertical_axis = | boolean |
auto_axis = | auto_axis |
calculate_axis_limits = | boolean |
horizontal_axis_name = | an existing axis |
legend_text = | string |
auto_color = | boolean |
color = | an existing color |
line_type = | line_style |
thickness = | real |
increment_symbol = | integer |
symbol_type = | plot_symbols |
frozen = | boolean |
create_page = | boolean |
display_page = | boolean |
page_name = | string |
allow_hotpoints = | hotpoint_motion |
Example:
xy_plots curve create.
Description:
Parameter | Value Type | Description |
|---|---|---|
plot_name | A New Or Existing Plot | A plot name is a string of characters that identifies a plot |
curve_name | A New Curve | A curve name is string of characters that identifies a curve |
vaxis_data | An Existing Component | Identifies the set of values that will be used for the vertical axis data when creating a curve on an xy plot. |
vmeasure | An Existing Measure | |
y_expression_text | String | |
y_values | Real | Specifies numeric values for the y curve data |
ddata | An Existing Component | Identifies the set of values to be used for the dependent (vertical) axis data |
dmeasure | An Existing Measure | Identifies the measures to be used for the data displayed in the dependent axis. |
dvalues | Real | Specifies numeric values for the dependent axis data |
haxis_data | An Existing Component | Identifies the set of values that will be used for the horizontal axis data when creating a curve on an xy plot |
hmeasure | An Existing Measure | |
x_expression_text | String | |
x_values, | Real | Specifies numeric values for the x curve data |
idata | An Existing Component | Identifies the set of values to be used for the independent (horizontal by default) axis data when creating a curve on an xy plot. |
imeasure | An Existing Measure | Identifies the measures to be used for the data displayed in the independent axis. |
iexpression_text | String | String defining the independent axis data |
ivalues | Real | Specifies numeric values for the independent curve data |
x_units | String | |
y_units | String | |
d_units | String | Specifies the units for the curve's dependent data values. |
i_units | String | Specifies the units for the curve's independent data values. |
run_name | An Existing Analysis | Indicates an existing analysis where the measure results are to be found. |
vertical_axis_name | An Existing Axis | Specifies the name of a vertical axis. |
auto_vertical_axis | Boolean | |
auto_axis | Auto_axis | Identifies one of the following: units , curve , none |
calculate_axis_limits | Boolean | Identifies either: yes - Recalculates axis limits to fit curve (if axes are automatically scaled). no - Does not recalculate axis limits. |
horizontal_axis_name | An Existing Axis | Specifies the name of the horizontal axis for the curve |
legend_text | String | The text string to use for the plot curve's legend. |
auto_color | Boolean | Specifies whether or not Adams View automatically selects a color for the curve (YES or NO). |
color | An Existing Color | Specifies the COLOR of a graphic object |
line_type | Line_style | This parameter allows the selection of the line type for a curve |
thickness | Real | This parameter allows the specification of the thickness of the curve. |
increment_symbol | Integer | If the curve has a symbol, indicates the interval at which they are displayed |
symbol_type | Plot_symbols | This parameter identifies the shape of the symbol used to mark data points on an xy_plot. |
frozen | Boolean | |
create_page | Boolean | Creates a new page for the plot. Set it to yes or no. |
display_page | Boolean | If a new page was created, displays the new page. Set it to yes or no. |
page_name | String | Specifies the name of the new page. |
allow_hotpoints | Hotpoint_motion | When you enable the ALLOW_HOTPOINTS attribute on a curve, you can then modify the curve using click and drag |
Extended Definition:
1. You plot data from a result set by creating a curve on a template. You must first create result sets by reading a Results or Request file or computing them using a NUMERIC_RESULTS operation.
You may specify the name of a new curve, or the name of a new or old plot template. If you enter a plot name, Adams View automatically generates the curve names.
If you have already created a plot template, you add curves to it by specifying the old plot name or a new curve name. If you wish to create a new template at the same time as the curves, enter a new plot name. Adams View will create a new template with the curves on it.
If you are creating a new template automatically and all of the plot data comes from the same result set, a title will automatically be created for the plot. This title comes from the title in the Results or Request file from which the result sets were read. Also if there is a comment associated with the result set, it will be used to generate a subtitle for the plot.
If you are using multiple horizontal or vertical axes, you may specify which axes the curve should be plotted against. If you do not specify the axes, the curve will be plotted against the template's primary axes.
At the time of creating a curve the following attributes may be specified: curve_name, line type, line thickness, symbol type, symbol visibility, the horizontal (x) and vertical (y) data components, and the horizontal and vertical axes to plot against. The vertical data component is required and the horizontal data component defaults to the TIME component appropriate for the vertical component. A curve's name must be unique to all curves on the same plot.
You may create more than one curve at once by supplying several vertical and horizontal data values.
2. Plot names are assigned when plots are created. After a plot has been created, it may be referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers may be used. The leading character must be a letter.
3. Curve names are assigned by the user when curves are created. After a curve has been created, it may be referenced by its name until it is deleted. A curve may not have the same name as another curve on the same plot. A curve is associated to a plot and may be referenced at any time with respect to the plot. For example, a curve named "c1" on plot "p1" may be referenced by the full specification of ".p1.c1".
This type of full name specification avoids the need to force a given plot to be the "current" or "default" to reference data (i.e. a curve) associated with it. This is very useful when copying a curve from one plot to another, etc.
A curve_name may be arbitrarily long and a combination of letters of the alphabet and numbers may be used. The leading character must be a letter.
4. This data comes from a result_set_component object. For example, if you want to use the x component of a request result_set in your model, then you might enter VAXIS_DATA=REQ1.x.
The result set compoent must have been created previously and the data may have come from a Adams output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the NUMERIC_RESULTS command. The name of the result set is defined either by the user or by the system when a Adams output file was read in. By default the names of result sets (taken from Adams output files when no model exists) will be assigned a name made up of the Adams View default prefix for the object and its Adams id number. For example, request 1508 read from a request file would be assigned the result set name of REQ1508.
FFT NOTE
Note: | When you are plotting a result set created by the NUMERIC_RESULTS CREATE FFT command, you have several options. Recall that when the FFT results were created you specified a result set component name, say, fft1.info. This actually caused creation of three result set components fft1.info, fft1.info_MAGNITUDE and fft1.FREQUENCY.When you are plotting this data, you can specify just the result set component that you named, VAXIS_DATA=fft1.info, without any corresponding HAXIS_DATA. Adams View will treat this as complex data and plot fft1.info_MAGNITUDE over fft1.FREQUENCY |
If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the VAXIS_DATA, then the HAXIS_DATA must also be specified.
5. Enter one or more real numbers separated by commas which represent the y values for the curve.
6. ddata comes from a result set component object. For example, if you want to use the x component of a request result set in your model, then you would enter VAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can have come from an interactive session, Adams outputfile (graphics (.gra), request (.req) or results (.res)), through reading in a file, or computed using the numeric_results command. The name of the result set is defined either by a user or by the system when a Adams output file was read in. By default, the names of result sets (taken from Adams output files when no model exists) will be assigned a name made up of the Adams View default prefix for the object and its Adams ID number.
7. Enter one or more real numbers separated by commas, which represent the y values for the curve.
8. haxis_data data comes from a result_set_component object. For example, if you want to use the
component of a request result_set in your model, then you might enter HAXIS_DATA=REQ1.x.
The result set compoent must have been created previously and the data may have come from a Adams output file (.GRA, .REQ or .RES), via a file read, or may have been computed using the NUMERIC_RESULTS command. The name of the result set is defined either by the user or by the system when a Adams output file was read in. By default the names of result sets (taken from Adams output files when no model exists) will be assigned a name made up of the Adams View default prefix for the object and its Adams id number. For example, request 1508 read from a request file would be assigned the result set name of REQ1508.
FFT NOTE
Notes: | When you are plotting a result set created by the NUMERIC_RESULTS CREATE FFT command, you have several options. Recall that when the FFT results were created you specified a result set component name, say, fft1.info. This actually caused creation of three result set components fft1.info, fft1.info_MAGNITUDE and fft1.FREQUENCY When you are plotting this data, you can specify just the result set component that you named, VAXIS_DATA=fft1.info, without any corresponding HAXIS_DATA. Adams View will treat this as complex data and plot fft1.info_MAGNITUDE over fft1.FREQUENCY.If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the VAXIS_DATA, then the HAXIS_DATA must also be specified |
If either of the xxx_MAGNITUDE or FREQUENCY components is selected as the VAXIS_DATA, then the HAXIS_DATA must also be specified.
9. Enter one or more real numbers separated by commas which represent the x values for the curve.
10. Data comes from a result set component object. For example, if you want to use the x component of a request result set in your model, you could enter HAXIS_DATA=REQ1.x.
The result set component must have been created previously and the data can come from an interface session, Adams output file 
(graphics (.gra), request (.req) or results (.res)), through reading in a file, or computed using the numeric_results command. The name of the result set is defined either by a user or by the system when a Adams output file was read in.
(graphics (.gra), request (.req) or results (.res)), through reading in a file, or computed using the numeric_results command. The name of the result set is defined either by a user or by the system when a Adams output file was read in.By default, the names of result sets (taken from Adams output files when no model exists) are assigned a name made up of the Adams View default prefix for the object and its Adams ID number. For example, request 1508 read from a request file would be assigned the result set name of REQ1508.
11. If you have any measures in the expression, you must include the run_name parameter to indicate the run which the measure results reference.
12. Enter one or more real numbers separated by commas, which represent the x values for the curve.
13. Identifies one of the following:
units - When a curve is added to the plot, look for a dependent axis that has curves with the same units. If none exists, create a new dependent axis for the curve.
curve - Create a new dependent axis for each curve.
none - Place curve on primary dependent axis of plot.
14. If you are adding several curves to the same plot, you may want to set calculate_axis_limits to no and then issue the xy_plots template calculate_axis_limits command.
15. Specifies the COLOR of a graphic object. A graphic object is an object that may be drawn on the screen by Adams View, these include curves, parts, markers, arcs, outlines, boxes, circles, cylinders, frustums, spring damper graphics, force graphics, and plot curves and symbols. When the COLOR of a part is specified, all graphic objects fixed to that part are drawn with the COLOR of the part. Adams View supports the following COLOR: black, white, red, green, blue, cyan, magenta, and yellow.
Note: | f you choose the COLOR of an entity to be drawn in the view background color (typically white or black... ) it may not show up. See help for hardcopy also. |
16. The line type describes how the line will look when displayed on a plot.
Adams View supports solid, dash, dotdash, and dot.
Line Type Appearance
-------------------------------------------------------------
solid _______________
dash _ _ _ _ _ _ _ _
dotdash _ . _ . _ . _
dot . . . . . . . .
17. This parameter acts as a multiplier, is a real number and must be greater than zero. The default for this parameter is 1. If you specify THICKNESS=2.5 the curve will two and one half times as wide as the default. Note that large values for this parameter may result in the entire plot being covered.
18. If the curve has a symbol, indicates the interval at which they are displayed. For example, increment_symbol=2 means that a symbol is displayed at every second point.
19. Adams View currently supports the characters "*", "x", "o", "@", "+", and "none". However, you would enter the following parameter values respectively: "star", "x", "o", "at", "plus", and "none" to get those characters as symbols. The resulting shape is machine dependent but should look similar to the character.
The "none" choice produces a curve with no data point symbols displayed. For COMPLEX_SCATTERING plots the option for no symbol (i.e. the "none" option) is not available since this is a plot with only data points and no curve.
20. You can make the hotpoints appear on the curve by clicking on it. Once you see the hotpoints, you can drag them by placing the mouse pointer on a hotpoint, holding down the left mouse button and moving the mouse.
When ALLOW_HOTPOINTS is disabled, clicking on the curve does not allow modification via click and drag.