TimeSeriesOperator Class Reference

Object to interact with the Time Series operator when it is active. More...

Public Member Functions
void	setFrameInfoVisibility (bool vis)
	Set whether the index of the dynamic data is shown (indicated as T0, T1, etc) in the upper right corner of the image. More...
float	getSingleFrameDuration (int frameNumber)
	Retrieves the duration (in seconds) for a single frame at the specified frame number. More...
bool	setSingleFrameDuration (int frameNumber, float frameDuration)
	Sets the duration (in seconds) of a single frame at the specified frame number. More...
string	getFrameDuration ()
	Retrieves the duration for all frames. More...
bool	setUniformFrameDuration (float frameDuration)
	Sets the duration (in seconds) for all frames. More...
bool	setVariableFrameDuration (string functionName)
	Sets a Variable Frame Duration Function. More...
void	setSingleFrameROI (int frameNumber, bool enabled)
	Sets the visibility of the Region of Interest (ROI) for a given frame number. More...
bool	isSingleFrameROIEnabled (int frameNumber)
	Checks if the Region of Interest (ROI) is enabled for a given frame number. More...
void	setShowROI (bool enabled)
	Sets the visibility of the Region of Interest (ROI) for all frames. More...
int	getShowROIState ()
	Checks if the Region of Interest (ROI) is enabled, partially enabled or disabled. More...

Detailed Description

Object to interact with the Time Series operator when it is active.

See also ScriptMaster::currentOp() to obtain this object.

Member Function Documentation

getFrameDuration()

string getFrameDuration

(

)

Retrieves the duration for all frames.

Returns

The duration (in seconds) or the Variable Frame Duration function used.

getShowROIState()

int getShowROIState

(

)

Checks if the Region of Interest (ROI) is enabled, partially enabled or disabled.

Returns

Returns 0 if the ROI is Disabled

Returns 1 if the ROI is Partially Enabled

Returns 2 if the ROI is Enabled

getSingleFrameDuration()

float getSingleFrameDuration

(

int

frameNumber

)

Retrieves the duration (in seconds) for a single frame at the specified frame number.

Parameters

frameNumber

The frame number for which to retrieve the duration.

Returns

The duration (in seconds) for the specified frame.

isSingleFrameROIEnabled()

bool isSingleFrameROIEnabled

(

int

frameNumber

)

Checks if the Region of Interest (ROI) is enabled for a given frame number.

Parameters

frameNumber

The frame number for which to check the ROI status.

Returns

true if the ROI is enabled for the specified frame, otherwise false.

setFrameInfoVisibility()

void setFrameInfoVisibility

(

bool

vis

)

Set whether the index of the dynamic data is shown (indicated as T0, T1, etc) in the upper right corner of the image.

Parameters

vis	The desired visibility of the info

setShowROI()

void setShowROI

(

bool

enabled

)

Sets the visibility of the Region of Interest (ROI) for all frames.

Parameters

enabled

true to enable the ROI, false to disable it.

setSingleFrameDuration()

bool setSingleFrameDuration	(	int	frameNumber,
		float	frameDuration
	)

Sets the duration (in seconds) of a single frame at the specified frame number.

Parameters

frameNumber	The frame number for which to set the duration.
frameDuration	The duration (in seconds) for the specified frame.

Returns

true if can set the frame duration, otherwise false.

setSingleFrameROI()

void setSingleFrameROI	(	int	frameNumber,
		bool	enabled
	)

Sets the visibility of the Region of Interest (ROI) for a given frame number.

Parameters

frameNumber	The frame number for which to set the ROI visibility.
enabled	true to enable the ROI, false to disable it.

setUniformFrameDuration()

bool setUniformFrameDuration

(

float

frameDuration

)

Sets the duration (in seconds) for all frames.

Parameters

frameDuration

The duration (in seconds).

Returns

true if can set the duration, otherwise false.

setVariableFrameDuration()

bool setVariableFrameDuration

(

string

functionName

)

Sets a Variable Frame Duration Function.

Parameters

functionName

The duration function (it must be one of the existing functions)

Returns

true if can set the frame duration function, otherwise false.