dynamic, self-adjusting array of bits More...

#include <vtkBitArray.h>

Inheritance diagram for vtkBitArray:

Collaboration diagram for vtkBitArray:

Public Types
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 }

enum	{ MAX_DISCRETE_VALUES = 32 }

enum	{ AbstractArray = 0, DataArray, AoSDataArrayTemplate, SoADataArrayTemplate, TypedDataArray, MappedDataArray, DataArrayTemplate = AoSDataArrayTemplate }

typedef vtkObject	Superclass

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

vtkBitArray *	NewInstance () const

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

int	Allocate (vtkIdType sz, vtkIdType ext=1000) override
	Allocate memory for this array. More...

void	Initialize () override
	Release storage and reset array to initial state. More...

int	GetDataType () override
	Return the underlying data type. More...

int	GetDataTypeSize () override
	Return the size of the underlying data type. More...

void	SetNumberOfTuples (vtkIdType number) override
	Set the number of n-tuples in the array. More...

void	SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
	Set the tuple at the ith location using the jth tuple in the source array. More...

void	InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
	Insert the jth tuple in the source array, at ith location in this array. More...

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

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

vtkIdType	InsertNextTuple (vtkIdType j, vtkAbstractArray *source) override
	Insert the jth tuple in the source array, at the end in this array. More...

double *	GetTuple (vtkIdType i) override
	Get a pointer to a tuple at the ith location. More...

void	GetTuple (vtkIdType i, double *tuple) override
	Copy the tuple value into a user-provided array. More...

void	SetComponent (vtkIdType i, int j, double c) override
	Set the data component at the ith tuple and jth component location. More...

void	Squeeze () override
	Free any unneeded memory. More...

int	Resize (vtkIdType numTuples) override
	Resize the array while conserving the data. More...

int	GetValue (vtkIdType id)
	Get the data at a particular index. More...

void	SetNumberOfValues (vtkIdType number) override
	Fast method based setting of values without memory checks. More...

void	SetValue (vtkIdType id, int value)
	Set the data at a particular index. More...

void	InsertValue (vtkIdType id, int i)
	Inserts values and checks to make sure there is enough memory. More...

void	SetVariantValue (vtkIdType idx, vtkVariant value) override
	Set a value in the array from a variant. More...

void	InsertVariantValue (vtkIdType idx, vtkVariant value) override
	Inserts values from a variant and checks to ensure there is enough memory. More...

vtkIdType	InsertNextValue (int i)

void	InsertComponent (vtkIdType i, int j, double c) override
	Insert the data component at ith tuple and jth component location. More...

unsigned char *	GetPointer (vtkIdType id)
	Direct manipulation of the underlying data. More...

unsigned char *	WritePointer (vtkIdType id, vtkIdType number)
	Get the address of a particular data index. More...

void *	WriteVoidPointer (vtkIdType id, vtkIdType number) override
	Get the address of a particular data index. More...

void *	GetVoidPointer (vtkIdType id) override
	Return a void pointer. More...

void	DeepCopy (vtkDataArray *da) override
	Deep copy of another bit array. More...

void	DeepCopy (vtkAbstractArray *aa) override
	Deep copy of data. More...

VTK_NEWINSTANCE vtkArrayIterator *	NewIterator () override
	Returns a new vtkBitArrayIterator instance. More...

void	DataChanged () override
	Tell the array explicitly that the data has changed. More...

void	ClearLookup () override
	Delete the associated fast lookup data structure on this array, if it exists. More...


void	SetTuple (vtkIdType i, const float *tuple) override
	Set the tuple value at the ith location in the array. More...

void	SetTuple (vtkIdType i, const double *tuple) override
	Set the tuple value at the ith location in the array. More...


void	InsertTuple (vtkIdType i, const float *tuple) override
	Insert (memory allocation performed) the tuple into the ith location in the array. More...

void	InsertTuple (vtkIdType i, const double *tuple) override
	Insert (memory allocation performed) the tuple into the ith location in the array. More...


vtkIdType	InsertNextTuple (const float *tuple) override
	Insert (memory allocation performed) the tuple onto the end of the array. More...

vtkIdType	InsertNextTuple (const double *tuple) override
	Insert (memory allocation performed) the tuple onto the end of the array. More...


void	RemoveTuple (vtkIdType id) override
	These methods remove tuples from the data array. More...

void	RemoveFirstTuple () override
	These methods remove tuples from the data array. More...

void	RemoveLastTuple () override
	These methods remove tuples from the data array. More...


void	SetArray (unsigned char *array, vtkIdType size, int save)
	This method lets the user specify data to be held by the array. More...

void	SetVoidArray (void *array, vtkIdType size, int save) override
	This method lets the user specify data to be held by the array. More...

void	SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod)) override
	This method lets the user specify data to be held by the array. More...


vtkIdType	LookupValue (vtkVariant value) override
	Return the indices where a specific value appears. More...

void	LookupValue (vtkVariant value, vtkIdList *ids) override
	Return the indices where a specific value appears. More...

vtkIdType	LookupValue (int value)
	Return the indices where a specific value appears. More...

void	LookupValue (int value, vtkIdList *ids)
	Return the indices where a specific value appears. More...

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

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

int	IsNumeric () override
	This method is here to make backward compatibility easier. More...

int	GetElementComponentSize () override
	Return the size, in bytes, of the lowest-level element of an array. More...

void	InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
	Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...

vtkIdType	InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override
	Insert the tuple from srcTupleIdx in the source array at the end of this array. More...

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

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

void	GetTuples (vtkIdList tupleIds, vtkAbstractArray output) override
	Given a list of tuple ids, return an array of tuples. More...

void	GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
	Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More...

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

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

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

virtual double	GetComponent (vtkIdType tupleIdx, int compIdx)
	Return the data component at the location specified by tupleIdx and compIdx. More...

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

virtual void	ShallowCopy (vtkDataArray *other)
	Create a shallow copy of other into this, if possible. More...

virtual void	FillComponent (int compIdx, double value)
	Fill a component of a data array with a specified value. More...

virtual void	CopyComponent (int dstComponent, vtkDataArray *src, int srcComponent)
	Copy a component from one data array into a component on this data array. More...

unsigned long	GetActualMemorySize () override
	Return the memory in kibibytes (1024 bytes) consumed by this data array. More...

void	CreateDefaultLookupTable ()
	Create default lookup table. More...

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

double *	GetRange ()
	Return the range of the data array. More...

void	GetRange (double range[2])
	The the range of the data array values will be returned in the provided range array argument. More...

virtual double	GetMaxNorm ()
	Return the maximum norm for the tuples. More...

int	CopyInformation (vtkInformation *infoFrom, int deep=1) override
	Copy information instance. More...

int	GetArrayType () override
	Method for type-checking in FastDownCast implementations. More...

double	GetTuple1 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

double *	GetTuple2 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

double *	GetTuple3 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

double *	GetTuple4 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

double *	GetTuple6 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

double *	GetTuple9 (vtkIdType tupleIdx)
	These methods are included as convenience for the wrappers. More...

void	SetTuple1 (vtkIdType tupleIdx, double value)
	These methods are included as convenience for the wrappers. More...

void	SetTuple2 (vtkIdType tupleIdx, double val0, double val1)
	These methods are included as convenience for the wrappers. More...

void	SetTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
	These methods are included as convenience for the wrappers. More...

void	SetTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
	These methods are included as convenience for the wrappers. More...

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

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

void	InsertTuple1 (vtkIdType tupleIdx, double value)
	These methods are included as convenience for the wrappers. More...

void	InsertTuple2 (vtkIdType tupleIdx, double val0, double val1)
	These methods are included as convenience for the wrappers. More...

void	InsertTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
	These methods are included as convenience for the wrappers. More...

void	InsertTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
	These methods are included as convenience for the wrappers. More...

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

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

void	InsertNextTuple1 (double value)
	These methods are included as convenience for the wrappers. More...

void	InsertNextTuple2 (double val0, double val1)
	These methods are included as convenience for the wrappers. More...

void	InsertNextTuple3 (double val0, double val1, double val2)
	These methods are included as convenience for the wrappers. More...

void	InsertNextTuple4 (double val0, double val1, double val2, double val3)
	These methods are included as convenience for the wrappers. More...

void	InsertNextTuple6 (double val0, double val1, double val2, double val3, double val4, double val5)
	These methods are included as convenience for the wrappers. More...

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

void	DeepCopy (vtkAbstractArray *aa) override
	Deep copy of data. More...

void	SetLookupTable (vtkLookupTable *lut)
	Set/get the lookup table associated with this scalar data, if any. More...

virtual vtkLookupTable *	GetLookupTable ()
	Set/get the lookup table associated with this scalar data, if any. More...

double *	GetRange (int comp)
	Return the range of the data array values for the given component. More...

void	GetDataTypeRange (double range[2])
	These methods return the Min and Max possible range of the native data type. More...

double	GetDataTypeMin ()
	These methods return the Min and Max possible range of the native data type. More...

double	GetDataTypeMax ()
	These methods return the Min and Max possible range of the native data type. More...

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

void	SetComponentName (vtkIdType component, const char *name)
	Set the name for a component. More...

const char *	GetComponentName (vtkIdType component)
	Get the component name for a given component. More...

bool	HasAComponentName ()
	Returns if any component has had a name assigned. More...

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

vtkIdType	GetNumberOfTuples ()
	Get the number of complete tuples (a component group) in the array. More...

vtkIdType	GetNumberOfValues () const
	Get the total number of values in the array. More...

virtual bool	HasStandardMemoryLayout ()
	Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...

vtkIdType	GetSize ()
	Return the size of the data. More...

vtkIdType	GetMaxId ()
	What is the maximum id currently in the array. More...

virtual void	ExportToVoidPointer (void *out_ptr)
	This method copies the array data to the void pointer specified by the user. More...

virtual const char *	GetDataTypeAsString (void)
	Get the name of a data type as a string. More...

virtual vtkIdType	GetDataSize ()
	Returns the size of the data in DataTypeSize units. More...

virtual vtkVariant	GetVariantValue (vtkIdType valueIdx)
	Retrieve value from the array as a variant. More...

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

vtkInformation *	GetInformation ()
	Get an information object that can be used to annotate the array. More...

bool	HasInformation ()
	Inquire if this array has an instance of vtkInformation already associated with it. More...

virtual void	SetNumberOfComponents (int)
	Set/Get the dimension (n) of the components. More...

int	GetNumberOfComponents ()
	Set/Get the dimension (n) of the components. More...

void	Reset ()
	Reset to an empty state, without freeing any memory. More...

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

virtual void	SetName (const char *)
	Set/get array's name. More...

virtual char *	GetName ()
	Set/get array's name. More...

virtual unsigned int	GetMaxDiscreteValues ()
	Get/Set the maximum number of prominent values this array may contain before it is considered continuous. More...

virtual void	SetMaxDiscreteValues (unsigned int)
	Get/Set the maximum number of prominent values this array may contain before it is considered continuous. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	InitializeObjectBase ()

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

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

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

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

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

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static vtkBitArray *	New ()

static int	IsTypeOf (const char *type)

static vtkBitArray *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkDataArray
static int	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. More...

static VTK_NEWINSTANCE 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_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE. More...

static vtkInformationDoubleVectorKey *	COMPONENT_RANGE ()
	This key is used to hold tight bounds on the range of one component over all tuples of the array. More...

static vtkInformationDoubleVectorKey *	L2_NORM_RANGE ()
	This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More...

static vtkInformationStringKey *	UNITS_LABEL ()
	A human-readable string indicating the units for the array data. More...

static void	GetDataTypeRange (int type, double range[2])
	These methods return the Min and Max possible range of the native data type. More...

static double	GetDataTypeMin (int type)
	These methods return the Min and Max possible range of the native data type. More...

static double	GetDataTypeMax (int type)
	These methods return the Min and Max possible range of the native data type. More...

Static Public Member Functions inherited from vtkAbstractArray
static int	IsTypeOf (const char *type)

static vtkAbstractArray *	SafeDownCast (vtkObjectBase *o)

static VTK_NEWINSTANCE 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. More...

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

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

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

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

static int	GetDataTypeSize (int type)
	Return the size of the underlying data type. More...

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

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

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

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

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

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

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBitArray ()

	~vtkBitArray () override

unsigned char *	ResizeAndExtend (vtkIdType sz)

Protected Member Functions inherited from vtkDataArray
virtual void	ComputeRange (double range[2], int comp)
	Compute the range for a specific component. More...

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

virtual bool	ComputeVectorRange (double range[2])

	vtkDataArray ()

	~vtkDataArray () override

Protected Member Functions inherited from vtkAbstractArray
	vtkAbstractArray ()

	~vtkAbstractArray () override

virtual void	SetInformation (vtkInformation *)
	Set an information object that can be used to annotate the array. More...

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. 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=NULL)
	These methods allow a command to exclusively grab all events. More...

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned char *	Array

int	TupleSize

double *	Tuple

int	SaveUserArray

Protected Attributes inherited from vtkDataArray
vtkLookupTable *	LookupTable

double	Range [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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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.

Tests:: vtkBitArray (Tests)

Definition at line 36 of file vtkBitArray.h.

Member Typedef Documentation

typedef vtkDataArray vtkBitArray::Superclass

Definition at line 40 of file vtkBitArray.h.

Constructor & Destructor Documentation

vtkBitArray::vtkBitArray ( )

protected

vtkBitArray::~vtkBitArray ( )

overrideprotected

Member Function Documentation

static vtkBitArray* vtkBitArray::New ( )

static

static int vtkBitArray::IsTypeOf ( const char * type )

static

virtual int vtkBitArray::IsA ( const char * name )

virtual

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

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

Reimplemented from vtkDataArray.

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

static

virtual vtkObjectBase* vtkBitArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataArray.

vtkBitArray* vtkBitArray::NewInstance ( ) const

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

overridevirtual

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

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

Reimplemented from vtkAbstractArray.

int vtkBitArray::Allocate	(	vtkIdType	sz,
		vtkIdType	ext = `1000`
	)

overridevirtual

Allocate memory for this array.

Delete old storage only if necessary. Note that ext is no longer used.

Implements vtkAbstractArray.

void vtkBitArray::Initialize ( )

overridevirtual

Release storage and reset array to initial state.

Implements vtkAbstractArray.

int vtkBitArray::GetDataType ( )

inlineoverridevirtual

Return the underlying data type.

An integer indicating data type is returned as specified in vtkSetGet.h.

Implements vtkAbstractArray.

Definition at line 55 of file vtkBitArray.h.

int vtkBitArray::GetDataTypeSize ( )

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 56 of file vtkBitArray.h.

void vtkBitArray::SetNumberOfTuples ( vtkIdType number )

overridevirtual

Set the number of n-tuples in the array.

Implements vtkAbstractArray.

void vtkBitArray::SetTuple	(	vtkIdType	i,
		vtkIdType	j,
		vtkAbstractArray *	source
	)

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.

void vtkBitArray::InsertTuple	(	vtkIdType	i,
		vtkIdType	j,
		vtkAbstractArray *	source
	)

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.

void vtkBitArray::InsertTuples	(	vtkIdList *	dstIds,
		vtkIdList *	srcIds,
		vtkAbstractArray *	source
	)

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.

void vtkBitArray::InsertTuples	(	vtkIdType	dstStart,
		vtkIdType	n,
		vtkIdType	srcStart,
		vtkAbstractArray *	source
	)

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.

vtkIdType vtkBitArray::InsertNextTuple	(	vtkIdType	j,
		vtkAbstractArray *	source
	)

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.

double* vtkBitArray::GetTuple ( vtkIdType i )

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.

void vtkBitArray::GetTuple	(	vtkIdType	i,
		double *	tuple
	)

overridevirtual

Copy the tuple value into a user-provided array.

Implements vtkDataArray.

void vtkBitArray::SetTuple	(	vtkIdType	i,
		const float *	tuple
	)

overridevirtual

Set the tuple value at the ith location in the array.

Reimplemented from vtkDataArray.

void vtkBitArray::SetTuple	(	vtkIdType	i,
		const double *	tuple
	)

overridevirtual

Set the tuple value at the ith location in the array.

Reimplemented from vtkDataArray.

void vtkBitArray::InsertTuple	(	vtkIdType	i,
		const float *	tuple
	)

overridevirtual

Insert (memory allocation performed) the tuple into the ith location in the array.

Implements vtkDataArray.

void vtkBitArray::InsertTuple	(	vtkIdType	i,
		const double *	tuple
	)

overridevirtual

Insert (memory allocation performed) the tuple into the ith location in the array.

Implements vtkDataArray.

vtkIdType vtkBitArray::InsertNextTuple ( const float * tuple )

overridevirtual

Insert (memory allocation performed) the tuple onto the end of the array.

Implements vtkDataArray.

vtkIdType vtkBitArray::InsertNextTuple ( const double * tuple )

overridevirtual

Insert (memory allocation performed) the tuple onto the end of the array.

Implements vtkDataArray.

void vtkBitArray::RemoveTuple ( vtkIdType id )

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.

void vtkBitArray::RemoveFirstTuple ( )

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.

void vtkBitArray::RemoveLastTuple ( )

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.

void vtkBitArray::SetComponent	(	vtkIdType	i,
		int	j,
		double	c
	)

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.

void vtkBitArray::Squeeze ( )

inlineoverridevirtual

Free any unneeded memory.

Implements vtkAbstractArray.

Definition at line 388 of file vtkBitArray.h.

int vtkBitArray::Resize ( vtkIdType numTuples )

overridevirtual

Resize the array while conserving the data.

Implements vtkAbstractArray.

int vtkBitArray::GetValue ( vtkIdType id )

Get the data at a particular index.

void vtkBitArray::SetNumberOfValues ( vtkIdType number )

inlineoverridevirtual

Fast method based setting of values without memory checks.

First use SetNumberOfValues then use SetValue to actually set them. Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.

Reimplemented from vtkAbstractArray.

Definition at line 323 of file vtkBitArray.h.

void vtkBitArray::SetValue	(	vtkIdType	id,
		int	value
	)

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 330 of file vtkBitArray.h.

void vtkBitArray::InsertValue	(	vtkIdType	id,
		int	i
	)

inline

Inserts values and checks to make sure there is enough memory.

Definition at line 345 of file vtkBitArray.h.

void vtkBitArray::SetVariantValue	(	vtkIdType	idx,
		vtkVariant	value
	)

inlineoverridevirtual

Set a value in the array from a variant.

Implements vtkAbstractArray.

Definition at line 371 of file vtkBitArray.h.

void vtkBitArray::InsertVariantValue	(	vtkIdType	idx,
		vtkVariant	value
	)

inlineoverridevirtual

Inserts values from a variant and checks to ensure there is enough memory.

Implements vtkAbstractArray.

Definition at line 376 of file vtkBitArray.h.

vtkIdType vtkBitArray::InsertNextValue ( int i )

inline

Definition at line 381 of file vtkBitArray.h.

void vtkBitArray::InsertComponent	(	vtkIdType	i,
		int	j,
		double	c
	)

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.

unsigned char* vtkBitArray::GetPointer ( vtkIdType id )

inline

Direct manipulation of the underlying data.

Definition at line 214 of file vtkBitArray.h.

unsigned char* vtkBitArray::WritePointer	(	vtkIdType	id,
		vtkIdType	number
	)

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.

void* vtkBitArray::WriteVoidPointer	(	vtkIdType	valueIdx,
		vtkIdType	numValues
	)

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 224 of file vtkBitArray.h.

void* vtkBitArray::GetVoidPointer ( vtkIdType valueIdx )

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 229 of file vtkBitArray.h.

void vtkBitArray::DeepCopy ( vtkDataArray * da )

overridevirtual

Deep copy of another bit array.

Reimplemented from vtkDataArray.

void vtkBitArray::DeepCopy ( vtkAbstractArray * da )

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 238 of file vtkBitArray.h.

void vtkBitArray::SetArray	(	unsigned char *	array,
		vtkIdType	size,
		int	save
	)

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 save 0, the array must have been allocated with new[] not malloc.

void vtkBitArray::SetVoidArray	(	void *	array,
		vtkIdType	size,
		int	save
	)

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 save 0, the array must have been allocated with new[] not malloc.

Definition at line 254 of file vtkBitArray.h.

void vtkBitArray::SetVoidArray	(	void *	array,
		vtkIdType	size,
		int	save,
		int	vtkNotUseddeleteMethod
	)

inlineoverridevirtual

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 save 0, the array must have been allocated with new[] not malloc.

Reimplemented from vtkAbstractArray.

Definition at line 258 of file vtkBitArray.h.

VTK_NEWINSTANCE vtkArrayIterator* vtkBitArray::NewIterator ( )

overridevirtual

Returns a new vtkBitArrayIterator instance.

Implements vtkAbstractArray.

vtkIdType vtkBitArray::LookupValue ( vtkVariant value )

overridevirtual

Return the indices where a specific value appears.

Implements vtkAbstractArray.

void vtkBitArray::LookupValue	(	vtkVariant	value,
		vtkIdList *	ids
	)

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.

void vtkBitArray::DataChanged ( )

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.

void vtkBitArray::ClearLookup ( )

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.

unsigned char* vtkBitArray::ResizeAndExtend ( vtkIdType sz )

protected

Member Data Documentation

unsigned char* vtkBitArray::Array

protected

Definition at line 301 of file vtkBitArray.h.

int vtkBitArray::TupleSize

protected

Definition at line 305 of file vtkBitArray.h.

double* vtkBitArray::Tuple

protected

Definition at line 306 of file vtkBitArray.h.

int vtkBitArray::SaveUserArray

protected

Definition at line 308 of file vtkBitArray.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/Core/vtkBitArray.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation