VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPiecewiseFunction Class Reference

Defines a 1D piecewise function. More...

#include <vtkPiecewiseFunction.h>

Inheritance diagram for vtkPiecewiseFunction:
[legend]
Collaboration diagram for vtkPiecewiseFunction:
[legend]

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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPiecewiseFunctionNewInstance () 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...
 
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/Remove points to/from the function. More...
 
int AddPoint (double x, double y, double midpoint, double sharpness)
 Add/Remove points to/from the function. More...
 
int RemovePoint (double x)
 Add/Remove points to/from 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...
 
doubleGetDataPointer ()
 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 doubleGetRange ()
 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)
 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)
 Fills in an array of function values evaluated at regular intervals. More...
 
virtual void SetClamping (int)
 When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. More...
 
virtual int 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 SetAllowDuplicateScalars (int)
 Toggle whether to allow duplicate scalar values in the piecewise function (off by default). More...
 
virtual int 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
vtkDataObjectNewInstance () 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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual vtkFieldDataGetAttributesAsFieldData (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 vtkInformationGetInformation ()
 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 vtkFieldDataGetFieldData ()
 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkPiecewiseFunctionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPiecewiseFunctionSafeDownCast (vtkObjectBase *o)
 
static vtkPiecewiseFunctionGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkPiecewiseFunctionGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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 vtkInformationGetNamedFieldInformation (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 vtkInformationSetActiveAttribute (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 *associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPiecewiseFunction ()
 
 ~vtkPiecewiseFunction () override
 
void SortAndUpdateRange ()
 
bool UpdateRange ()
 
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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPiecewiseFunctionInternals * Internal
 
int Clamping
 
doubleFunction
 
double Range [2]
 
int AllowDuplicateScalars
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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).

Examples:
vtkPiecewiseFunction (Examples)
Tests:
vtkPiecewiseFunction (Tests)

Definition at line 51 of file vtkPiecewiseFunction.h.

Member Typedef Documentation

Definition at line 55 of file vtkPiecewiseFunction.h.

Constructor & Destructor Documentation

vtkPiecewiseFunction::vtkPiecewiseFunction ( )
protected
vtkPiecewiseFunction::~vtkPiecewiseFunction ( )
overrideprotected

Member Function Documentation

static vtkPiecewiseFunction* vtkPiecewiseFunction::New ( )
static
static int vtkPiecewiseFunction::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkPiecewiseFunction* vtkPiecewiseFunction::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPiecewiseFunction::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

vtkPiecewiseFunction* vtkPiecewiseFunction::NewInstance ( ) const
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.

void vtkPiecewiseFunction::DeepCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

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

Reimplemented from vtkDataObject.

void vtkPiecewiseFunction::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

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

Reimplemented from vtkDataObject.

int vtkPiecewiseFunction::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataObject.

Definition at line 64 of file vtkPiecewiseFunction.h.

int vtkPiecewiseFunction::GetSize ( )

Get the number of points used to specify the function.

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

Add/Remove points to/from the function.

If a duplicate point is added then the function value is changed at that location. Return the index of the point (0 based), or -1 on error.

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

Add/Remove points to/from the function.

If a duplicate point is added then the function value is changed at that location. Return the index of the point (0 based), or -1 on error.

int vtkPiecewiseFunction::RemovePoint ( double  x)

Add/Remove points to/from the function.

If a duplicate point is added then the function value is changed at that location. Return the index of the point (0 based), or -1 on error.

void vtkPiecewiseFunction::RemoveAllPoints ( )

Removes all points from the function.

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. This is a legacy method that does not allow the specification of the sharpness and midpoint values for the two nodes.

double vtkPiecewiseFunction::GetValue ( double  x)

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

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.

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.

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.

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.

virtual double* vtkPiecewiseFunction::GetRange ( )
virtual

Returns the min and max node locations of the function.

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

Returns the min and max node locations of the function.

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

Returns the min and max node locations of the function.

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.

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

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

Parameter "stride" is used to step through the output "table".

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

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

Parameter "stride" is used to step through the output "table".

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.

virtual void vtkPiecewiseFunction::SetClamping ( int  )
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.

virtual int 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.

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.

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.

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)

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.

void vtkPiecewiseFunction::Initialize ( )
overridevirtual

Clears out the current function.

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

Reimplemented from vtkDataObject.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

virtual void vtkPiecewiseFunction::SetAllowDuplicateScalars ( int  )
virtual

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

virtual int vtkPiecewiseFunction::GetAllowDuplicateScalars ( )
virtual

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

virtual void vtkPiecewiseFunction::AllowDuplicateScalarsOn ( )
virtual

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

virtual void vtkPiecewiseFunction::AllowDuplicateScalarsOff ( )
virtual

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

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().

void vtkPiecewiseFunction::SortAndUpdateRange ( )
protected
bool vtkPiecewiseFunction::UpdateRange ( )
protected
double vtkPiecewiseFunction::FindMinimumXDistance ( )
protected

Traverses the nodes to find the minimum distance.

Assumes nodes are sorted.

Member Data Documentation

vtkPiecewiseFunctionInternals* vtkPiecewiseFunction::Internal
protected

Definition at line 234 of file vtkPiecewiseFunction.h.

int vtkPiecewiseFunction::Clamping
protected

Definition at line 240 of file vtkPiecewiseFunction.h.

double* vtkPiecewiseFunction::Function
protected

Definition at line 243 of file vtkPiecewiseFunction.h.

double vtkPiecewiseFunction::Range[2]
protected

Definition at line 246 of file vtkPiecewiseFunction.h.

int vtkPiecewiseFunction::AllowDuplicateScalars
protected

Definition at line 248 of file vtkPiecewiseFunction.h.


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