Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Colormap (Sound and Vibration Measurement Suite)

Sound and Vibration Measurement Suite 6.0 Help
December 2007

NI Part Number:
372416A-01

»View Product Info

Displays the results of transient analysis or order analysis on a customized intensity graph with a rainbow color scale. You can display these 3D results using colors to represent the third dimension. You also can add frequency or order lines to indicate locations of specific frequencies or order components on the colormap.

Properties

You can set Colormap properties in the Colormap Properties dialog box. You also can use the following Colormap graph properties with the Property Node.

PropertyDescription
Active CursorSpecifies the active cursor and properties of that cursor.
Cursor Legend VisibleDisplays the cursor legend.
Cursor Lines:Frequency Lines:FrequenciesSpecifies the frequency value for displaying the frequency lines.
Cursor Lines:Frequency Lines:Line Property:ColorSpecifies the color of the frequency lines.
Cursor Lines:Frequency Lines:Line Property:Line VisibleDisplays the frequency lines.
Cursor Lines:Frequency Lines:Line Property:StyleSpecifies the style of the frequency lines.
Cursor Lines:Frequency Lines:Line Property:WidthSpecifies the width, in pixels, of the pen the VI uses to draw the frequency line.
Cursor Lines:Frequency Lines:Show CurrentShows the frequency line from the position of the active cursor.
Cursor Lines:Frequency Lines:Text Property:BG ColorSpecifies the background color of the text for displaying the frequency lines.
Cursor Lines:Frequency Lines:Text Property:ColorSpecifies the color of the text for displaying the frequency lines.
Cursor Lines:Frequency Lines:Text Property:SizeSpecifies the font size of the text for displaying the frequency lines.
Cursor Lines:Frequency Lines:Text Property:Text VisibleDisplays the text for the frequency lines.
Cursor Lines:Order Lines:Line Property:ColorSpecifies the color of the order lines.
Cursor Lines:Order Lines:Line Property:Line VisibleDisplays the order lines.
Cursor Lines:Order Lines:Line Property:StyleSpecifies the style of the order lines.
Cursor Lines:Order Lines:Line Property:WidthSpecifies the width in pixels of the pen the VI uses to draw the order lines.
Cursor Lines:Order Lines:OrdersSpecifies the order value for displaying the order lines.
Cursor Lines:Order Lines:Show CurrentShows the order line from the position of the active cursor.
Cursor Lines:Order Lines:Text Property:BG ColorSpecifies the background color of the text for displaying the order lines.
Cursor Lines:Order Lines:Text Property:ColorSpecifies the color of the text for displaying the order lines.
Cursor Lines:Order Lines:Text Property:SizeSpecifies the font size of the text for displaying the order lines.
Cursor Lines:Order Lines:Text Property:Text VisibleDisplays the text of the order lines.
Cursor ListReturns an array of information about all cursors. Each array element is a cluster of Cursor properties.
Cursor:Allow DragSpecifies whether you can drag the cursor.
Cursor:Cursor ColorSpecifies the color of the cursor, including the point, arrow, and name of the cursor.
Cursor:Cursor IndexReturns the array index of the point to which the cursor is snapped. This property can have a value between 0 and n – 1, where n is the number of data points.
Cursor:Cursor ModeSpecifies the way in which the cursor snaps to the plots in the plot area. You can select one of the following options:
  • 0—Free.
  • 1—Single-plot.
  • 2—Multi-plot.
Cursor:Cursor NameDisplays the text in the plot area associated with the cursor.
Cursor:Cursor Name VisibleSpecifies whether the Cursor Name is visible.
Cursor:Cursor PlotSpecifies the plot with which the cursor is associated. If Cursor Plot is –1, the cursor snaps to all plots in the plot area. You can move the cursor to the nearest data point along any plot in the plot area.
Cursor:Cursor Point StyleSpecifies the symbol that LabVIEW draws, along with the Cursor Style, at the focal point of the cursor. You can choose a value from 016.
Cursor:Cursor PositionDisplays the position of the cursor as XY coordinates.
Cursor:Cursor StyleSpecifies the symbol that LabVIEW draws, along with the Cursor Point Style, at the focal point of the cursor. You can choose a value from 08.
Cursor:Plot AreaDisplays the plot area with which the cursor is associated. This property applies only to mixed signal graphs.
Cursor:Watch All PlotsSpecifies whether the cursor watches all plots in the plot area. If this property is FALSE, the cursor watches only the Watch Plots property specifies. The Watch All Plots property is valid only for cursors associated with multiple plots.
Cursor:Watch PlotsSpecifies an array that contains the indexes of the plots that the cursor is watching. This property is valid only when the Watch All Plots property is FALSE. The Watch Plots property also is valid only for cursors associated with multiple plots.
Cursor:X ScaleSpecifies the x-scale of the cursor. This property is valid only for free cursors. If the cursor is associated with a plot, that plot might overwrite this property.
Cursor:Y ScaleSpecifies the y-scale of the cursor. This property is valid only for free cursors. If the cursor is associated with a plot, that plot might overwrite this property.
Event:Cursor MoveReturns the strictly typed user event refnum that LabVIEW generates when you move a cursor either by clicking and dragging the cursor or by using the Cursor Movement tool. If you select and move multiple cursors, LabVIEW generates a Cursor Move event for each cursor. LabVIEW also generates this event when you enter a new value in the cursor legend.

This event is useful if you want to register when you interact with the colormap cursor.
Event:Scale Range ChangeReturns the strictly typed user event refnum that LabVIEW generates when you change the maximum or minimum values of the colormap scale. LabVIEW generates this event when you enter a new value in a scale marker. LabVIEW also generates this event when you pan or zoom the colormap.

This event is useful if you want to register graph changes and then adjust the functionality of the graph.
Ignore ArrayIndicates use of Color Table instead of z-scale color settings.
Palette:VisibleDisplays the graph palette.
Plot Area:ColorSpecifies color of the plotting area expressed in terms of (FG Color, BG Color) pair.
Scale Legend:VisibleDisplays the scale legend.
Selected CursorsDisplays the currently-selected cursor.
Smooth UpdateDraws graph with less flicker, but slightly slower. (Mac OS) LabVIEW ignores this property.
X Scale:Format StringSets the format strings of the x-scale.
X Scale:Name Label:TextSpecifies text as displayed in the front panel object. For example, if you set a string control to use Password Display, this property returns the password string, such as ****, not the Normal Display of the string.
X Scale:Name Label:VisibleIndicates if the decoration is visible.
X Scale:Offset and MultiplierDisplays a cluster of offset (X0) and multiplier (dX) for scaling values such that the final value equals (dX)*X + X0. If you change the offset, the scale does not use 0 as the origin of the plot. This property is read only.
X Scale:RangeSpecifies the scale range using a cluster with subparameters Minimum and Maximum.
X Scale:Scale FitScales the x-axis to fit the data. You can select one of the following options.
  • 0—Do not autoscale.
  • 1—Autoscale once.
  • 2—Autoscale.
X Scale:VisibleShows the x-scale.
Y Scale:Format StringSets the format strings of the y-scale.
Y Scale:Name Label:TextSpecifies text as displayed in the front panel object. For example, if you set a string control to use Password Display, this property returns the password string, such as ****, not the Normal Display of the string.
Y Scale:Name Label:VisibleIndicates if the decoration is visible.
Y Scale:Offset and MultiplierDisplays a cluster of offset (Y0) and multiplier (dY) for scaling values such that the final value equals (dY)*Y + Y0. If you change the offset, the scale does not use 0 as the origin of the plot. This property is read only.
Y Scale:RangeSpecifies the scale range using a cluster with subparameters Minimum and Maximum.
Y Scale:Scale FitScales the y-axis to fit the data. You can select one of the following options.
  • 0—Do not autoscale.
  • 1—Autoscale once.
  • 2—Autoscale.
Y Scale:VisibleShows the y-scale.
Z Scale:Format StringSets the format strings of the z-scale.
Z Scale:Interpolate ColorInterpolates the color plot.
Z Scale:Name Label:TextSpecifies text as displayed in the front panel object. For example, if you set a string control to use Password Display, this property returns the password string, such as ****, not the Normal Display of the string.
Z Scale:Name Label:VisibleIndicates if the decoration is visible.
Z Scale:RangeSpecifies the scale range using a cluster with subparameters Minimum and Maximum.
Z Scale:Scale FitScales the z-axis to fit the data. You can select one of the following options.
  • 0—Do not autoscale.
  • 1—Autoscale once.
  • 2—Autoscale.
Z Scale:VisibleShows the z-scale.

Methods

You can use the following Colormap graph methods with the Invoke Node.

MethodDescription
svx_Map Coordinates to XYMaps the owning pane coordinates to the XY location on a graph. If you do not specify the scales, LabVIEW uses the active scales.
svx_Map XY to CoordinatesMaps the XY location on a graph to the owning pane coordinates. If you do not specify the scales, LabVIEW uses the active scales. This method is useful when you need to map graph coordinates to plot images coordinates to draw images inside the plot area of a graph.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit