vtkKWPiecewiseFunctionEditor Class Reference

a piecewise function editor More...

#include <vtkKWPiecewiseFunctionEditor.h>

Inheritance diagram for vtkKWPiecewiseFunctionEditor:

[legend]

Collaboration diagram for vtkKWPiecewiseFunctionEditor:

[legend]

List of all members.

Public Types
typedef vtkKWParameterValueHermiteFunctionEditor	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual void	UpdateEnableState ()
virtual int	MoveFunctionPoint (int id, double parameter, const double *values)
Static Public Member Functions
static vtkKWPiecewiseFunctionEditor *	New ()
static int	IsTypeOf (const char *type)
static vtkKWPiecewiseFunctionEditor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWPiecewiseFunctionEditor ()
	~vtkKWPiecewiseFunctionEditor ()
virtual void	CreateWidget ()
virtual int	GetMidPointVisibility ()
virtual int	GetFunctionPointColorInCanvas (int id, double rgb[3])
virtual void	UpdatePointEntries (int id)
virtual void	GetLineCoordinates (int id1, int id2, vtksys_ios::ostream *tk_cmd)
virtual void	UpdatePointsFromWindowLevel (int interactive=0)
virtual void	UpdateWindowLevelFromPoints ()
virtual void	InvokeWindowLevelModeChangedCommand (int mode)
virtual void	InvokeFunctionChangedCommand ()
virtual void	InvokeFunctionChangingCommand ()
virtual unsigned long	GetRedrawFunctionTime ()
Protected Attributes
vtkPiecewiseFunction *	PiecewiseFunction
vtkColorTransferFunction *	PointColorTransferFunction
int	WindowLevelMode
int	ValueEntryVisibility
int	WindowLevelModeButtonVisibility
int	WindowLevelModeLockEndPointValue
double	Window
double	Level
char *	WindowLevelModeChangedCommand
vtkKWEntryWithLabel *	ValueEntry
vtkKWCheckButton *	WindowLevelModeCheckButton

virtual vtkPiecewiseFunction *	GetPiecewiseFunction ()
virtual void	SetPiecewiseFunction (vtkPiecewiseFunction *)
virtual vtkColorTransferFunction *	GetPointColorTransferFunction ()
virtual void	SetPointColorTransferFunction (vtkColorTransferFunction *)
virtual void	SetWindowLevelMode (int)
virtual void	WindowLevelModeOn ()
virtual void	WindowLevelModeOff ()
virtual int	GetWindowLevelMode ()
virtual void	SetWindowLevelModeChangedCommand (vtkObject object, const char method)
virtual void	SetWindowLevelModeButtonVisibility (int)
virtual void	WindowLevelModeButtonVisibilityOn ()
virtual void	WindowLevelModeButtonVisibilityOff ()
virtual int	GetWindowLevelModeButtonVisibility ()
virtual void	SetWindowLevelModeLockEndPointValue (int)
virtual void	WindowLevelModeLockEndPointValueOn ()
virtual void	WindowLevelModeLockEndPointValueOff ()
virtual int	GetWindowLevelModeLockEndPointValue ()
virtual void	SetWindowLevel (double window, double level)
virtual void	SetInteractiveWindowLevel (double window, double level)
virtual double	GetWindow ()
virtual double	GetLevel ()
virtual void	ValueEntryVisibilityOn ()
virtual void	ValueEntryVisibilityOff ()
virtual void	SetValueEntryVisibility (int)
virtual int	GetValueEntryVisibility ()
virtual vtkKWEntryWithLabel *	GetValueEntry ()
virtual int	HasFunction ()
virtual int	GetFunctionSize ()
virtual unsigned long	GetFunctionMTime ()
virtual int	GetFunctionPointParameter (int id, double *parameter)
virtual int	GetFunctionPointDimensionality ()
virtual int	FunctionPointCanBeAdded ()
virtual int	FunctionPointCanBeRemoved (int id)
virtual int	FunctionPointParameterIsLocked (int id)
virtual int	FunctionPointValueIsLocked (int id)
virtual void	ValueEntryCallback (const char *value)
virtual void	WindowLevelModeCallback (int state)
virtual int	GetFunctionPointValues (int id, double *values)
virtual int	SetFunctionPointValues (int id, const double *values)
virtual int	InterpolateFunctionPointValues (double parameter, double *values)
virtual int	AddFunctionPoint (double parameter, const double values, int id)
virtual int	SetFunctionPoint (int id, double parameter, const double *values)
virtual int	RemoveFunctionPoint (int id)
virtual int	FunctionLineIsSampledBetweenPoints (int id1, int id2)
virtual int	GetFunctionPointMidPoint (int id, double *pos)
virtual int	SetFunctionPointMidPoint (int id, double pos)
virtual int	GetFunctionPointSharpness (int id, double *sharpness)
virtual int	SetFunctionPointSharpness (int id, double sharpness)
virtual int	FunctionPointMidPointIsLocked (int id)
virtual int	FunctionPointSharpnessIsLocked (int id)
virtual void	Pack ()
virtual void	PackPointEntries ()
virtual void	CreateWindowLevelModeCheckButton ()
virtual void	CreateValueEntry ()
virtual int	IsTopLeftFrameUsed ()
virtual int	IsPointEntriesFrameUsed ()

Detailed Description

a piecewise function editor

A widget that allows the user to edit a piecewise function.

Thanks:: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

Events:: vtkKWEvent::WindowLevelChangingEvent vtkKWEvent::WindowLevelChangedEvent

Definition at line 39 of file vtkKWPiecewiseFunctionEditor.h.

Member Typedef Documentation

typedef vtkKWParameterValueHermiteFunctionEditor vtkKWPiecewiseFunctionEditor::Superclass

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

Definition at line 44 of file vtkKWPiecewiseFunctionEditor.h.

Constructor & Destructor Documentation

vtkKWPiecewiseFunctionEditor::vtkKWPiecewiseFunctionEditor ( ) [protected]

vtkKWPiecewiseFunctionEditor::~vtkKWPiecewiseFunctionEditor ( ) [protected]

Member Function Documentation

static vtkKWPiecewiseFunctionEditor* vtkKWPiecewiseFunctionEditor::New ( ) [static]

Reimplemented from vtkKWWidgetWithLabel.

virtual const char* vtkKWPiecewiseFunctionEditor::GetClassName ( ) [virtual]

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

static int vtkKWPiecewiseFunctionEditor::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

static vtkKWPiecewiseFunctionEditor* vtkKWPiecewiseFunctionEditor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

void vtkKWPiecewiseFunctionEditor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual vtkPiecewiseFunction* vtkKWPiecewiseFunctionEditor::GetPiecewiseFunction ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetPiecewiseFunction ( vtkPiecewiseFunction * ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::Update ( ) [virtual]

Update the whole UI depending on the value of the Ivars

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual vtkColorTransferFunction* vtkKWPiecewiseFunctionEditor::GetPointColorTransferFunction ( ) [virtual]

Get/Set an optional color transfer function to be used to retrieve the color of each point. It is likely you may want to turn ComputePointColorFromValue to On too.

virtual void vtkKWPiecewiseFunctionEditor::SetPointColorTransferFunction ( vtkColorTransferFunction * ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetWindowLevelMode ( int ) [virtual]

Set/Get the window/level mode. In that mode: - the end-points parameter are locked (similar to LockEndPointsParameter) - no point can be added or removed (similar to DisableAddAndRemove) - the first and second point have the same value (they move together) - the last and last-1 point have the same value (they move together) - the midpoint and sharpness are set to (0.5 / 0.0) and can not be edited

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeOn ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeOff ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual int vtkKWPiecewiseFunctionEditor::GetWindowLevelMode ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetWindowLevelModeChangedCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

Specifies a command to associate with the widget. This command is typically invoked when the window/level *mode* is changed. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - new histogram log mode: int

virtual void vtkKWPiecewiseFunctionEditor::SetWindowLevelModeButtonVisibility ( int ) [virtual]

Set/Get the window/level mode button visibility. Note: set this parameter to the proper value before calling Create() in order to minimize the footprint of the object.

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeButtonVisibilityOn ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeButtonVisibilityOff ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual int vtkKWPiecewiseFunctionEditor::GetWindowLevelModeButtonVisibility ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetWindowLevelModeLockEndPointValue ( int ) [virtual]

Set/Get the window/level lock mode. In that mode, provided that WindowLevelMode is On: - the last and last-1 points values are locked (expected to be the same)

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeLockEndPointValueOn ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeLockEndPointValueOff ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual int vtkKWPiecewiseFunctionEditor::GetWindowLevelModeLockEndPointValue ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetWindowLevel	(	double	window,
		double	level
	)			`[virtual]`

Set/Get the window/level. This method will invoke FunctionChangedCommand. Use SetInteractiveWindowLevel to invoke FunctionChangingCommand instead.

virtual void vtkKWPiecewiseFunctionEditor::SetInteractiveWindowLevel	(	double	window,
		double	level
	)			`[virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual double vtkKWPiecewiseFunctionEditor::GetWindow ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual double vtkKWPiecewiseFunctionEditor::GetLevel ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::ValueEntryVisibilityOn ( ) [virtual]

Set/Get the value entry UI visibility. Not shown if superclass PointEntriesVisibility is set to Off Note: set this parameter to the proper value before calling Create() in order to minimize the footprint of the object.

virtual void vtkKWPiecewiseFunctionEditor::ValueEntryVisibilityOff ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::SetValueEntryVisibility ( int ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual int vtkKWPiecewiseFunctionEditor::GetValueEntryVisibility ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual vtkKWEntryWithLabel* vtkKWPiecewiseFunctionEditor::GetValueEntry ( ) [virtual]

Access the entry If you need to customize this object, make sure you first set ValueEntryVisibility to On and call Create().

virtual void vtkKWPiecewiseFunctionEditor::UpdateEnableState ( ) [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::HasFunction ( ) [virtual]

Proxy to the function. See protected: section too.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionSize ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual unsigned long vtkKWPiecewiseFunctionEditor::GetFunctionMTime ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointParameter	(	int	id,
		double *	parameter
	)			`[virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointDimensionality ( ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointCanBeAdded ( ) [virtual]

Is point locked, protected, removable ?

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointCanBeRemoved ( int id ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointParameterIsLocked ( int id ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointValueIsLocked ( int id ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::MoveFunctionPoint	(	int	id,
		double	parameter,
		const double *	values
	)			`[virtual]`

Higher-level methods to manipulate the function.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::ValueEntryCallback ( const char * value ) [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWPiecewiseFunctionEditor::WindowLevelModeCallback ( int state ) [virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual void vtkKWPiecewiseFunctionEditor::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointValues	(	int	id,
		double *	values
	)			`[protected, virtual]`

Proxy to the function. Those are low-level manipulators, they do not check if points can be added/removed/locked, it is up to the higer-level methods to do it. IMPLEMENT those functions in the subclasses. See public: section too.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::SetFunctionPointValues	(	int	id,
		const double *	values
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::InterpolateFunctionPointValues	(	double	parameter,
		double *	values
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::AddFunctionPoint	(	double	parameter,
		const double *	values,
		int *	id
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::SetFunctionPoint	(	int	id,
		double	parameter,
		const double *	values
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::RemoveFunctionPoint ( int id ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::FunctionLineIsSampledBetweenPoints	(	int	id1,
		int	id2
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueFunctionInterface.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointMidPoint	(	int	id,
		double *	pos
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::SetFunctionPointMidPoint	(	int	id,
		double	pos
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointSharpness	(	int	id,
		double *	sharpness
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::SetFunctionPointSharpness	(	int	id,
		double	sharpness
	)			`[protected, virtual]`

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Implements vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointMidPointIsLocked ( int id ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::FunctionPointSharpnessIsLocked ( int id ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::GetMidPointVisibility ( ) [protected, virtual]

Events. Even though it is highly recommended to use the commands framework defined above to specify the callback methods you want to be invoked when specific event occur, you can also use the observer framework and listen to the corresponding events: BTX

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::GetFunctionPointColorInCanvas	(	int	id,
		double	rgb[3]
	)			`[protected, virtual]`

Higher-level methods to manipulate the function.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::UpdatePointEntries ( int id ) [protected, virtual]

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::GetLineCoordinates	(	int	id1,
		int	id2,
		vtksys_ios::ostream *	tk_cmd
	)			`[protected, virtual]`

Set the position of the parameter range UI. BTX

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::UpdatePointsFromWindowLevel ( int interactive = 0 ) [protected, virtual]

virtual void vtkKWPiecewiseFunctionEditor::UpdateWindowLevelFromPoints ( ) [protected, virtual]

virtual void vtkKWPiecewiseFunctionEditor::InvokeWindowLevelModeChangedCommand ( int mode ) [protected, virtual]

virtual void vtkKWPiecewiseFunctionEditor::InvokeFunctionChangedCommand ( ) [protected, virtual]

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::InvokeFunctionChangingCommand ( ) [protected, virtual]

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::Pack ( ) [protected, virtual]

Pack the widget

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::PackPointEntries ( ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual void vtkKWPiecewiseFunctionEditor::CreateWindowLevelModeCheckButton ( ) [protected, virtual]

Create some objects on the fly (lazy creation, to allow for a smaller footprint)

virtual void vtkKWPiecewiseFunctionEditor::CreateValueEntry ( ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

virtual int vtkKWPiecewiseFunctionEditor::IsTopLeftFrameUsed ( ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkKWPiecewiseFunctionEditor::IsPointEntriesFrameUsed ( ) [protected, virtual]

Get/Set the function Note that the whole parameter range is automatically reset to the function range.

Reimplemented from vtkKWParameterValueHermiteFunctionEditor.

virtual unsigned long vtkKWPiecewiseFunctionEditor::GetRedrawFunctionTime ( ) [protected, virtual]

Redraw. Will actually call, if necessary: RedrawSizeDependentElements: the size of the canvas or the extent of its ranges have changed RedrawPanDependentElements: the visible ranges are panned while their extents are unchanged RedrawFunctionDependentElements: the function has changed (as triggered if GetRedrawFunctionTime(), a monotonically increasing value, has changed. in this implementation, it just calls GetFunctionMTime(), but can be overriden in subclasses to take into account other objects modification time)

Reimplemented from vtkKWParameterValueFunctionEditor.