TDMS Create Scaling Information VI

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Owning Palette: Advanced TDMS VIs and Functions

Requires: Base Development System

Copyright: (c) 2018 National Instruments. All rights reserved.

Creates scaling information for unscaled data in a .tdms file. This VI writes the scaling information to the .tdms file. You must manually select the polymorphic instance to use.

To call this VI with TDMS Advanced functions, only call the TDMS Set Channel Information function after any calls to this VI.

Use the TDMS File Viewer VI to retrieve the scaling information from a .tdms file.

Note  This VI does not scale strings or complex floating-point numbers.

Example

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

TDMS Create Scaling Information (Linear)

linear scale specifies the linear scaling information. A linear scale uses the equation y=mx+b, where x is a pre-scaled value, and y is a scaled value.
slope specifies the slope, or m in the equation, for the scale. The default is 0.
y intercept specifies the y intercept, or b in the equation, for the scale. The default is 0.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Polynomial)

polynomial scale specifies the polynomial scaling information. A polynomial scale uses an nth-order polynomial equation.
coefficients specifies the coefficients for the scale that converts pre-scaled values to scaled values. Each element of the array corresponds to a term of the equation. For example, if index three of the array is 9, the fourth term of the equation is 9x3.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Thermocouple)

thermocouple scale specifies the thermocouple scaling information, which scales the .tdms data from microvolts to degrees Celsius. If the data is not in microvolts, first convert the data to microvolts with an additional scale. For example, you can use the TDMS Create Scaling Information (Linear) instance VI to convert the data.
thermocouple type specifies the type of thermocouple connected to the channel. Thermocouple types differ in composition and measurement range.

10047B—Specifies the B-type thermocouple.
10055E—Specifies the E-type thermocouple.
10072J (default)—Specifies the J-type thermocouple.
10073K—Specifies the K-type thermocouple.
10077N—Specifies the N-type thermocouple.
10082R—Specifies the R-type thermocouple.
10085S—Specifies the S-type thermocouple.
10086T—Specifies the T-type thermocouple.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (RTD)

RTD scale specifies the resistance temperature detector (RTD) scaling information, which scales the .tdms data in degrees Celsius.
current excitation specifies, in amperes, the amount of excitation that the sensor requires. Refer to the sensor documentation to determine this value.
r0 nominal resistance specifies the sensor resistance, in ohms, at 0 degrees Celsius. The Callendar-Van Dusen equation requires this value. Refer to the sensor documentation to determine this value.
a specifies the a coefficient for the Callendar-Van Dusen equation. Refer to the sensor documentation to determine this value.
b specifies the b coefficient for the Callendar-Van Dusen equation. Refer to the sensor documentation to determine this value.
c specifies the c coefficient for the Callendar-Van Dusen equation. Refer to the sensor documentation to determine this value.
lead wire resistance specifies the amount of resistance in ohms in the lead wires. Ideally, this value is the same for all leads.
resistance configuration specifies the number of wires to use for resistance measurements.

22-Wire (default)—Specifies the 2-wire mode.
33-Wire—Specifies the 3-wire mode.
44-Wire—Specifies the 4-wire mode.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Table)

table scale specifies the table scaling information. A table scale maps an array of pre-scaled values to an array of corresponding scaled values.
scaled values specifies the scaled values that map to the values in pre-scaled values.
pre-scaled values specifies the pre-scaled values that map to the values in scaled values.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Strain)

strain scale specifies the strain scaling information, which scales the .tdms data in strains. Strain is the amount of deformation of a body due to an applied force. Specifically, strain is the fractional change in length.
configuration specifies the bridge configuration for the strain gages.

10183Full Bridge I (default)
10184Full Bridge II
10185Full Bridge III
10188Half Bridge I
10189Half Bridge II
10271Quarter Bridge I
10272Quarter Bridge II
Poisson ratio specifies the ratio of lateral strain to axial strain in the material you are measuring.
gage resistance specifies the resistance, in ohms, of the gages in an unstrained position. Each gage in the bridge must have the same nominal gage resistance. The resistance across arms of the bridge that do not have strain gages also must be the same as the nominal gage resistance. Refer to the sensor documentation to determine this value.
lead wire resistance specifies the amount of resistance in ohms in the lead wires. Ideally, this value is the same for all leads.
initial bridge voltage specifies in volts the output voltage of the bridge in the unloaded condition. This VI subtracts this value from any measurements before applying scaling equations. Perform a voltage measurement on the bridge with no strain applied to determine this value.
gage factor specifies the sensitivity of the strain gages and relates the change in electrical resistance to the change in strain. Each gage in the bridge must have the same gage factor. Refer to the sensor documentation to determine this value.
voltage excitation specifies in volts the amount of excitation that the sensor requires. Refer to the sensor documentation to determine this value.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Thermistor)

thermistor scale specifies the thermistor scaling information, which scales the .tdms data in Kelvin.
resistance configuration specifies the number of wires to use for resistance measurements.

22-Wire (default)—Specifies the 2-wire mode.
33-Wire—Specifies the 3-wire mode.
44-Wire—Specifies the 4-wire mode.
excitation type specifies the type of excitation for the scale.

10122Voltage (default)—Voltage excitation.
10334Current—Current excitation.
excitation value specifies the amount of excitation that the sensor requires. When excitation type is Current, the unit of excitation value is amperes. When excitation type is Voltage, the unit of excitation value is volts. Refer to the sensor documentation to determine this value.
r1 reference resistance specifies, in ohms, the value of the reference resistor.
lead wire resistance specifies the amount of resistance in ohms in the lead wires. Ideally, this value is the same for all leads.
a specifies the a constant for the Steinhart-Hart thermistor equation. Refer to the sensor documentation to determine the value for this constant.
b specifies the b constant for the Steinhart-Hart thermistor equation. Refer to the sensor documentation to determine the value for this constant.
c specifies the c constant for the Steinhart-Hart thermistor equation. Refer to the sensor documentation to determine the value for this constant.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

TDMS Create Scaling Information (Reciprocal)

reciprocal scale specifies the reciprocal scaling information. A reciprocal scale divides the number 1 by an input value. If the input value is zero, this VI uses zero as the reciprocal.
input source specifies the ID of the child scale. If the current scale has a child scale, you can wire the scale ID of the child scale to this input. The default is –1, which specifies that the current scale does not have a child scale.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum. group name and channel name take precedence over this input. If you specify a value for either group name or channel name, this VI applies the scaling information to either the group or the channel, respectively. If you do not specify a value for them, this VI applies the scaling information to the .tdms data.
group name specifies the group name for the .tdms data. This input takes precedence over tdms file but has a lower priority than channel name.
channel name specifies the channel name for the .tdms data. This input takes precedence over group name and tdms file. If you do not specify a value for channel name, this VI applies the scaling information to the group. If you do not specify a value for group name either, this VI applies the scaling information to the .tdms data.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
scale ID returns the ID of the resulting scale.

Example

Refer to the Scale TDMS Data VI in the labview\examples\File IO\TDMS directory for an example of using the TDMS Create Scaling Information VI.

WAS THIS ARTICLE HELPFUL?

Not Helpful