TimeMeasurement

_TMeas_Data_ExportFile, _TMeas_DefineProbes, _TMeas_DefineRatio, _TMeas_Graph_ExportFile, _TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, _TMeas_Options, _TMeas_Probes_FromFile, _TMeas_Probes_ToFile, _TMeas_ShowEventsSetup, TMeas_Data_Clipboard, TMeas_Data_ExportExcel, TMeas_Data_ExportFile, TMeas_Data_GetNumDecimals, TMeas_Data_Reset, TMeas_Data_SetNumDecimals, TMeas_GetFeaturesList, TMeas_GetFeaturesNumber, TMeas_Graph_Clipboard, TMeas_Graph_DefineTimeWnd, TMeas_Graph_ExportFile, TMeas_Graph_FindValueX, TMeas_Graph_GetBackColor, TMeas_Graph_GetLineThick, TMeas_Graph_GetVerticalAxisScale, TMeas_Graph_InsertDistanceX, TMeas_Graph_Set_Settings, TMeas_Graph_Set_XAxis_Settings, TMeas_Graph_Set_YAxis_Settings, TMeas_Graph_SetBackColor, TMeas_Graph_SetLineThick, TMeas_Graph_SetVerticalAxisScale, TMeas_Graph_ShowGrid, TMeas_Meas_Clear, TMeas_Meas_Insert, TMeas_Meas_ResetData, TMeas_MeasureWholeND, TMeas_Probe_DuplicateProbe, TMeas_Probe_EnableProbe, TMeas_Probe_HighlightProbe, TMeas_Probe_RemoveProbe, TMeas_Probes_Copy, TMeas_Probes_GetNumProbes, TMeas_Probes_Paste, TMeas_Probes_RemoveAllProbes, TMeas_SetFeatureLeft, TMeas_SetFeatureRight, TMeas_SetROIDyesMode, TMeas_ShowControl, TMeas_Start, TMeas_Stop, TMeas_Timing_GetType, TMeas_Timing_SetEveryFrame, TMeas_Timing_SetInterval, TMeas_Timing_SetType

TMeas_Data_Clipboard

Description 

 TMeas_Data_Clipboard();

This function relates to the Time Measurement. It copies the data currently observed in the graph to clipboard as a Tab delimited text.

TMeas_Data_ExportExcel

Description 

 TMeas_Data_ExportExcel(
   bool  Full
);

This function relates to the Time Measurement. It opens MS Excel (if installed) and inserts the measured data into a new table.

Parameters

bool Full

Full data insert.

0

Only the data displayed in the graph will be exported (the selected channel).

1

Data of all channels will be exported.

TMeas_Data_ExportFile

Description 

 TMeas_Data_ExportFile(
   char *Filename
);

This function exports time measurement data from the current document. The function asks the user to specify the file destination and then writes the current data view to the file.

Parameters

char *Filename

Full path to the destination txt file. E.g. C:\export\file1.txt

TMeas_Data_GetNumDecimals

Description 

 TMeas_Data_GetNumDecimals(
   int *Number
);

This function relates to Time Measurement. The function returns the decimals number for values in data view.

Parameters

int *Number

Pointer to integer which is filled with the number of decimals.

TMeas_Data_Reset

Description 

 TMeas_Data_Reset();

This function relates to Time Measurement. It deletes all measured data. The probes maintain.

TMeas_Data_SetNumDecimals

Description 

 TMeas_Data_SetNumDecimals(
   int  Number
);

This function relates to Time Measurement. It sets the decimals number for values in data view.

Parameters

int Number

Integer which specifies the number of decimals. Minimum 1, maximum 4.

TMeas_GetFeaturesList

Description 

 TMeas_GetFeaturesList(
   char *LeftStringValue,
   char *RightStringValue,
   int  Number,
   int  TMeasItemDesc
);

This function returns the list of features which are currently available to be displayed in the time measurement graph window.

Parameters

char *LeftStringValue

An array of strings available to be displayed on the left side. The length of each string is 128 characters.

char *RightStringValue

An array of strings available to be displayed on the right side. The length of each string is 128 characters.

int Number

The number of characters of the RightStringValue/LeftStringValue array. The arrays must be the same size. It is N x 128 where N is the number of array positions.

int TMeasItemDesc

Type of the features description.

0

Values appearing in the pull-down menus (e.g. Red, Green, etc.). These values are language-dependent.

1

Internal description of the features (e.g. Channel1, Channel2, etc.)

TMeas_GetFeaturesNumber

Description 

 TMeas_GetFeaturesNumber(
   int *lpLeftNumber,
   int *lpRightNumber
);

This function returns the number of features available to be displayed on the left/right time measurement graph axes.

Parameters

int *lpLeftNumber

The number of features available on the left axis.

int *lpRightNumber

The number of features available on the right axis.

TMeas_Graph_Clipboard

Description 

 TMeas_Graph_Clipboard();

This function relates to Time Measurement. It copies the graph to the clipboard. It can be inserted to MS Excel via the standard Paste command.

TMeas_Graph_DefineTimeWnd

Description 

 TMeas_Graph_DefineTimeWnd(
   int  Index
);

This function relates to Time Measurement. It defines the time interval that is displayed within the time axis of the graph. Use the Index parameter to set the time interval (0 = Auto scale, 1 = 5 sec, 2 = 10 sec, 3 = 15 sec, 4 = 20 sec, 5 = 30 sec, 6 = 50 sec, 7 = 100 sec, 8 = 150 sec, 9 = 200 sec, 10 = 300 sec).

Parameters

int Index

Index number (zero-based).

TMeas_Graph_ExportFile

Description 

 TMeas_Graph_ExportFile(
   char *Filename
);

This function exports the time measurement graph. The export is executed in a .BMP format.

Parameters

char *Filename

Full path to the raster image file. E.g. C:\backup\backup1.bmp

See Also 
_TMeas_Graph_ExportFile, TMeas_Data_ExportFile

TMeas_Graph_FindValueX

Description 

 TMeas_Graph_FindValueX(
   int  TMeasProbe,
   int  Direction,
   double  ValueY,
   double  InitValX,
   double *XValue,
   char *XUnits
);

This function searches for a point on a graph in Time measurement of a specific Y value. It starts from an initial x value of the search (InitValX) and goes left or right (Direction) until it finds the desired y value (ValueY) or fails.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

int Direction

Direction of search.

0

Goes to the left from initial point.

1

Goes to the right from initial point.

double ValueY

Value of the point to be found.

double InitValX

Initial value.

double *XValue

Filled with X coordinate if the point was found.

char *XUnits

Filled with units of x axis.

See Also 
_TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, TMeas_Graph_InsertDistanceX, TMeas_Meas_Clear, TMeas_Meas_Insert, TMeas_Meas_ResetData

TMeas_Graph_GetBackColor

Description 

 TMeas_Graph_GetBackColor(
   dword *Color
);

This function gets the graph background color. The color value is in RGB form.

Parameters

dword *Color

Pointer to color value.

See Also 
TMeas_Graph_SetBackColor

TMeas_Graph_GetLineThick

Description 

 TMeas_Graph_GetLineThick(
   int *Thickness
);

This function relates to the Time Measurement. It returns the graph pen thickness in pixels.

Parameters

int *Thickness

Pointer to integer which is filled with the pen thickness.

TMeas_Graph_GetVerticalAxisScale

Description 

 TMeas_Graph_GetVerticalAxisScale(
   int *pType
);

This function relates to the Time Measurement. It returns the graph scaling on vertical axis.

Parameters

int *pType

Pointer to integer which is filled with the scaling.

0

Autoscale is off

1

Autoscale is on

See Also 
TMeas_Graph_SetVerticalAxisScale

TMeas_Graph_InsertDistanceX

Description 

 TMeas_Graph_InsertDistanceX(
   double  LeftVal,
   double  RightVal,
   char *TextInCaption
);

Inserts a horizontal distance marker into the Time Measurement graph.

Parameters

double LeftVal

Left limit of the line marker. In graph units (typically in ms).

double RightVal

Right limit of the line marker. In graph units (typically in ms).

char *TextInCaption

Text to be displayed over the line marker.

See Also 
_TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, TMeas_Graph_FindValueX, TMeas_Meas_Clear, TMeas_Meas_Insert, TMeas_Meas_ResetData

TMeas_Graph_SetBackColor

Description 

 TMeas_Graph_SetBackColor(
   dword  Color
);

This function sets the background color of the time measurement graph.

Parameters

dword Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

See Also 
TMeas_Graph_GetBackColor

TMeas_Graph_SetLineThick

Description 

 TMeas_Graph_SetLineThick(
   int  Thickness
);

This function relates to the Time Measurement. It sets the graph pen thickness in pixels.

Thickness parameter is the integer which specifies the pen thickness. Min 1, max 3.

Parameters

int Thickness

Specifies the thickness.

TMeas_Graph_SetVerticalAxisScale

Description 

 TMeas_Graph_SetVerticalAxisScale(
   int  Type
);

This function relates to the Time Measurement. It sets auto scale options of vertical axis of the time measurement graph.

Parameters

int Type

Vertical autoscale type

0

Turns autoscale off

1

Turns autoscale on

See Also 
TMeas_Graph_GetVerticalAxisScale

TMeas_Graph_Set_Settings

Description 

 TMeas_Graph_Set_Settings(
   char *Title,
   int  ShowGrid,
   int  ShowMinorGrid,
   int  HorzAxisAllwaysVisible,
   int  VertAxisAllwaysVisible,
   int  LogarithmicAxes,
   int  DrawGraphPoints,
   int  FillGraphArea,
   int  AntiAlias,
   int  InterpolationMethod,
   int  Background,
   int  AxesColor,
   int  GraphGridColor,
   int  MinorGridColor,
   int  FillAreaOpacityPerc,
   int  DataDecimalPlaces,
   double  ViewToTime
);

This function presets properties and appearance of the Time Measurement graph.

Parameters

char *Title

Title name.

int ShowGrid

Displays or hides grid.

0

Hides grid.

1

Displays grid.

int ShowMinorGrid

Displays or hides minor grid.

0

Hides grid.

1

Displays grid.

int HorzAxisAllwaysVisible

Horizontal axis visibility.

0

the axis may leave the graph area while zooming in the graph

1

the axis do not leave the graph area while zooming in the graph

int VertAxisAllwaysVisible

Vertical axis visibility.

0

the axis may leave the graph area while zooming in the graph

1

the axis do not leave the graph area while zooming in the graph

int LogarithmicAxes

Use of logarithmic axes.

int DrawGraphPoints

Display data points in the graph.

int FillGraphArea

Displays graph background.

int AntiAlias

Use of AntiAlias.

0

turn off AntiAlias

1

turn on AntiAlias

int InterpolationMethod

Type of interpolation method.

0

Step

1

Linear

2

Bicubic

int Background

Color of the background.

-1

Tiled background (default)

0

Black

1

White

RGB value

Color as an integer value, (hexadecimal form: 0xRRGGBB)

int AxesColor

Graph axes color.

int GraphGridColor

Color of the major grid.

int MinorGridColor

Color of the minor grid.

int FillAreaOpacityPerc

Set the percentage of background color opacity

int DataDecimalPlaces

Number of decimal places of the displayed data values.

0 - 4

decimal places

double ViewToTime

Display fixed time range during measurement (in msec).

TMeas_Graph_Set_XAxis_Settings

Description 

 TMeas_Graph_Set_XAxis_Settings(
   double  XAxisMin,
   double  XAxisMax,
   double  XAxisMinor,
   double  XAxisMajor,
   double  XAxisZoomMin,
   double  XAxisZoomMax
);

This function presets the range and zoom of X axis of the Time Measurement graph.

Parameters

double XAxisMin

X axis minimal value displayed in the graph

double XAxisMax

X axis maximal value displayed in the graph

double XAxisMinor

Minor tick mark spacing.

double XAxisMajor

Major tick mark spacing.

double XAxisZoomMin

minimal displayed value in one graph window

double XAxisZoomMax

maximal displayed value in one graph window

TMeas_Graph_Set_YAxis_Settings

Description 

 TMeas_Graph_Set_YAxis_Settings(
   int  LeftAxis,
   double  XAxisMin,
   double  XAxisMax,
   double  XAxisMinor,
   double  XAxisMajor,
   double  XAxisZoomMin,
   double  XAxisZoomMax,
   int  MonoCompGraphColor,
   int  RatioGraphColor,
   int  PenLineStyle,
   int  PenLineThick
);

This function presets the range, zoom and appearance of Y axis of the Time Measurement graph.

Parameters

int LeftAxis

position of the axis

0

right axis

1

left axis

double XAxisMin

X axis minimal value displayed in the graph

double XAxisMax

X axis maximal value displayed in the graph

double XAxisMinor

Minor tick mark spacing.

double XAxisMajor

Major tick mark spacing.

double XAxisZoomMin

minimal displayed value in one graph window

double XAxisZoomMax

maximal displayed value in one graph window

int MonoCompGraphColor

Color of the graph line.

int RatioGraphColor

Color of the graph line.

int PenLineStyle

Style of the graph line.

int PenLineThick

Thickness of the graph line.

TMeas_Graph_ShowGrid

Description 

 TMeas_Graph_ShowGrid(
   int  Enabled
);

This function relates to the Time Measurement. It displays/hides the grid inside the graph area.

Parameters

int Enabled

0

Disabled.

1

Enabled.

TMeas_Meas_Clear

Description 

 TMeas_Meas_Clear();

This function clears any measurement shown in the Time Measurement graph area.

See Also 
_TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, TMeas_Graph_FindValueX, TMeas_Graph_InsertDistanceX, TMeas_Meas_Insert, TMeas_Meas_ResetData

TMeas_Meas_Insert

Description 

 TMeas_Meas_Insert(
   double  InitValX,
   char *TextInCaption
);

This function inserts a value (InitValX) and a comment to the Time measurement interactive measure records.

Parameters

double InitValX

Initial value.

char *TextInCaption

Comment to be inserted.

See Also 
_TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, TMeas_Graph_FindValueX, TMeas_Graph_InsertDistanceX, TMeas_Meas_Clear, TMeas_Meas_ResetData

TMeas_Meas_ResetData

Description 

 TMeas_Meas_ResetData();

This function resets the Time measurement interactive measure records.

See Also 
_TMeas_Graph_PickValueFromProbe, _TMeas_Meas_Measure, TMeas_Graph_FindValueX, TMeas_Graph_InsertDistanceX, TMeas_Meas_Clear, TMeas_Meas_Insert

TMeas_MeasureWholeND

Description 

 TMeas_MeasureWholeND();

This function performs Time measurement on the whole ND sequence.

TMeas_Probe_DuplicateProbe

Description 

 TMeas_Probe_DuplicateProbe(
   int  TMeasProbe
);

This function relates to Time Measurement. It creates a duplicate of one probe of the current probe set according to the parameter. The duplicate is shifted slightly.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

TMeas_Probe_EnableProbe

Description 

 TMeas_Probe_EnableProbe(
   int  TMeasProbe,
   int  TMeasProbeEnable
);

This function relates to the Time Measurement. It makes one ROI probe of the current probe set selected/unselected. It does not affect the measurement (the measurement is performed even under the unselected probes.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

int TMeasProbeEnable

Select the probe?

0

Deselect the probe

1

Select the probe

See Also 
TMeas_Probe_DuplicateProbe, TMeas_Probe_RemoveProbe

TMeas_Probe_HighlightProbe

Description 

 TMeas_Probe_HighlightProbe(
   int  TMeasProbe,
   int  TMeasProbeHighLight
);

This function enables you to highlight a single probe/graph line.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

int TMeasProbeHighLight

Highlight the probe?

0

No

1

Yes

TMeas_Probe_RemoveProbe

Description 

 TMeas_Probe_RemoveProbe(
   int  TMeasProbe
);

This function relates to the Time Measurement. It removes one probe of the current probe set according to the parameter.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

TMeas_Probes_Copy

Description 

 TMeas_Probes_Copy();

This function relates to the Time Measurement. It copies all probes of the current probe set to the clipboard.

See Also 
TMeas_Probes_Paste

TMeas_Probes_GetNumProbes

Description 

 TMeas_Probes_GetNumProbes(
   int *Type
);

This function relates to the Time Measurement. It returns the number of defined time measurement probes for current document.

Parameters

int *Type

Pointer to integer which is filled with the number of defined probes.

TMeas_Probes_Paste

Description 

 TMeas_Probes_Paste();

This function relates to the Time Measurement. It inserts the probes copied to the clipboard via the TMeas_Probes_Copy function.

See Also 
TMeas_Probes_Copy

TMeas_Probes_RemoveAllProbes

Description 

 TMeas_Probes_RemoveAllProbes();

This function relates to the Time Measurement. It deletes all probes of the current probe set. No confirmation window appears.

TMeas_SetFeatureLeft

Description 

 TMeas_SetFeatureLeft(
   char  TMeasFeatureString
);

This function sets the feature to be displayed on the left axis of the time measurement graph.

Parameters

char TMeasFeatureString

The name of the feature to be displayed in the graph. Both name types (TMeasItemDesc) can be inserted.

See Also 
TMeas_GetFeaturesList

TMeas_SetFeatureRight

Description 

 TMeas_SetFeatureRight(
   char  TMeasFeatureString
);

This function sets the feature to be displayed on the right axis of the time measurement graph.

Parameters

char TMeasFeatureString

The name of the feature to be displayed in the graph. Both name types (TMeasItemDesc) can be inserted.

See Also 
TMeas_GetFeaturesList

TMeas_SetROIDyesMode

Description 

 TMeas_SetROIDyesMode(
   int  TMeasRoiDyes
);

This function sets the mode of time measurement graph display.

Parameters

int TMeasRoiDyes

0

Multi Dyes mode.

1

Multi ROIs mode.

TMeas_ShowControl

This function runs the Measure > Time measurement command.

Description 

 TMeas_ShowControl();

This function displays the Time Measurement control window (not docked).

TMeas_Start

Description 

 TMeas_Start();

This function sets one of the Time Measurement properties. It turns the Time Measurement procedure ON.

TMeas_Stop

Description 

 TMeas_Stop();

This function sets one of the Time Measurement properties. It turns the Time Measurement procedure OFF.

TMeas_Timing_GetType

Description 

 TMeas_Timing_GetType(
   int *Type
);

This function relates to the Time Measurement. It returns defined timing type for time measurement on live image.

Parameters

int *Type

Pointer to integer which is filled with the timing type.

0

frame timing

1

timer timing

TMeas_Timing_SetEveryFrame

Description 

 TMeas_Timing_SetEveryFrame(
   int  Every
);

This function sets one of the Time Measurement properties. The parameter determines the rate of measurement via number of frames. The actual timing depends on camera frame rate.

Parameters

int Every

The measurement will be performed every N-th frame.

TMeas_Timing_SetInterval

Description 

 TMeas_Timing_SetInterval(
   int  IntervalMS
);

This function sets one of the Time Measurement properties. It defines how often the Measurement of intensity is performed. The units are in milliseconds.

Parameters

int IntervalMS

The time interval in milliseconds.

TMeas_Timing_SetType

Description 

 TMeas_Timing_SetType(
   int  Type
);

This function relates to Time Measurement. It defines timing type for time measurement on live image.

Parameters

int Type

Integer which specifies the timing type.

0

frame timing

1

timer timing

_TMeas_Data_ExportFile

Description 

 _TMeas_Data_ExportFile();

This function displays the Export to File dialog window from where it is possible to save the current time measurement data to a *.txt file. The function does not work unless some data is measured.

_TMeas_DefineProbes

Description 

 _TMeas_DefineProbes();

This function displays the Define Probes dialog window containing tools for probes creation.

_TMeas_DefineRatio

Description 

 _TMeas_DefineRatio();

This function displays the Ratio Definition dialog box where ratio measurement properties (Numerator, Denominator, Background value) can be set.

_TMeas_Graph_ExportFile

Description 

 _TMeas_Graph_ExportFile();

This function displays the Export Graph to File dialog window from where it is possible to save the current graph to an *.bmp file. The function does not work unless some data is measured.

_TMeas_Graph_PickValueFromProbe

Description 

 _TMeas_Graph_PickValueFromProbe(
   int  TMeasProbe,
   char *TextInCaption,
   char *Text,
   double *XValue,
   char *XUnits,
   double *YValue,
   char *YUnits
);

This function lets the user pick a point on a curve in Time measurement and returns its coordinates (X and Y with the corresponding units). A guiding dialog with text is displayed.

Parameters

int TMeasProbe

The Probe index (1, 2, ...n) or a special value listed here.

-1

First selected probe

-2

First bookmarked probe

char *TextInCaption

Text shown in the caption of the dialog.

char *Text

Text shown in the dialog.

double *XValue

Filled with X coordinate if the point was found.

char *XUnits

Filled with units of x axis.

double *YValue

Filled with y value.

char *YUnits

Filled with units of y axis.

See Also 
_TMeas_Meas_Measure, TMeas_Graph_FindValueX, TMeas_Graph_InsertDistanceX, TMeas_Meas_Clear, TMeas_Meas_Insert, TMeas_Meas_ResetData

_TMeas_Meas_Measure

Description 

 _TMeas_Meas_Measure(
   int  Type,
   double *Value,
   char *Units
);

This function interactively measures a feature specified in Type parameter on the Time measurement graph and returns it. The record is also added to the list of measurements.

Parameters

int Type

Type of feature to be measured.

1

Measure vertical lines

2

Measure horizontal lines

3

Measure slope via angle

4

Measure slope via free angle

double *Value

Value of the measured feature.

char *Units

Units of the measured feature.

See Also 
_TMeas_Graph_PickValueFromProbe, TMeas_Graph_FindValueX, TMeas_Graph_InsertDistanceX, TMeas_Meas_Clear, TMeas_Meas_Insert, TMeas_Meas_ResetData

_TMeas_Options

Description 

 _TMeas_Options();

This command displays the Time Measurement Options window where Hotkeys of user events, Timing, and Graph and Data properties can be set.

_TMeas_Probes_FromFile

Description 

 _TMeas_Probes_FromFile();

This command opens saved ROI from file. The command opens the dialog window that enables you to load the set of Time Measurement probes from a *.tif file.

_TMeas_Probes_ToFile

Description 

 _TMeas_Probes_ToFile();

This command saves the ROI to file. The command opens the dialog window that enables you to save the current set of Time Measurement probes to a *.tif file. The probe set can be later loaded via the _TMeas_Probes_FromFile.

_TMeas_ShowEventsSetup

Description 

 _TMeas_ShowEventsSetup();

This function opens a dialog box where it is possible to define the hotkeys for the Next Phase and User Defined events.