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

bin source cell data into input cells. More...

#include <vtkBinCellDataFilter.h>

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

Public Types

enum  CellOverlapCriterion { CELL_CENTROID =0, CELL_POINTS =1 }
 
typedef vtkContourValues vtkBinValues
 
- Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the data set whose cells will be counted. More...
 
void SetValue (int i, double value)
 Methods to set / get bin values. More...
 
double GetValue (int i)
 Get the ith bin value. More...
 
doubleGetValues ()
 Get a pointer to an array of bin values. More...
 
void GetValues (double *binValues)
 Fill a supplied list with bin values. More...
 
void SetNumberOfBins (int numBins)
 Set the number of bins to place into the list. More...
 
int GetNumberOfBins ()
 Get the number of bins in the list of bin values, not counting the overflow bin. More...
 
void GenerateValues (int numBins, double range[2])
 Generate numBins equally spaced bin values between specified range. More...
 
void GenerateValues (int numBins, double rangeStart, double rangeEnd)
 Generate numBins equally spaced bin values between specified range. More...
 
void SetSourceData (vtkDataObject *source)
 Specify the data set whose cells will be counted. More...
 
vtkDataObjectGetSource ()
 Specify the data set whose cells will be counted. More...
 
virtual void SetSpatialMatch (vtkTypeBool)
 This flag is used only when a piece is requested to update. More...
 
virtual vtkTypeBool GetSpatialMatch ()
 This flag is used only when a piece is requested to update. More...
 
virtual void SpatialMatchOn ()
 This flag is used only when a piece is requested to update. More...
 
virtual void SpatialMatchOff ()
 This flag is used only when a piece is requested to update. More...
 
virtual void SetStoreNumberOfNonzeroBins (bool)
 Set whether to store the number of nonzero bins for each cell. More...
 
virtual void StoreNumberOfNonzeroBinsOn ()
 Set whether to store the number of nonzero bins for each cell. More...
 
virtual void StoreNumberOfNonzeroBinsOff ()
 Set whether to store the number of nonzero bins for each cell. More...
 
virtual bool GetStoreNumberOfNonzeroBins ()
 Set whether to store the number of nonzero bins for each cell. More...
 
virtual void SetNumberOfNonzeroBinsArrayName (const char *)
 Returns the name of the id array added to the output that holds the number of nonzero bins per cell. More...
 
virtual char * GetNumberOfNonzeroBinsArrayName ()
 Returns the name of the id array added to the output that holds the number of nonzero bins per cell. More...
 
virtual void SetTolerance (double)
 Set the tolerance used to compute whether a cell centroid in the source is in a cell of the input. More...
 
virtual double GetTolerance ()
 Set the tolerance used to compute whether a cell centroid in the source is in a cell of the input. More...
 
virtual void SetComputeTolerance (bool)
 Set whether to use the Tolerance field or precompute the tolerance. More...
 
virtual void ComputeToleranceOn ()
 Set whether to use the Tolerance field or precompute the tolerance. More...
 
virtual void ComputeToleranceOff ()
 Set whether to use the Tolerance field or precompute the tolerance. More...
 
virtual bool GetComputeTolerance ()
 Set whether to use the Tolerance field or precompute the tolerance. More...
 
virtual void SetArrayComponent (int)
 Set/get which component of the scalar array to bin; defaults to 0. More...
 
virtual int GetArrayComponent ()
 Set/get which component of the scalar array to bin; defaults to 0. More...
 
virtual void SetCellOverlapMethod (int)
 Set whether cell overlap is determined by source cell centroid or by source cell points. More...
 
virtual int GetCellOverlapMethod ()
 Set whether cell overlap is determined by source cell centroid or by source cell points. More...
 
virtual void SetCellLocator (vtkAbstractCellLocator *cellLocator)
 Set/Get a spatial locator for speeding the search process. More...
 
virtual vtkAbstractCellLocatorGetCellLocator ()
 Set/Get a spatial locator for speeding the search process. More...
 
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as vtkRectilinearGrid. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. 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...
 
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...
 
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 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...
 
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 vtkBinCellDataFilterNew ()
 Construct object with initial range (VTK_DOUBLE_MIN, VTK_DOUBLE_MAX) and a single bin. More...
 
- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). 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

 vtkBinCellDataFilter ()
 
 ~vtkBinCellDataFilter () override
 
virtual void CreateDefaultLocator ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks the algorithm to do its work. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks for Information. More...
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. More...
 
- Protected Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool SpatialMatch
 
bool StoreNumberOfNonzeroBins
 
double Tolerance
 
bool ComputeTolerance
 
int ArrayComponent
 
int CellOverlapMethod
 
vtkBinValuesBinValues
 
vtkAbstractCellLocatorCellLocator
 
char * NumberOfNonzeroBinsArrayName
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkDataSetAlgorithm Superclass
 Standard methods for type and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for type and printing. More...
 
static vtkBinCellDataFilterSafeDownCast (vtkObjectBase *o)
 Standard methods for type and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for type and printing. More...
 
vtkBinCellDataFilterNewInstance () const
 Standard methods for type and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for type and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for type and printing. More...
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

bin source cell data into input cells.

vtkBinCellDataFilter takes a source mesh containing scalar cell data, an input mesh and a set of bin values and bins the source mesh's scalar cell data into the cells of the input mesh. The resulting output mesh is identical to the input mesh, with an additional cell data field, with tuple size equal to the number of bins + 1, that represents a histogram of the cell data values for all of the source cells whose centroid lie within the input cell.

This filter is useful for analyzing the efficacy of an input mesh's ability to represent the cell data of the source mesh.

Tests:
vtkBinCellDataFilter (Tests)

Definition at line 44 of file vtkBinCellDataFilter.h.

Member Typedef Documentation

Definition at line 47 of file vtkBinCellDataFilter.h.

Standard methods for type and printing.

Definition at line 59 of file vtkBinCellDataFilter.h.

Member Enumeration Documentation

Enumerator
CELL_CENTROID 
CELL_POINTS 

Definition at line 161 of file vtkBinCellDataFilter.h.

Constructor & Destructor Documentation

vtkBinCellDataFilter::vtkBinCellDataFilter ( )
protected
vtkBinCellDataFilter::~vtkBinCellDataFilter ( )
overrideprotected

Member Function Documentation

static vtkBinCellDataFilter* vtkBinCellDataFilter::New ( )
static

Construct object with initial range (VTK_DOUBLE_MIN, VTK_DOUBLE_MAX) and a single bin.

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

Standard methods for type and printing.

virtual vtkTypeBool vtkBinCellDataFilter::IsA ( const char *  type)
virtual

Standard methods for type and printing.

Reimplemented from vtkDataSetAlgorithm.

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

Standard methods for type and printing.

virtual vtkObjectBase* vtkBinCellDataFilter::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for type and printing.

Reimplemented from vtkDataSetAlgorithm.

vtkBinCellDataFilter* vtkBinCellDataFilter::NewInstance ( ) const

Standard methods for type and printing.

void vtkBinCellDataFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for type and printing.

Reimplemented from vtkDataSetAlgorithm.

void vtkBinCellDataFilter::SetValue ( int  i,
double  value 
)
inline

Methods to set / get bin values.

Set a particular bin value at bin number i.

The index i ranges between 0<=i<NumberOfBins.

Definition at line 220 of file vtkBinCellDataFilter.h.

double vtkBinCellDataFilter::GetValue ( int  i)
inline

Get the ith bin value.

Definition at line 226 of file vtkBinCellDataFilter.h.

double * vtkBinCellDataFilter::GetValues ( )
inline

Get a pointer to an array of bin values.

There will be GetNumberOfBins() values in the list.

Definition at line 233 of file vtkBinCellDataFilter.h.

void vtkBinCellDataFilter::GetValues ( double binValues)
inline

Fill a supplied list with bin values.

There will be GetNumberOfBins() values in the list. Make sure you allocate enough memory to hold the list.

Definition at line 241 of file vtkBinCellDataFilter.h.

void vtkBinCellDataFilter::SetNumberOfBins ( int  number)
inline

Set the number of bins to place into the list.

You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

Definition at line 249 of file vtkBinCellDataFilter.h.

int vtkBinCellDataFilter::GetNumberOfBins ( )
inline

Get the number of bins in the list of bin values, not counting the overflow bin.

Definition at line 256 of file vtkBinCellDataFilter.h.

void vtkBinCellDataFilter::GenerateValues ( int  numBins,
double  range[2] 
)
inline

Generate numBins equally spaced bin values between specified range.

Bin values will include min/max range values.

Definition at line 263 of file vtkBinCellDataFilter.h.

void vtkBinCellDataFilter::GenerateValues ( int  numBins,
double  rangeStart,
double  rangeEnd 
)
inline

Generate numBins equally spaced bin values between specified range.

Bin values will include min/max range values.

Definition at line 270 of file vtkBinCellDataFilter.h.

void vtkBinCellDataFilter::SetSourceData ( vtkDataObject source)

Specify the data set whose cells will be counted.

The Input gives the geometry (the points and cells) for the output, while the Source is used to determine how many source cells lie within each input cell.

vtkDataObject* vtkBinCellDataFilter::GetSource ( )

Specify the data set whose cells will be counted.

The Input gives the geometry (the points and cells) for the output, while the Source is used to determine how many source cells lie within each input cell.

void vtkBinCellDataFilter::SetSourceConnection ( vtkAlgorithmOutput algOutput)

Specify the data set whose cells will be counted.

The Input gives the geometry (the points and cells) for the output, while the Source is used to determine how many source cells lie within each input cell.

virtual void vtkBinCellDataFilter::SetSpatialMatch ( vtkTypeBool  )
virtual

This flag is used only when a piece is requested to update.

By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual vtkTypeBool vtkBinCellDataFilter::GetSpatialMatch ( )
virtual

This flag is used only when a piece is requested to update.

By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual void vtkBinCellDataFilter::SpatialMatchOn ( )
virtual

This flag is used only when a piece is requested to update.

By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual void vtkBinCellDataFilter::SpatialMatchOff ( )
virtual

This flag is used only when a piece is requested to update.

By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual void vtkBinCellDataFilter::SetStoreNumberOfNonzeroBins ( bool  )
virtual

Set whether to store the number of nonzero bins for each cell.

On by default.

virtual void vtkBinCellDataFilter::StoreNumberOfNonzeroBinsOn ( )
virtual

Set whether to store the number of nonzero bins for each cell.

On by default.

virtual void vtkBinCellDataFilter::StoreNumberOfNonzeroBinsOff ( )
virtual

Set whether to store the number of nonzero bins for each cell.

On by default.

virtual bool vtkBinCellDataFilter::GetStoreNumberOfNonzeroBins ( )
virtual

Set whether to store the number of nonzero bins for each cell.

On by default.

virtual void vtkBinCellDataFilter::SetNumberOfNonzeroBinsArrayName ( const char *  )
virtual

Returns the name of the id array added to the output that holds the number of nonzero bins per cell.

Set to "NumberOfNonzeroBins" by default.

virtual char* vtkBinCellDataFilter::GetNumberOfNonzeroBinsArrayName ( )
virtual

Returns the name of the id array added to the output that holds the number of nonzero bins per cell.

Set to "NumberOfNonzeroBins" by default.

virtual void vtkBinCellDataFilter::SetTolerance ( double  )
virtual

Set the tolerance used to compute whether a cell centroid in the source is in a cell of the input.

This value is only used if ComputeTolerance is off.

virtual double vtkBinCellDataFilter::GetTolerance ( )
virtual

Set the tolerance used to compute whether a cell centroid in the source is in a cell of the input.

This value is only used if ComputeTolerance is off.

virtual void vtkBinCellDataFilter::SetComputeTolerance ( bool  )
virtual

Set whether to use the Tolerance field or precompute the tolerance.

When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual void vtkBinCellDataFilter::ComputeToleranceOn ( )
virtual

Set whether to use the Tolerance field or precompute the tolerance.

When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual void vtkBinCellDataFilter::ComputeToleranceOff ( )
virtual

Set whether to use the Tolerance field or precompute the tolerance.

When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual bool vtkBinCellDataFilter::GetComputeTolerance ( )
virtual

Set whether to use the Tolerance field or precompute the tolerance.

When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual void vtkBinCellDataFilter::SetArrayComponent ( int  )
virtual

Set/get which component of the scalar array to bin; defaults to 0.

virtual int vtkBinCellDataFilter::GetArrayComponent ( )
virtual

Set/get which component of the scalar array to bin; defaults to 0.

virtual void vtkBinCellDataFilter::SetCellOverlapMethod ( int  )
virtual

Set whether cell overlap is determined by source cell centroid or by source cell points.

Centroid by default.

virtual int vtkBinCellDataFilter::GetCellOverlapMethod ( )
virtual

Set whether cell overlap is determined by source cell centroid or by source cell points.

Centroid by default.

virtual void vtkBinCellDataFilter::SetCellLocator ( vtkAbstractCellLocator cellLocator)
virtual

Set/Get a spatial locator for speeding the search process.

By default an instance of vtkStaticCellLocator is used.

virtual vtkAbstractCellLocator* vtkBinCellDataFilter::GetCellLocator ( )
virtual

Set/Get a spatial locator for speeding the search process.

By default an instance of vtkStaticCellLocator is used.

virtual void vtkBinCellDataFilter::CreateDefaultLocator ( )
protectedvirtual
int vtkBinCellDataFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work.

This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

int vtkBinCellDataFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called within ProcessRequest when a request asks for Information.

Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens in the first pass of the pipeline execution.

Reimplemented from vtkDataSetAlgorithm.

int vtkBinCellDataFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

This happens during the second pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

Member Data Documentation

vtkTypeBool vtkBinCellDataFilter::SpatialMatch
protected

Definition at line 190 of file vtkBinCellDataFilter.h.

bool vtkBinCellDataFilter::StoreNumberOfNonzeroBins
protected

Definition at line 192 of file vtkBinCellDataFilter.h.

double vtkBinCellDataFilter::Tolerance
protected

Definition at line 193 of file vtkBinCellDataFilter.h.

bool vtkBinCellDataFilter::ComputeTolerance
protected

Definition at line 194 of file vtkBinCellDataFilter.h.

int vtkBinCellDataFilter::ArrayComponent
protected

Definition at line 195 of file vtkBinCellDataFilter.h.

int vtkBinCellDataFilter::CellOverlapMethod
protected

Definition at line 196 of file vtkBinCellDataFilter.h.

vtkBinValues* vtkBinCellDataFilter::BinValues
protected

Definition at line 198 of file vtkBinCellDataFilter.h.

vtkAbstractCellLocator* vtkBinCellDataFilter::CellLocator
protected

Definition at line 199 of file vtkBinCellDataFilter.h.

char* vtkBinCellDataFilter::NumberOfNonzeroBinsArrayName
protected

Definition at line 209 of file vtkBinCellDataFilter.h.


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