Colormap

Sound and Vibration Measurement Help


Edition Date: March 2018
Part Number: 372416L-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2018 Sound and Vibration Toolkit Help
LabVIEW 2019 Sound and Vibration Toolkit Help

Owning Palette: Transient Spectra Controls


Requires: Sound and Vibration Measurement Suite

Displays results of transient analysis or order analysis on a customizable 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.

You can use the following VIs to prepare and display a colormap:

Properties

You can set Colormap properties in the Graph Properties: Colormap 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:FrequenciesFrequency value for displaying the frequency lines.
Cursor Lines:Frequency Lines:Line Property:ColorColor of the frequency lines.
Cursor Lines:Frequency Lines:Line Property:Line VisibleDisplays the frequency lines.
Cursor Lines:Frequency Lines:Line Property:StyleStyle of the frequency lines.
Cursor Lines:Frequency Lines:Line Property:WidthWidth, 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 ColorBackground color of the text for displaying the frequency lines.
Cursor Lines:Frequency Lines:Text Property:ColorColor of the text for displaying the frequency lines.
Cursor Lines:Frequency Lines:Text Property:SizeFont 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:ColorColor of the order lines.
Cursor Lines:Order Lines:Line Property:Line VisibleDisplays the order lines.
Cursor Lines:Order Lines:Line Property:StyleStyle of the order lines.
Cursor Lines:Order Lines:Line Property:WidthWidth in pixels of the pen the VI uses to draw the order lines.
Cursor Lines:Order Lines:OrdersOrder 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 ColorBackground color of the text for displaying the order lines.
Cursor Lines:Order Lines:Text Property:ColorColor of the text for displaying the order lines.
Cursor Lines:Order Lines:Text Property:SizeFont 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 DragIf TRUE, allows you to drag the cursor.
Cursor:Cursor ColorThe color of the cursor, including its point, arrow, and name.
Cursor:Cursor IndexArray index of point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1.
Cursor:Cursor ModeSpecifies the way in which the cursor snaps to the plots in the plot area. Valid values include 0 (Free), 1 (Single-plot), and 2 (Multi-plot).
Cursor:Cursor Name VisibleIf TRUE, displays the cursor name in the plot area.
Cursor:Cursor NameText displayed in the plot area that is associated with the cursor.
Cursor:Cursor PlotPlot with which the cursor is associated. If 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 StyleThe symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16.
Cursor:Cursor PositionPosition of cursor in terms of X–Y coordinates.
  • Cursor Position:Cursor X—The X coordinate of the cursor in the plot area. Position:X is in the coordinate system of the X Scale value that is associated with the cursor or plot.
  • Cursor Position:Cursor Y—The Y coordinate of the cursor in the plot area. Position:Y is in the coordinate system of the Y Scale value that is associated with the cursor or plot.
Cursor:Cursor StyleThe symbol that, in combination with Point Style, is drawn at the focal point of the cursor. Valid values are 08, from top-left to bottom-right, as shown when you right-click a cursor in the cursor legend and select Attributes»Cursor Style from the shortcut menu.
Cursor:Line StyleSpecifies the line style of the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the Cursors page of the Properties dialog box ordered from top to bottom.
Cursor:Line WidthSpecifies the width of the line used to display the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the Cursors page of the Properties dialog box ordered from top to bottom.
Cursor:Plot AreaThe plot area with which the cursor is associated. This property applies only to Mixed Signal graphs.
Cursor:Selection ColorColor of the cursor row selected in the cursor legend.
Cursor:VisibleShows the cursor.
Cursor:Watch All PlotsIf TRUE, the cursor watches all plots in the plot area. If FALSE, the cursor watches only the plots specified by the Watch Plots property. This property is valid only for cursors that are associated with multiple plots.
Cursor:Watch PlotsArray that contains the indexes of the plots that the cursor is watching when the Watch All Plots property is set to FALSE. This property is valid only for cursors that are associated with multiple plots.
Cursor:X ScaleSets the x-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
Cursor:Y ScaleSets the y-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
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:ColorColor 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.
X Scale:Format StringFormat strings of the x-scale.
X Scale:Name Label:TextText 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:RangeScale 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 StringFormat strings of the y-scale.
Y Scale:Name Label:TextText 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:RangeScale 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 StringFormat strings of the z-scale.
Z Scale:Interpolate ColorInterpolates the color plot.
Z Scale:Name Label:TextText 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:RangeScale 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
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.
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.

Shortcut Menu Options

You can use the following Colormap shortcut menu options to monitor the current order and frequency.

Shortcut Menu OptionDescription
Show Current OrderDisplays the order line of the graph according to the cursor's current position.
Show Current FrequencyDisplays the frequency line of the graph according to the cursor's current position.
Anchor CurrentAnchors the current order line and frequency line to the graph. The corresponding order and frequency values are added to the order and frequency lists located in Properties»Cursor Lines. If Show Current Order is selected, it will anchor the order line and add the order value. If Show Current Frequency is selected, it will anchor the frequency line and add the frequency value.

WAS THIS ARTICLE HELPFUL?

Not Helpful