You are here: NI Home > Support > Product Reference > Manuals > Sound and Vibration Measurement Suite 6.0 Help

Draws a polar plot on a picture control and adds labels. The polar plot displays the magnitude and phase of a certain order on a picture control. You must manually select the polymorphic instance to use. Use the Manual Label instance if you want to label the polar plot manually.

Use the pull-down menu to select an instance of this VI.

Select an instance OAT Polar Plot (Auto Label)OAT Polar Plot (Manual Label)

OAT Polar Plot (Auto Label)

	cursor attributes specifies the settings used to draw the cursors. layout color specifies the color of the placed cursor. active color specifies the color of the active cursor. precision specifies the precision of the label number text. BG transparent specifies whether the background of the label text is transparent. The default is FALSE. radius defines the radius of the label points, in pixels. The default is 2.
	polar settings specifies how this VI draws the polar plot. polar attributes specifies the format for the grid and scale of the polar plot and indicates how the graph should handle negative magnitude data, whether to clip the data or to draw it. maximum specifies the maximum value for the scale. minimum specifies the minimum value for the scale. clip to min specifies whether to clip (TRUE) or draw (FALSE) negative magnitude data. log specifies whether the scale should be logarithmic. grid color specifies the color of the grid. The default in RGB is 102, 102, 102. You can wire a color box constant to this input. plot color specifies the color of the plot. The default in RGB is 0, 255, 0. You can wire a color box constant to this input. fmt and prec specifies the numeric format and precision for the scale numbers. format specifies the numeric format for the scale numbers. 0 Decimal (Default) 1 Scientific 2 Engineering 3 Binary 4 Octal 5 Hex precision specifies the precision for the scale numbers. The default is 1. visible section specifies which quadrant(s) of the polar plot you want to view. 0 Upper right quadrant 1 Lower right quadrant 2 Lower left quadrant 3 Upper left quadrant 4 Upper right and left quadrants 5 Lower right and left quadrants 6 Right upper and lower quadrants 7 Left upper and lower quadrants 8 All quadrants (Default) desired font specifies the text font. 0 User-specified Font 1 Application Font (Default) 2 System Font 3 Dialog Font [user-specified font] specifies the specific font characteristics for the text to draw. The VI ignores this input unless desired font is User-specified Font. Font Name specifies the font to use for the text. If you misspell the font name or specify a font that is not installed on the computer, the operating system selects a font. Size specifies the size of the font in points. Strikeout? specifies if the text appears in strikeout. If Strikeout? is TRUE, the text appears in strikeout. Italic? specifies if the text appears in italics. If Italic? is TRUE, the text appears in italics. Underline? specifies if the text is underlined. If Underline? is TRUE, the text appears underlined. Outline? specifies if the text is outlined. If Outline? is TRUE, the text appears outlined. Shadow? specifies if the text has a shadow. If Shadow? is TRUE, the text appears in shadow. Bold? specifies if the text is bold. If Bold? is TRUE, the text appears bold.
	picture dimensions specifies the size of the plot area of the picture. width specifies the horizontal coordinate that increases to the right. height specifies the vertical coordinate that increases to the bottom.
	picture specifies the collection of drawing instructions onto which the graph is added.
	magnitude specifies the order magnitude plot. time/rev/rpm specifies the x-axis value of the plot. magnitude specifies the y-axis value of the plot.
	phase specifies the order phase plot. time/rev/rpm specifies the x-axis value of the plot. phase specifies the y-axis value of the plot, in phase lag value.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Refer to Controlling Error Notification to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	channel settings specifies the direction in which the shaft rotates and probe angle settings of the x-axis and y-axis channels. shaft rotating direction specifies the direction in which the shaft rotates. 0 CCW—(Default) Counterclockwise. 1 CW—Clockwise. probe angles [deg] specifies the x-axis and y-axis probe angles, in degrees. Set the probe angle value in the range of 0 to 360. 0 degrees is the horizontal-right position. The probe angle increases in the counterclockwise direction. X specifies the probe angle of the x-axis. The default is 0 degrees. Y specifies the probe angle of the y-axis. The default is 90 degrees.
	view info specifies view information about the input magnitudes and phases [phase lag]. view info contains the same information as the view input in the OAT Order Magnitude and Phase VI.
	avoid overlap? specifies if labels are overlapped. If avoid overlap? is TRUE, this parameter prevents the labels from overlapping each other. The default is TRUE.
	new picture displays the polar plot.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

OAT Polar Plot (Manual Label)

	cursor attributes specifies the settings used to draw the cursors. layout color specifies the color of the placed cursor. active color specifies the color of the active cursor. precision specifies the precision of the label number text. BG transparent specifies whether the background of the label text is transparent. The default is FALSE. radius defines the radius of the label points, in pixels. The default is 2.
	polar settings specifies how this VI draws the polar plot. polar attributes specifies the format for the grid and scale of the polar plot and indicates how the graph should handle negative magnitude data, whether to clip the data or to draw it. maximum specifies the maximum value for the scale. minimum specifies the minimum value for the scale. clip to min specifies whether to clip (TRUE) or draw (FALSE) negative magnitude data. log specifies whether the scale should be logarithmic. grid color specifies the color of the grid. The default in RGB is 102, 102, 102. You can wire a color box constant to this input. plot color specifies the color of the plot. The default in RGB is 0, 255, 0. You can wire a color box constant to this input. fmt and prec specifies the numeric format and precision for the scale numbers. format specifies the numeric format for the scale numbers. 0 Decimal (Default) 1 Scientific 2 Engineering 3 Binary 4 Octal 5 Hex precision specifies the precision for the scale numbers. The default is 1. visible section specifies which quadrant(s) of the polar plot you want to view. 0 Upper right quadrant 1 Lower right quadrant 2 Lower left quadrant 3 Upper left quadrant 4 Upper right and left quadrants 5 Lower right and left quadrants 6 Right upper and lower quadrants 7 Left upper and lower quadrants 8 All quadrants (Default) desired font specifies the text font. 0 User-specified Font 1 Application Font (Default) 2 System Font 3 Dialog Font [user-specified font] specifies the specific font characteristics for the text to draw. The VI ignores this input unless desired font is User-specified Font. Font Name specifies the font to use for the text. If you misspell the font name or specify a font that is not installed on the computer, the operating system selects a font. Size specifies the size of the font in points. Strikeout? specifies if the text appears in strikeout. If Strikeout? is TRUE, the text appears in strikeout. Italic? specifies if the text appears in italics. If Italic? is TRUE, the text appears in italics. Underline? specifies if the text is underlined. If Underline? is TRUE, the text appears underlined. Outline? specifies if the text is outlined. If Outline? is TRUE, the text appears outlined. Shadow? specifies if the text has a shadow. If Shadow? is TRUE, the text appears in shadow. Bold? specifies if the text is bold. If Bold? is TRUE, the text appears bold.
	picture dimensions specifies the size of the plot area of the picture. width specifies the horizontal coordinate that increases to the right. height specifies the vertical coordinate that increases to the bottom.
	picture specifies the collection of drawing instructions onto which the graph is added.
	magnitude specifies the order magnitude plot. time/rev/rpm specifies the x-axis value of the plot. magnitude specifies the y-axis value of the plot.
	phase specifies the order phase plot. time/rev/rpm specifies the x-axis value of the plot. phase specifies the y-axis value of the plot, in phase lag value.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Refer to Controlling Error Notification to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	channel settings specifies the direction in which the shaft rotates and probe angle settings of the x-axis and y-axis channels. shaft rotating direction specifies the direction in which the shaft rotates. 0 CCW—(Default) Counterclockwise. 1 CW—Clockwise. probe angles [deg] specifies the x-axis and y-axis probe angles, in degrees. Set the probe angle value in the range of 0 to 360. 0 degrees is the horizontal-right position. The probe angle increases in the counterclockwise direction. X specifies the probe angle of the x-axis. The default is 0 degrees. Y specifies the probe angle of the y-axis. The default is 90 degrees.
	view info specifies view information about the input magnitudes and phases [phase lag]. view info contains the same information as the view input in the OAT Order Magnitude and Phase VI.
	new picture displays the polar plot.
	Cursor List [EU Position] Out returns information about each cursor. Name returns the name of an individual cursor. Location returns the coordinates of an individual cursor. X returns the x-coordinate of an individual cursor. Y returns the y-coordinate of an individual cursor.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.