Defines a 1D piecewise function. More...

#include <vtkPiecewiseFunction.h>

Inheritance diagram for vtkPiecewiseFunction:

Collaboration diagram for vtkPiecewiseFunction:

Public Types
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPiecewiseFunction *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	DeepCopy (vtkDataObject *f) override
	Shallow and Deep copy. More...

void	ShallowCopy (vtkDataObject *f) override
	Shallow and Deep copy. More...

int	GetDataObjectType () override
	Return what type of dataset this is. More...

int	GetSize ()
	Get the number of points used to specify the function. More...

bool	RemovePointByIndex (size_t id)
	Remove a point from the function at a given id Return true if point has been found and removed, false other wise. More...

int	RemovePoint (double x)
	Remove the first point found at the given x location Return the index of the remove point if any, -1 otherwise. More...

int	RemovePoint (double x, double y)
	Remove the first point found at the given x and y location Return the index of the remove point if any, -1 otherwise. More...

void	RemoveAllPoints ()
	Removes all points from the function. More...

void	AddSegment (double x1, double y1, double x2, double y2)
	Add a line segment to the function. More...

double	GetValue (double x)
	Returns the value of the function at the specified location using the specified interpolation. More...

int	AdjustRange (double range[2])
	Remove all points out of the new range, and make sure there is a point at each end of that range. More...

void	BuildFunctionFromTable (double x1, double x2, int size, double *table, int stride=1)
	Constructs a piecewise function from a table. More...

const char *	GetType ()
	Return the type of function: Function Types: 0 : Constant (No change in slope between end points) 1 : NonDecreasing (Always increasing or zero slope) 2 : NonIncreasing (Always decreasing or zero slope) 3 : Varied (Contains both decreasing and increasing slopes) More...

double	GetFirstNonZeroValue ()
	Returns the first point location which precedes a non-zero segment of the function. More...

void	Initialize () override
	Clears out the current function. More...

int	EstimateMinNumberOfSamples (double const &x1, double const &x2)
	Estimates the minimum size of a table such that it would correctly sample this function. More...


int	AddPoint (double x, double y)
	Add points to the function. More...

int	AddPoint (double x, double y, double midpoint, double sharpness)
	Add points to the function. More...


int	GetNodeValue (int index, double val[4])
	For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values at the node. More...

int	SetNodeValue (int index, double val[4])
	For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values at the node. More...


double *	GetDataPointer ()
	Returns a pointer to the data stored in the table. More...

void	FillFromDataPointer (int, double *)
	Returns a pointer to the data stored in the table. More...


virtual double *	GetRange ()
	Returns the min and max node locations of the function. More...

virtual void	GetRange (double &, double &)
	Returns the min and max node locations of the function. More...

virtual void	GetRange (double[2])
	Returns the min and max node locations of the function. More...


void	GetTable (double x1, double x2, int size, float *table, int stride=1, int logIncrements=0)
	Fills in an array of function values evaluated at regular intervals. More...

void	GetTable (double x1, double x2, int size, double *table, int stride=1, int logIncrements=0)
	Fills in an array of function values evaluated at regular intervals. More...


virtual void	SetClamping (vtkTypeBool)
	When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. More...

virtual vtkTypeBool	GetClamping ()
	When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. More...

virtual void	ClampingOn ()
	When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. More...

virtual void	ClampingOff ()
	When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. More...


virtual void	SetUseLogScale (bool)
	Interpolate between the control points in base-10 logrithmic space. More...

virtual bool	GetUseLogScale ()
	Interpolate between the control points in base-10 logrithmic space. More...

virtual void	UseLogScaleOn ()
	Interpolate between the control points in base-10 logrithmic space. More...

virtual void	UseLogScaleOff ()
	Interpolate between the control points in base-10 logrithmic space. More...


virtual void	SetAllowDuplicateScalars (vtkTypeBool)
	Toggle whether to allow duplicate scalar values in the piecewise function (off by default). More...

virtual vtkTypeBool	GetAllowDuplicateScalars ()
	Toggle whether to allow duplicate scalar values in the piecewise function (off by default). More...

virtual void	AllowDuplicateScalarsOn ()
	Toggle whether to allow duplicate scalar values in the piecewise function (off by default). More...

virtual void	AllowDuplicateScalarsOff ()
	Toggle whether to allow duplicate scalar values in the piecewise function (off by default). More...

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime. More...

void	ReleaseData ()
	Release data back to system to conserve memory resource. More...

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes). More...

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information. More...

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information. More...

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data. More...

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted. More...

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent. More...

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type. More...

virtual vtkDataArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified atribute type. More...

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData. More...

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from. More...

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object. More...

virtual int	GetDataReleased ()
	Get the flag indicating the data has been released. More...

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object. More...

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object. More...

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkPiecewiseFunction *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPiecewiseFunction *	SafeDownCast (vtkObjectBase *o)


static vtkPiecewiseFunction *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkPiecewiseFunction *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array. More...

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters. More...

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e. More...

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e. More...

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object. More...

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object. More...

static void	SetGlobalReleaseDataFlag (int val)
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

static int	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPiecewiseFunction ()

	~vtkPiecewiseFunction () override

void	SortAndUpdateRange ()
	Internal method to sort the vector and update the Range whenever a node is added, edited or removed. More...

bool	UpdateRange ()
	Returns true if the range has been updated and Modified() has been called. More...

double	FindMinimumXDistance ()
	Traverses the nodes to find the minimum distance. More...

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPiecewiseFunctionInternals *	Internal

vtkTypeBool	Clamping

double *	Function

double	Range [2]

vtkTypeBool	AllowDuplicateScalars

bool	UseLogScale

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Defines a 1D piecewise function.

Defines a piecewise function mapping. This mapping allows the addition of control points, and allows the user to control the function between the control points. A piecewise hermite curve is used between control points, based on the sharpness and midpoint parameters. A sharpness of 0 yields a piecewise linear function and a sharpness of 1 yields a piecewise constant function. The midpoint is the normalized distance between control points at which the curve reaches the median Y value. The midpoint and sharpness values specified when adding a node are used to control the transition to the next node (the last node's values are ignored) Outside the range of nodes, the values are 0 if Clamping is off, or the nearest node point if Clamping is on. Using the legacy methods for adding points (which do not have Sharpness and Midpoint parameters) will default to Midpoint = 0.5 (halfway between the control points) and Sharpness = 0.0 (linear).

Definition at line 45 of file vtkPiecewiseFunction.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkPiecewiseFunction::Superclass

Definition at line 49 of file vtkPiecewiseFunction.h.

Constructor & Destructor Documentation

◆ vtkPiecewiseFunction()

vtkPiecewiseFunction::vtkPiecewiseFunction ( )

protected

◆ ~vtkPiecewiseFunction()

vtkPiecewiseFunction::~vtkPiecewiseFunction ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPiecewiseFunction* vtkPiecewiseFunction::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkPiecewiseFunction::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkPiecewiseFunction::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObject.

◆ SafeDownCast()

static vtkPiecewiseFunction* vtkPiecewiseFunction::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPiecewiseFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkPiecewiseFunction* vtkPiecewiseFunction::NewInstance ( ) const

◆ PrintSelf()

void vtkPiecewiseFunction::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkPiecewiseFunction::DeepCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

These copy the data, but not any of the pipeline connections.

Reimplemented from vtkDataObject.

◆ ShallowCopy()

void vtkPiecewiseFunction::ShallowCopy ( vtkDataObject * src )

overridevirtual

Shallow and Deep copy.

These copy the data, but not any of the pipeline connections.

Reimplemented from vtkDataObject.

◆ GetDataObjectType()

int vtkPiecewiseFunction::GetDataObjectType ( )

inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataObject.

Definition at line 58 of file vtkPiecewiseFunction.h.

◆ GetSize()

int vtkPiecewiseFunction::GetSize ( )

Get the number of points used to specify the function.

◆ AddPoint() [1/2]

int vtkPiecewiseFunction::AddPoint	(	double	x,
		double	y
	)

Add points to the function.

If a duplicate point is added then the previous point is removed unless AllowDuplicateScalars is set to true Return the index of the point (0 based), or -1 on error.

◆ AddPoint() [2/2]

int vtkPiecewiseFunction::AddPoint	(	double	x,
		double	y,
		double	midpoint,
		double	sharpness
	)

Add points to the function.

If a duplicate point is added then the previous point is removed unless AllowDuplicateScalars is set to true Return the index of the point (0 based), or -1 on error.

◆ RemovePointByIndex()

bool vtkPiecewiseFunction::RemovePointByIndex ( size_t id )

Remove a point from the function at a given id Return true if point has been found and removed, false other wise.

◆ RemovePoint() [1/2]

int vtkPiecewiseFunction::RemovePoint ( double x )

Remove the first point found at the given x location Return the index of the remove point if any, -1 otherwise.

◆ RemovePoint() [2/2]

int vtkPiecewiseFunction::RemovePoint	(	double	x,
		double	y
	)

Remove the first point found at the given x and y location Return the index of the remove point if any, -1 otherwise.

◆ RemoveAllPoints()

void vtkPiecewiseFunction::RemoveAllPoints ( )

Removes all points from the function.

◆ AddSegment()

void vtkPiecewiseFunction::AddSegment	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

Add a line segment to the function.

All points defined between the two points specified are removed from the function. To specify the sharpness and midpoint values, use AddPoint method instead.

◆ GetValue()

double vtkPiecewiseFunction::GetValue ( double x )

Returns the value of the function at the specified location using the specified interpolation.

◆ GetNodeValue()

int vtkPiecewiseFunction::GetNodeValue	(	int	index,
		double	val[4]
	)

For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values at the node.

Returns -1 if the index is out of range, returns 1 otherwise.

◆ SetNodeValue()

int vtkPiecewiseFunction::SetNodeValue	(	int	index,
		double	val[4]
	)

For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values at the node.

Returns -1 if the index is out of range, returns 1 otherwise.

◆ GetDataPointer()

double* vtkPiecewiseFunction::GetDataPointer ( )

Returns a pointer to the data stored in the table.

Fills from a pointer to data stored in a similar table. These are legacy methods which will be maintained for compatibility - however, note that the vtkPiecewiseFunction no longer stores the nodes in a double array internally.

◆ FillFromDataPointer()

void vtkPiecewiseFunction::FillFromDataPointer	(	int	,
		double *
	)

Returns a pointer to the data stored in the table.

Fills from a pointer to data stored in a similar table. These are legacy methods which will be maintained for compatibility - however, note that the vtkPiecewiseFunction no longer stores the nodes in a double array internally.

◆ GetRange() [1/3]

virtual double* vtkPiecewiseFunction::GetRange ( )

virtual

Returns the min and max node locations of the function.

◆ GetRange() [2/3]

virtual void vtkPiecewiseFunction::GetRange	(	double &	,
		double &
	)

virtual

Returns the min and max node locations of the function.

◆ GetRange() [3/3]

virtual void vtkPiecewiseFunction::GetRange ( double [2] )

virtual

Returns the min and max node locations of the function.

◆ AdjustRange()

int vtkPiecewiseFunction::AdjustRange ( double range[2] )

Remove all points out of the new range, and make sure there is a point at each end of that range.

Return 1 on success, 0 otherwise.

◆ GetTable() [1/2]

void vtkPiecewiseFunction::GetTable	(	double	x1,
		double	x2,
		int	size,
		float *	table,
		int	stride = `1`,
		int	logIncrements = `0`
	)

Fills in an array of function values evaluated at regular intervals.

Parameter "stride" is used to step through the output "table". If logIncrements is true, the intervals between entries will be constant in logarithmic space.

◆ GetTable() [2/2]

void vtkPiecewiseFunction::GetTable	(	double	x1,
		double	x2,
		int	size,
		double *	table,
		int	stride = `1`,
		int	logIncrements = `0`
	)

Fills in an array of function values evaluated at regular intervals.

Parameter "stride" is used to step through the output "table". If logIncrements is true, the intervals between entries will be constant in logarithmic space.

◆ BuildFunctionFromTable()

void vtkPiecewiseFunction::BuildFunctionFromTable	(	double	x1,
		double	x2,
		int	size,
		double *	table,
		int	stride = `1`
	)

Constructs a piecewise function from a table.

Function range is is set to [x1, x2], function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "stride" is is step through the input table.

◆ SetClamping()

virtual void vtkPiecewiseFunction::SetClamping ( vtkTypeBool )

virtual

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.

When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

◆ GetClamping()

virtual vtkTypeBool vtkPiecewiseFunction::GetClamping ( )

virtual

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.

When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

◆ ClampingOn()

virtual void vtkPiecewiseFunction::ClampingOn ( )

virtual

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.

When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

◆ ClampingOff()

virtual void vtkPiecewiseFunction::ClampingOff ( )

virtual

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.

When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

◆ SetUseLogScale()

virtual void vtkPiecewiseFunction::SetUseLogScale ( bool )

virtual

Interpolate between the control points in base-10 logrithmic space.

Default is false.

◆ GetUseLogScale()

virtual bool vtkPiecewiseFunction::GetUseLogScale ( )

virtual

Interpolate between the control points in base-10 logrithmic space.

Default is false.

◆ UseLogScaleOn()

virtual void vtkPiecewiseFunction::UseLogScaleOn ( )

virtual

Interpolate between the control points in base-10 logrithmic space.

Default is false.

◆ UseLogScaleOff()

virtual void vtkPiecewiseFunction::UseLogScaleOff ( )

virtual

Interpolate between the control points in base-10 logrithmic space.

Default is false.

◆ GetType()

const char* vtkPiecewiseFunction::GetType ( )

Return the type of function: Function Types: 0 : Constant (No change in slope between end points) 1 : NonDecreasing (Always increasing or zero slope) 2 : NonIncreasing (Always decreasing or zero slope) 3 : Varied (Contains both decreasing and increasing slopes)

◆ GetFirstNonZeroValue()

double vtkPiecewiseFunction::GetFirstNonZeroValue ( )

Returns the first point location which precedes a non-zero segment of the function.

Note that the value at this point may be zero.

◆ Initialize()

void vtkPiecewiseFunction::Initialize ( )

overridevirtual

Clears out the current function.

A newly created vtkPiecewiseFunction is already initialized, so there is no need to call this method which in turn simply calls RemoveAllPoints()

Reimplemented from vtkDataObject.

◆ GetData() [1/2]

static vtkPiecewiseFunction* vtkPiecewiseFunction::GetData ( vtkInformation * info )

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkPiecewiseFunction* vtkPiecewiseFunction::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

static

Retrieve an instance of this class from an information object.

◆ SetAllowDuplicateScalars()

virtual void vtkPiecewiseFunction::SetAllowDuplicateScalars ( vtkTypeBool )

virtual

Toggle whether to allow duplicate scalar values in the piecewise function (off by default).

◆ GetAllowDuplicateScalars()

virtual vtkTypeBool vtkPiecewiseFunction::GetAllowDuplicateScalars ( )

virtual

Toggle whether to allow duplicate scalar values in the piecewise function (off by default).

◆ AllowDuplicateScalarsOn()

virtual void vtkPiecewiseFunction::AllowDuplicateScalarsOn ( )

virtual

Toggle whether to allow duplicate scalar values in the piecewise function (off by default).

◆ AllowDuplicateScalarsOff()

virtual void vtkPiecewiseFunction::AllowDuplicateScalarsOff ( )

virtual

Toggle whether to allow duplicate scalar values in the piecewise function (off by default).

◆ EstimateMinNumberOfSamples()

int vtkPiecewiseFunction::EstimateMinNumberOfSamples	(	double const &	x1,
		double const &	x2
	)

Estimates the minimum size of a table such that it would correctly sample this function.

The returned value should be passed as parameter 'n' when calling GetTable().

◆ SortAndUpdateRange()

void vtkPiecewiseFunction::SortAndUpdateRange ( )

protected

Internal method to sort the vector and update the Range whenever a node is added, edited or removed.

It always calls Modified().

◆ UpdateRange()

bool vtkPiecewiseFunction::UpdateRange ( )

protected

Returns true if the range has been updated and Modified() has been called.

◆ FindMinimumXDistance()

double vtkPiecewiseFunction::FindMinimumXDistance ( )

protected

Traverses the nodes to find the minimum distance.

Assumes nodes are sorted.

Member Data Documentation

◆ Internal

vtkPiecewiseFunctionInternals* vtkPiecewiseFunction::Internal

protected

Definition at line 263 of file vtkPiecewiseFunction.h.

◆ Clamping

vtkTypeBool vtkPiecewiseFunction::Clamping

protected

Definition at line 269 of file vtkPiecewiseFunction.h.

◆ Function

double* vtkPiecewiseFunction::Function

protected

Definition at line 272 of file vtkPiecewiseFunction.h.

◆ Range

double vtkPiecewiseFunction::Range[2]

protected

Definition at line 275 of file vtkPiecewiseFunction.h.

◆ AllowDuplicateScalars

vtkTypeBool vtkPiecewiseFunction::AllowDuplicateScalars

protected

Definition at line 277 of file vtkPiecewiseFunction.h.

◆ UseLogScale

bool vtkPiecewiseFunction::UseLogScale

protected

Definition at line 279 of file vtkPiecewiseFunction.h.

The documentation for this class was generated from the following file:

Common/DataModel/vtkPiecewiseFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPiecewiseFunction()

◆ ~vtkPiecewiseFunction()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ DeepCopy()

◆ ShallowCopy()

◆ GetDataObjectType()

◆ GetSize()

◆ AddPoint() [1/2]

◆ AddPoint() [2/2]

◆ RemovePointByIndex()

◆ RemovePoint() [1/2]

◆ RemovePoint() [2/2]

◆ RemoveAllPoints()

◆ AddSegment()

◆ GetValue()

◆ GetNodeValue()

◆ SetNodeValue()

◆ GetDataPointer()

◆ FillFromDataPointer()

◆ GetRange() [1/3]

◆ GetRange() [2/3]

◆ GetRange() [3/3]

◆ AdjustRange()

◆ GetTable() [1/2]

◆ GetTable() [2/2]

◆ BuildFunctionFromTable()

◆ SetClamping()

◆ GetClamping()

◆ ClampingOn()

◆ ClampingOff()

◆ SetUseLogScale()

◆ GetUseLogScale()

◆ UseLogScaleOn()

◆ UseLogScaleOff()

◆ GetType()

◆ GetFirstNonZeroValue()

◆ Initialize()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ SetAllowDuplicateScalars()

◆ GetAllowDuplicateScalars()

◆ AllowDuplicateScalarsOn()

◆ AllowDuplicateScalarsOff()

◆ EstimateMinNumberOfSamples()

◆ SortAndUpdateRange()

◆ UpdateRange()

◆ FindMinimumXDistance()

Member Data Documentation

◆ Internal

◆ Clamping

◆ Function

◆ Range

◆ AllowDuplicateScalars

◆ UseLogScale