VTK
9.1.0
|
dynamic, self-adjusting array of bits More...
#include <vtkBitArray.h>
Public Types | |
enum | DeleteMethod { VTK_DATA_ARRAY_FREE = vtkAbstractArray::VTK_DATA_ARRAY_FREE , VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE , VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE , VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED } |
typedef vtkDataArray | Superclass |
Public Types inherited from vtkDataArray | |
typedef vtkAbstractArray | Superclass |
Public Types inherited from vtkAbstractArray | |
enum | DeleteMethod { VTK_DATA_ARRAY_FREE , VTK_DATA_ARRAY_DELETE , VTK_DATA_ARRAY_ALIGNED_FREE , VTK_DATA_ARRAY_USER_DEFINED } |
enum | { MAX_DISCRETE_VALUES = 32 } |
enum | { AbstractArray = 0 , DataArray , AoSDataArrayTemplate , SoADataArrayTemplate , TypedDataArray , MappedDataArray , ScaleSoADataArrayTemplate , DataArrayTemplate = AoSDataArrayTemplate } |
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. | |
vtkBitArray * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
vtkTypeBool | Allocate (vtkIdType sz, vtkIdType ext=1000) override |
Allocate memory for this array. | |
void | Initialize () override |
Release storage and reset array to initial state. | |
int | GetDataType () const override |
Return the underlying data type. | |
int | GetDataTypeSize () const override |
Return the size of the underlying data type. | |
void | SetNumberOfTuples (vtkIdType number) override |
Set the number of n-tuples in the array. | |
bool | SetNumberOfValues (vtkIdType number) override |
In addition to setting the number of values, this method also sets the unused bits of the last byte of the array. | |
void | SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override |
Set the tuple at the ith location using the jth tuple in the source array. | |
void | InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override |
Insert the jth tuple in the source array, at ith location in this array. | |
void | InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override |
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. | |
void | InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override |
Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. | |
vtkIdType | InsertNextTuple (vtkIdType j, vtkAbstractArray *source) override |
Insert the jth tuple in the source array, at the end in this array. | |
double * | GetTuple (vtkIdType i) override |
Get a pointer to a tuple at the ith location. | |
void | GetTuple (vtkIdType i, double *tuple) override |
Copy the tuple value into a user-provided array. | |
void | SetComponent (vtkIdType i, int j, double c) override |
Set the data component at the ith tuple and jth component location. | |
void | Squeeze () override |
Free any unneeded memory. | |
vtkTypeBool | Resize (vtkIdType numTuples) override |
Resize the array while conserving the data. | |
int | GetValue (vtkIdType id) const |
Get the data at a particular index. | |
void | SetValue (vtkIdType id, int value) |
Set the data at a particular index. | |
void | InsertValue (vtkIdType id, int i) |
Inserts values and checks to make sure there is enough memory. | |
void | SetVariantValue (vtkIdType idx, vtkVariant value) override |
Set a value in the array from a variant. | |
void | InsertVariantValue (vtkIdType idx, vtkVariant value) override |
Inserts values from a variant and checks to ensure there is enough memory. | |
vtkIdType | InsertNextValue (int i) |
void | InsertComponent (vtkIdType i, int j, double c) override |
Insert the data component at ith tuple and jth component location. | |
unsigned char * | GetPointer (vtkIdType id) |
Direct manipulation of the underlying data. | |
unsigned char * | WritePointer (vtkIdType id, vtkIdType number) |
Get the address of a particular data index. | |
void * | WriteVoidPointer (vtkIdType id, vtkIdType number) override |
Get the address of a particular data index. | |
void * | GetVoidPointer (vtkIdType id) override |
Return a void pointer. | |
void | DeepCopy (vtkDataArray *da) override |
Deep copy of another bit array. | |
void | DeepCopy (vtkAbstractArray *aa) override |
Deep copy of data. | |
void | SetArrayFreeFunction (void(*callback)(void *)) override |
This method allows the user to specify a custom free function to be called when the array is deallocated. | |
vtkArrayIterator * | NewIterator () override |
Returns a new vtkBitArrayIterator instance. | |
void | DataChanged () override |
Tell the array explicitly that the data has changed. | |
void | ClearLookup () override |
Delete the associated fast lookup data structure on this array, if it exists. | |
void | SetTuple (vtkIdType i, const float *tuple) override |
Set the tuple value at the ith location in the array. | |
void | SetTuple (vtkIdType i, const double *tuple) override |
Set the tuple value at the ith location in the array. | |
void | InsertTuple (vtkIdType i, const float *tuple) override |
Insert (memory allocation performed) the tuple into the ith location in the array. | |
void | InsertTuple (vtkIdType i, const double *tuple) override |
Insert (memory allocation performed) the tuple into the ith location in the array. | |
vtkIdType | InsertNextTuple (const float *tuple) override |
Insert (memory allocation performed) the tuple onto the end of the array. | |
vtkIdType | InsertNextTuple (const double *tuple) override |
Insert (memory allocation performed) the tuple onto the end of the array. | |
void | RemoveTuple (vtkIdType id) override |
These methods remove tuples from the data array. | |
void | RemoveFirstTuple () override |
These methods remove tuples from the data array. | |
void | RemoveLastTuple () override |
These methods remove tuples from the data array. | |
void | SetArray (unsigned char *array, vtkIdType size, int save, int deleteMethod=VTK_DATA_ARRAY_DELETE) |
This method lets the user specify data to be held by the array. | |
void | SetVoidArray (void *array, vtkIdType size, int save) override |
This method lets the user specify data to be held by the array. | |
void | SetVoidArray (void *array, vtkIdType size, int save, int deleteMethod) override |
This method lets the user specify data to be held by the array. | |
vtkIdType | LookupValue (vtkVariant value) override |
Return the indices where a specific value appears. | |
void | LookupValue (vtkVariant value, vtkIdList *ids) override |
Return the indices where a specific value appears. | |
vtkIdType | LookupValue (int value) |
Return the indices where a specific value appears. | |
void | LookupValue (int value, vtkIdList *ids) |
Return the indices where a specific value appears. | |
Public Member Functions inherited from vtkDataArray | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkDataArray * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
int | IsNumeric () const override |
This method is here to make backward compatibility easier. | |
int | GetElementComponentSize () const override |
Return the size, in bytes, of the lowest-level element of an array. | |
void | InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. | |
vtkIdType | InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
Insert the tuple from srcTupleIdx in the source array at the end of this array. | |
void | InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override |
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. | |
void | InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override |
Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. | |
void | GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output) override |
Given a list of tuple ids, return an array of tuples. | |
void | GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override |
Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). | |
void | InterpolateTuple (vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override |
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. | |
void | InterpolateTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t) override |
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t. | |
virtual double * | GetTuple (vtkIdType tupleIdx)=0 |
Get the data tuple at tupleIdx. | |
virtual void | GetTuple (vtkIdType tupleIdx, double *tuple)=0 |
Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned. | |
void | SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override |
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. | |
virtual double | GetComponent (vtkIdType tupleIdx, int compIdx) |
Return the data component at the location specified by tupleIdx and compIdx. | |
virtual void | SetComponent (vtkIdType tupleIdx, int compIdx, double value) |
Set the data component at the location specified by tupleIdx and compIdx to value. | |
virtual void | InsertComponent (vtkIdType tupleIdx, int compIdx, double value) |
Insert value at the location specified by tupleIdx and compIdx. | |
virtual void | GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray *data) |
Get the data as a double array in the range (tupleMin,tupleMax) and (compMin, compMax). | |
virtual void | ShallowCopy (vtkDataArray *other) |
Create a shallow copy of other into this, if possible. | |
virtual void | FillComponent (int compIdx, double value) |
Fill a component of a data array with a specified value. | |
virtual void | Fill (double value) |
Fill all values of a data array with a specified value. | |
virtual void | CopyComponent (int dstComponent, vtkDataArray *src, int srcComponent) |
Copy a component from one data array into a component on this data array. | |
virtual void * | WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues)=0 |
Get the address of a particular data index. | |
unsigned long | GetActualMemorySize () const override |
Return the memory in kibibytes (1024 bytes) consumed by this data array. | |
void | CreateDefaultLookupTable () |
Create default lookup table. | |
void | GetRange (double range[2], int comp) |
The range of the data array values for the given component will be returned in the provided range array argument. | |
double * | GetRange () |
Return the range of the data array. | |
void | GetRange (double range[2]) |
The range of the data array values will be returned in the provided range array argument. | |
void | GetFiniteRange (double range[2], int comp) |
The range of the data array values for the given component will be returned in the provided range array argument. | |
double * | GetFiniteRange () |
Return the range of the data array. | |
void | GetFiniteRange (double range[2]) |
The range of the data array values will be returned in the provided range array argument. | |
virtual double | GetMaxNorm () |
Return the maximum norm for the tuples. | |
void | Modified () override |
Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values. | |
int | CopyInformation (vtkInformation *infoFrom, int deep=1) override |
Copy information instance. | |
int | GetArrayType () const override |
Method for type-checking in FastDownCast implementations. | |
double | GetTuple1 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
double * | GetTuple2 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
double * | GetTuple3 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
double * | GetTuple4 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
double * | GetTuple6 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
double * | GetTuple9 (vtkIdType tupleIdx) |
These methods are included as convenience for the wrappers. | |
void | SetTuple1 (vtkIdType tupleIdx, double value) |
These methods are included as convenience for the wrappers. | |
void | SetTuple2 (vtkIdType tupleIdx, double val0, double val1) |
These methods are included as convenience for the wrappers. | |
void | SetTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2) |
These methods are included as convenience for the wrappers. | |
void | SetTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3) |
These methods are included as convenience for the wrappers. | |
void | SetTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5) |
These methods are included as convenience for the wrappers. | |
void | SetTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple1 (vtkIdType tupleIdx, double value) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple2 (vtkIdType tupleIdx, double val0, double val1) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5) |
These methods are included as convenience for the wrappers. | |
void | InsertTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple1 (double value) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple2 (double val0, double val1) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple3 (double val0, double val1, double val2) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple4 (double val0, double val1, double val2, double val3) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple6 (double val0, double val1, double val2, double val3, double val4, double val5) |
These methods are included as convenience for the wrappers. | |
void | InsertNextTuple9 (double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8) |
These methods are included as convenience for the wrappers. | |
void | DeepCopy (vtkAbstractArray *aa) override |
Deep copy of data. | |
void | SetLookupTable (vtkLookupTable *lut) |
Set/get the lookup table associated with this scalar data, if any. | |
virtual vtkLookupTable * | GetLookupTable () |
Set/get the lookup table associated with this scalar data, if any. | |
double * | GetRange (int comp) |
Return the range of the data array values for the given component. | |
double * | GetFiniteRange (int comp) |
Return the range of the data array values for the given component. | |
void | GetDataTypeRange (double range[2]) |
These methods return the Min and Max possible range of the native data type. | |
double | GetDataTypeMin () |
These methods return the Min and Max possible range of the native data type. | |
double | GetDataTypeMax () |
These methods return the Min and Max possible range of the native data type. | |
Public Member Functions inherited from vtkAbstractArray | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkAbstractArray * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual vtkTypeBool | Allocate (vtkIdType numValues, vtkIdType ext=1000)=0 |
Allocate memory for this array. | |
virtual void | Initialize ()=0 |
Release storage and reset array to initial state. | |
virtual int | GetDataType () const =0 |
Return the underlying data type. | |
virtual int | GetElementComponentSize () const =0 |
Return the size, in bytes, of the lowest-level element of an array. | |
void | SetComponentName (vtkIdType component, const char *name) |
Set the name for a component. | |
const char * | GetComponentName (vtkIdType component) const |
Get the component name for a given component. | |
bool | HasAComponentName () const |
Returns if any component has had a name assigned. | |
int | CopyComponentNames (vtkAbstractArray *da) |
Copies the component names from the inputed array to the current array make sure that the current array has the same number of components as the input array. | |
virtual void | SetNumberOfTuples (vtkIdType numTuples)=0 |
Set the number of tuples (a component group) in the array. | |
virtual bool | SetNumberOfValues (vtkIdType numValues) |
Specify the number of values (tuples * components) for this object to hold. | |
vtkIdType | GetNumberOfTuples () const |
Get the number of complete tuples (a component group) in the array. | |
vtkIdType | GetNumberOfValues () const |
Get the total number of values in the array. | |
virtual void | SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0 |
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. | |
virtual void | InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0 |
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. | |
virtual void | InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source)=0 |
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. | |
virtual void | InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)=0 |
Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. | |
virtual vtkIdType | InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source)=0 |
Insert the tuple from srcTupleIdx in the source array at the end of this array. | |
virtual void | GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output) |
Given a list of tuple ids, return an array of tuples. | |
virtual void | GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) |
Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). | |
virtual bool | HasStandardMemoryLayout () const |
Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. | |
virtual void * | GetVoidPointer (vtkIdType valueIdx)=0 |
Return a void pointer. | |
virtual void | DeepCopy (vtkAbstractArray *da) |
Deep copy of data. | |
virtual void | InterpolateTuple (vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights)=0 |
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. | |
virtual void | InterpolateTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t)=0 |
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t. | |
virtual void | Squeeze ()=0 |
Free any unnecessary memory. | |
virtual vtkTypeBool | Resize (vtkIdType numTuples)=0 |
Resize the array to the requested number of tuples and preserve data. | |
vtkIdType | GetSize () const |
Return the size of the data. | |
vtkIdType | GetMaxId () const |
What is the maximum id currently in the array. | |
virtual void | SetArrayFreeFunction (void(*callback)(void *))=0 |
This method allows the user to specify a custom free function to be called when the array is deallocated. | |
virtual void | ExportToVoidPointer (void *out_ptr) |
This method copies the array data to the void pointer specified by the user. | |
virtual unsigned long | GetActualMemorySize () const =0 |
Return the memory in kibibytes (1024 bytes) consumed by this data array. | |
virtual const char * | GetDataTypeAsString (void) const |
Get the name of a data type as a string. | |
virtual int | IsNumeric () const =0 |
This method is here to make backward compatibility easier. | |
virtual vtkArrayIterator * | NewIterator ()=0 |
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. | |
virtual vtkIdType | GetDataSize () const |
Returns the size of the data in DataTypeSize units. | |
virtual vtkVariant | GetVariantValue (vtkIdType valueIdx) |
Retrieve value from the array as a variant. | |
virtual void | InsertVariantValue (vtkIdType valueIdx, vtkVariant value)=0 |
Insert a value into the array from a variant. | |
virtual void | SetVariantValue (vtkIdType valueIdx, vtkVariant value)=0 |
Set a value in the array from a variant. | |
virtual void | DataChanged ()=0 |
Tell the array explicitly that the data has changed. | |
virtual void | ClearLookup ()=0 |
Delete the associated fast lookup data structure on this array, if it exists. | |
virtual void | GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3) |
Populate the given vtkVariantArray with a set of distinct values taken on by the requested component (or, when passed -1, by the tuples as a whole). | |
vtkInformation * | GetInformation () |
Get an information object that can be used to annotate the array. | |
bool | HasInformation () const |
Inquire if this array has an instance of vtkInformation already associated with it. | |
virtual int | CopyInformation (vtkInformation *infoFrom, int deep=1) |
Copy information instance. | |
void | Modified () override |
Removes out-of-date PER_COMPONENT() and PER_FINITE_COMPONENT() values. | |
virtual int | GetArrayType () const |
Method for type-checking in FastDownCast implementations. | |
virtual void | SetNumberOfComponents (int) |
Set/Get the dimension (n) of the components. | |
int | GetNumberOfComponents () const |
Set/Get the dimension (n) of the components. | |
void | Reset () |
Reset to an empty state, without freeing any memory. | |
virtual void | SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0 |
This method lets the user specify data to be held by the array. | |
virtual void | SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) |
This method lets the user specify data to be held by the array. | |
virtual void | SetName (const char *) |
Set/get array's name. | |
virtual char * | GetName () |
Set/get array's name. | |
virtual unsigned int | GetMaxDiscreteValues () |
Get/Set the maximum number of prominent values this array may contain before it is considered continuous. | |
virtual void | SetMaxDiscreteValues (unsigned int) |
Get/Set the maximum number of prominent values this array may contain before it is considered continuous. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkBitArray * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkBitArray * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkDataArray | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataArray * | SafeDownCast (vtkObjectBase *o) |
static vtkDataArray * | FastDownCast (vtkAbstractArray *source) |
Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray. | |
static vtkDataArray * | CreateDataArray (int dataType) |
Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_SIGNED_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_FLOAT, VTK_DOUBLE, VTK_ID_TYPE. | |
static vtkInformationDoubleVectorKey * | COMPONENT_RANGE () |
This key is used to hold tight bounds on the range of one component over all tuples of the array. | |
static vtkInformationDoubleVectorKey * | L2_NORM_RANGE () |
This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. | |
static vtkInformationDoubleVectorKey * | L2_NORM_FINITE_RANGE () |
This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. | |
static vtkInformationStringKey * | UNITS_LABEL () |
A human-readable string indicating the units for the array data. | |
static void | GetDataTypeRange (int type, double range[2]) |
These methods return the Min and Max possible range of the native data type. | |
static double | GetDataTypeMin (int type) |
These methods return the Min and Max possible range of the native data type. | |
static double | GetDataTypeMax (int type) |
These methods return the Min and Max possible range of the native data type. | |
Static Public Member Functions inherited from vtkAbstractArray | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractArray * | SafeDownCast (vtkObjectBase *o) |
static vtkAbstractArray * | CreateArray (int dataType) |
Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE, VTK_STRING. | |
static vtkInformationIntegerKey * | GUI_HIDE () |
This key is a hint to end user interface that this array is internal and should not be shown to the end user. | |
static vtkInformationInformationVectorKey * | PER_COMPONENT () |
This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. | |
static vtkInformationInformationVectorKey * | PER_FINITE_COMPONENT () |
This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. | |
static vtkInformationVariantVectorKey * | DISCRETE_VALUES () |
A key used to hold discrete values taken on either by the tuples of the array (when present in this->GetInformation()) or individual components (when present in one entry of the PER_COMPONENT() information vector). | |
static vtkInformationDoubleVectorKey * | DISCRETE_VALUE_SAMPLE_PARAMETERS () |
A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. | |
static int | GetDataTypeSize (int type) |
Return the size of the underlying data type. | |
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. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkBitArray () | |
~vtkBitArray () override | |
virtual void | InitializeUnusedBitsInLastByte () |
This method should be called whenever MaxId needs to be changed, as this method fills the unused bits of the last byte to zero. | |
unsigned char * | ResizeAndExtend (vtkIdType sz) |
Protected Member Functions inherited from vtkDataArray | |
virtual vtkObjectBase * | NewInstanceInternal () const |
virtual void | ComputeRange (double range[2], int comp) |
Compute the range for a specific component. | |
virtual void | ComputeFiniteRange (double range[2], int comp) |
Compute the range for a specific component. | |
virtual bool | ComputeScalarRange (double *ranges) |
Computes the range for each component of an array, the length of ranges must be two times the number of components. | |
virtual bool | ComputeVectorRange (double range[2]) |
Returns true if the range was computed. | |
virtual bool | ComputeFiniteScalarRange (double *ranges) |
Computes the range for each component of an array, the length of ranges must be two times the number of components. | |
virtual bool | ComputeFiniteVectorRange (double range[2]) |
Returns true if the range was computed. | |
vtkDataArray () | |
~vtkDataArray () override | |
Protected Member Functions inherited from vtkAbstractArray | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkAbstractArray () | |
~vtkAbstractArray () override | |
virtual void | SetInformation (vtkInformation *) |
Set an information object that can be used to annotate the array. | |
virtual void | UpdateDiscreteValueSet (double uncertainty, double minProminence) |
Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
unsigned char * | Array |
int | TupleSize |
double * | Tuple |
void(* | DeleteFunction )(void *) |
Protected Attributes inherited from vtkDataArray | |
vtkLookupTable * | LookupTable |
double | Range [2] |
double | FiniteRange [2] |
Protected Attributes inherited from vtkAbstractArray | |
vtkIdType | Size |
vtkIdType | MaxId |
int | NumberOfComponents |
unsigned int | MaxDiscreteValues |
char * | Name |
bool | RebuildArray |
vtkInformation * | Information |
vtkInternalComponentNames * | ComponentNames |
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 () |
dynamic, self-adjusting array of bits
vtkBitArray is an array of bits (0/1 data value). The array is packed so that each byte stores eight bits. vtkBitArray provides methods for insertion and retrieval of bits, and will automatically resize itself to hold new data.
Definition at line 33 of file vtkBitArray.h.
typedef vtkDataArray vtkBitArray::Superclass |
Definition at line 45 of file vtkBitArray.h.
Enumerator | |
---|---|
VTK_DATA_ARRAY_FREE | |
VTK_DATA_ARRAY_DELETE | |
VTK_DATA_ARRAY_ALIGNED_FREE | |
VTK_DATA_ARRAY_USER_DEFINED |
Definition at line 36 of file vtkBitArray.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkDataArray.
|
static |
|
protectedvirtual |
Reimplemented from vtkDataArray.
vtkBitArray * vtkBitArray::NewInstance | ( | ) | const |
|
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 vtkAbstractArray.
|
overridevirtual |
Allocate memory for this array.
Delete old storage only if necessary. Note that ext is no longer used.
Implements vtkAbstractArray.
|
overridevirtual |
Release storage and reset array to initial state.
Implements vtkAbstractArray.
|
inlineoverridevirtual |
Return the underlying data type.
An integer indicating data type is returned as specified in vtkType.h.
Implements vtkAbstractArray.
Definition at line 60 of file vtkBitArray.h.
|
inlineoverridevirtual |
Return the size of the underlying data type.
For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.
Implements vtkAbstractArray.
Definition at line 61 of file vtkBitArray.h.
|
overridevirtual |
Set the number of n-tuples in the array.
Implements vtkAbstractArray.
|
overridevirtual |
In addition to setting the number of values, this method also sets the unused bits of the last byte of the array.
Reimplemented from vtkAbstractArray.
|
overridevirtual |
Set the tuple at the ith location using the jth tuple in the source array.
This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.
Implements vtkAbstractArray.
|
overridevirtual |
Insert the jth tuple in the source array, at ith location in this array.
Note that memory allocation is performed as necessary to hold the data.
Implements vtkAbstractArray.
|
overridevirtual |
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.
Note that memory allocation is performed as necessary to hold the data.
Implements vtkAbstractArray.
|
overridevirtual |
Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location.
Note that memory allocation is performed as necessary to hold the data.
Implements vtkAbstractArray.
|
overridevirtual |
Insert the jth tuple in the source array, at the end in this array.
Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.
Implements vtkAbstractArray.
|
overridevirtual |
Get a pointer to a tuple at the ith location.
This is a dangerous method (it is not thread safe since a pointer is returned).
Implements vtkDataArray.
|
overridevirtual |
Copy the tuple value into a user-provided array.
Implements vtkDataArray.
|
overridevirtual |
Set the tuple value at the ith location in the array.
Reimplemented from vtkDataArray.
|
overridevirtual |
Set the tuple value at the ith location in the array.
Reimplemented from vtkDataArray.
|
overridevirtual |
Insert (memory allocation performed) the tuple into the ith location in the array.
Implements vtkDataArray.
|
overridevirtual |
Insert (memory allocation performed) the tuple into the ith location in the array.
Implements vtkDataArray.
|
overridevirtual |
Insert (memory allocation performed) the tuple onto the end of the array.
Implements vtkDataArray.
|
overridevirtual |
Insert (memory allocation performed) the tuple onto the end of the array.
Implements vtkDataArray.
|
overridevirtual |
These methods remove tuples from the data array.
They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Implements vtkDataArray.
|
overridevirtual |
These methods remove tuples from the data array.
They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Reimplemented from vtkDataArray.
|
overridevirtual |
These methods remove tuples from the data array.
They shift data and resize array, so the data array is still valid after this operation. Note, this operation is fairly slow.
Reimplemented from vtkDataArray.
|
overridevirtual |
Set the data component at the ith tuple and jth component location.
Note that i is less then NumberOfTuples and j is less then NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).
Reimplemented from vtkDataArray.
|
inlineoverridevirtual |
Free any unneeded memory.
Implements vtkAbstractArray.
Definition at line 383 of file vtkBitArray.h.
|
overridevirtual |
Resize the array while conserving the data.
Implements vtkAbstractArray.
int vtkBitArray::GetValue | ( | vtkIdType | id | ) | const |
Get the data at a particular index.
|
inline |
Set the data at a particular index.
Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
Definition at line 338 of file vtkBitArray.h.
|
inline |
Inserts values and checks to make sure there is enough memory.
Definition at line 346 of file vtkBitArray.h.
|
inlineoverridevirtual |
Set a value in the array from a variant.
Implements vtkAbstractArray.
Definition at line 366 of file vtkBitArray.h.
|
inlineoverridevirtual |
Inserts values from a variant and checks to ensure there is enough memory.
Implements vtkAbstractArray.
Definition at line 371 of file vtkBitArray.h.
|
inline |
Definition at line 376 of file vtkBitArray.h.
|
overridevirtual |
Insert the data component at ith tuple and jth component location.
Note that memory allocation is performed as necessary to hold the data.
Reimplemented from vtkDataArray.
|
inline |
Direct manipulation of the underlying data.
Definition at line 212 of file vtkBitArray.h.
Get the address of a particular data index.
Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.
|
inlineoverridevirtual |
Get the address of a particular data index.
Make sure data is allocated for the number of items requested. If needed, increase MaxId to mark any new value ranges as in-use.
Implements vtkDataArray.
Definition at line 221 of file vtkBitArray.h.
|
inlineoverridevirtual |
Return a void pointer.
For image pipeline interface and other special pointer manipulation. Use of this method is discouraged, as newer arrays require a deep-copy of the array data in order to return a suitable pointer. See vtkArrayDispatch for a safer alternative for fast data access.
Implements vtkAbstractArray.
Definition at line 226 of file vtkBitArray.h.
|
overridevirtual |
Deep copy of another bit array.
Reimplemented from vtkDataArray.
|
inlineoverridevirtual |
Deep copy of data.
Implementation left to subclasses, which should support as many type conversions as possible given the data type.
Subclasses should call vtkAbstractArray::DeepCopy() so that the information object (if one exists) is copied from da.
Reimplemented from vtkAbstractArray.
Definition at line 232 of file vtkBitArray.h.
void vtkBitArray::SetArray | ( | unsigned char * | array, |
vtkIdType | size, | ||
int | save, | ||
int | deleteMethod = VTK_DATA_ARRAY_DELETE |
||
) |
This method lets the user specify data to be held by the array.
The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array. If the delete method is VTK_DATA_ARRAY_USER_DEFINED a custom free function can be assigned to be called using SetArrayFreeFunction, if no custom function is assigned we will default to delete[].
|
inlineoverride |
This method lets the user specify data to be held by the array.
The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array. If the delete method is VTK_DATA_ARRAY_USER_DEFINED a custom free function can be assigned to be called using SetArrayFreeFunction, if no custom function is assigned we will default to delete[].
Definition at line 250 of file vtkBitArray.h.
|
inlineoverride |
This method lets the user specify data to be held by the array.
The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array. If the delete method is VTK_DATA_ARRAY_USER_DEFINED a custom free function can be assigned to be called using SetArrayFreeFunction, if no custom function is assigned we will default to delete[].
Definition at line 254 of file vtkBitArray.h.
|
overridevirtual |
This method allows the user to specify a custom free function to be called when the array is deallocated.
Calling this method will implicitly mean that the given free function will be called when the class cleans up or reallocates memory.
Implements vtkAbstractArray.
|
overridevirtual |
Returns a new vtkBitArrayIterator instance.
Implements vtkAbstractArray.
|
overridevirtual |
Return the indices where a specific value appears.
Implements vtkAbstractArray.
|
overridevirtual |
Return the indices where a specific value appears.
Implements vtkAbstractArray.
vtkIdType vtkBitArray::LookupValue | ( | int | value | ) |
Return the indices where a specific value appears.
void vtkBitArray::LookupValue | ( | int | value, |
vtkIdList * | ids | ||
) |
Return the indices where a specific value appears.
|
overridevirtual |
Tell the array explicitly that the data has changed.
This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.
Implements vtkAbstractArray.
|
overridevirtual |
Delete the associated fast lookup data structure on this array, if it exists.
The lookup will be rebuilt on the next call to a lookup function.
Implements vtkAbstractArray.
|
protectedvirtual |
This method should be called whenever MaxId needs to be changed, as this method fills the unused bits of the last byte to zero.
If those bits are kept uninitialized, one can trigger errors when reading the last byte.
this->MaxId < 0
. In this instance, nothing happens.this->Array
needs to already be allocated prior to calling this method.
|
protected |
|
protected |
Definition at line 317 of file vtkBitArray.h.
|
protected |
Definition at line 321 of file vtkBitArray.h.
|
protected |
Definition at line 322 of file vtkBitArray.h.
|
protected |
Definition at line 324 of file vtkBitArray.h.