VTK
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkPeriodicDataArray< Scalar > Class Template Referenceabstract

Map native an Array into an angulat periodic array. More...

#include <vtkPeriodicDataArray.h>

Inheritance diagram for vtkPeriodicDataArray< Scalar >:
[legend]
Collaboration diagram for vtkPeriodicDataArray< Scalar >:
[legend]

Public Types

typedef Superclass::ValueType ValueType
 
- Public Types inherited from vtkGenericDataArray< DerivedT, ValueTypeT >
enum  { VTK_DATA_TYPE = vtkTypeTraits<ValueType>::VTK_TYPE_ID }
 Compile time access to the VTK type identifier. More...
 
typedef ValueTypeT ValueType
 
- 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 }
 
enum  { MAX_DISCRETE_VALUES = 32 }
 
enum  {
  AbstractArray = 0, DataArray, AoSDataArrayTemplate, SoADataArrayTemplate,
  TypedDataArray, MappedDataArray, DataArrayTemplate = AoSDataArrayTemplate
}
 
typedef vtkObject Superclass
 

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void InitializeArray (vtkAOSDataArrayTemplate< Scalar > *inputData)
 Initialize the mapped array with the original input data array. More...
 
void Initialize () override
 Initialize array with zero values. More...
 
void GetTuples (vtkIdList *ptIds, vtkAbstractArray *output) override
 Copy tuples values, selected by ptIds into provided array. More...
 
void GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
 Copy tuples from id p1 to id p2 included into provided array. More...
 
void Squeeze () override
 No effect. More...
 
VTK_NEWINSTANCE vtkArrayIteratorNewIterator () override
 Not implemented. More...
 
vtkIdType LookupValue (vtkVariant value) override
 Not implemented. More...
 
void LookupValue (vtkVariant value, vtkIdList *ids) override
 Not implemented. More...
 
vtkVariant GetVariantValue (vtkIdType idx) override
 Not implemented. More...
 
void ClearLookup () override
 Not implemented. More...
 
double * GetTuple (vtkIdType i) override
 Return tuple at location i. More...
 
void GetTuple (vtkIdType i, double *tuple) override
 Copy tuple at location i into user provided array. More...
 
vtkIdType LookupTypedValue (Scalar value) override
 Not implemented. More...
 
void LookupTypedValue (Scalar value, vtkIdList *ids) override
 Not implemented. More...
 
ValueType GetValue (vtkIdType idx) const
 Get value at index idx. More...
 
ValueTypeGetValueReference (vtkIdType idx)
 Get value at index idx as reference. More...
 
void GetTypedTuple (vtkIdType idx, Scalar *t) const
 Copy tuple value at location idx into provided array. More...
 
ValueType GetTypedComponent (vtkIdType tupleIdx, int compIdx) const
 Return the requested component of the specified tuple. More...
 
unsigned long GetActualMemorySize () override
 Return the memory in kilobytes consumed by this data array. More...
 
int Allocate (vtkIdType sz, vtkIdType ext) override
 Read only container, not supported. More...
 
int Resize (vtkIdType numTuples) override
 Read only container, not supported. More...
 
void SetNumberOfTuples (vtkIdType number) override
 Read only container, not supported. More...
 
void SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
 Read only container, not supported. More...
 
void SetTuple (vtkIdType i, const float *source) override
 Read only container, not supported. More...
 
void SetTuple (vtkIdType i, const double *source) override
 Read only container, not supported. More...
 
void InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source) override
 Read only container, not supported. More...
 
void InsertTuple (vtkIdType i, const float *source) override
 Read only container, not supported. More...
 
void InsertTuple (vtkIdType i, const double *source) override
 Read only container, not supported. More...
 
void InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
 Read only container, not supported. More...
 
void InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
 Read only container, not supported. More...
 
vtkIdType InsertNextTuple (vtkIdType j, vtkAbstractArray *source) override
 Read only container, error. More...
 
vtkIdType InsertNextTuple (const float *source) override
 Read only container, not supported. More...
 
vtkIdType InsertNextTuple (const double *source) override
 Read only container, not supported. More...
 
void DeepCopy (vtkAbstractArray *aa) override
 Read only container, not supported. More...
 
void DeepCopy (vtkDataArray *da) override
 Read only container, not supported. More...
 
void InterpolateTuple (vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
 Read only container, not supported. More...
 
void InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray *source1, vtkIdType id2, vtkAbstractArray *source2, double t) override
 Read only container, not supported. More...
 
void SetVariantValue (vtkIdType idx, vtkVariant value) override
 Read only container, not supported. More...
 
void InsertVariantValue (vtkIdType idx, vtkVariant value) override
 Read only container, not supported. More...
 
void RemoveTuple (vtkIdType id) override
 Read only container, not supported. More...
 
void RemoveFirstTuple () override
 Read only container, not supported. More...
 
void RemoveLastTuple () override
 Read only container, not supported. More...
 
void SetTypedTuple (vtkIdType i, const Scalar *t)
 Read only container, not supported. More...
 
void SetTypedComponent (vtkIdType t, int c, Scalar v)
 Read only container, not supported. More...
 
void InsertTypedTuple (vtkIdType i, const Scalar *t)
 Read only container, not supported. More...
 
vtkIdType InsertNextTypedTuple (const Scalar *t)
 Read only container, not supported. More...
 
void SetValue (vtkIdType idx, Scalar value)
 Read only container, not supported. More...
 
vtkIdType InsertNextValue (Scalar v)
 Read only container, not supported. More...
 
void InsertValue (vtkIdType idx, Scalar v)
 Read only container, not supported. More...
 
virtual void SetNormalize (bool)
 Set/Get normalize flag. More...
 
virtual bool GetNormalize ()
 Set/Get normalize flag. More...
 
- Public Member Functions inherited from vtkGenericDataArray< DerivedT, ValueTypeT >
ValueType GetValue (vtkIdType valueIdx) const
 Get the value at valueIdx. More...
 
void SetValue (vtkIdType valueIdx, ValueType value)
 Set the value at valueIdx to value. More...
 
void GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const
 Copy the tuple at tupleIdx into tuple. More...
 
void SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple)
 Set this array's tuple at tupleIdx to the values in tuple. More...
 
ValueType GetTypedComponent (vtkIdType tupleIdx, int compIdx) const
 Get component compIdx of the tuple at tupleIdx. More...
 
void SetTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType value)
 Set component compIdx of the tuple at tupleIdx to value. More...
 
vtkIdType InsertNextValue (ValueType value)
 Insert data at the end of the array. More...
 
void InsertValue (vtkIdType valueIdx, ValueType value)
 Insert data at a specified position in the array. More...
 
void InsertTypedTuple (vtkIdType tupleIdx, const ValueType *t)
 Insert (memory allocation performed) the tuple t at tupleIdx. More...
 
vtkIdType InsertNextTypedTuple (const ValueType *t)
 Insert (memory allocation performed) the tuple onto the end of the array. More...
 
void InsertTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType val)
 Insert (memory allocation performed) the value at the specified tuple and component location. More...
 
ValueTypeGetValueRange ()
 Get the range of array values for the 0th component in the native data type. More...
 
void GetValueRange (ValueType range[2])
 
vtkIdType Capacity ()
 Return the capacity in typeof T units of the current array. More...
 
virtual void FillTypedComponent (int compIdx, ValueType value)
 Set component comp of all tuples to value. More...
 
virtual void FillValue (ValueType value)
 Set all the values in array to value. More...
 
int GetDataType () override
 Return the underlying data type. More...
 
int GetDataTypeSize () override
 Return the size of the underlying data type. More...
 
bool HasStandardMemoryLayout () override
 Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...
 
void SetNumberOfComponents (int num) override
 Set/Get the dimension (n) of the components. More...
 
void InsertComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Insert value at the location specified by tupleIdx and compIdx. More...
 
void SetComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Set the data component at the location specified by tupleIdx and compIdx to value. More...
 
double GetComponent (vtkIdType tupleIdx, int compIdx) override
 Return the data component at the location specified by tupleIdx and compIdx. More...
 
virtual vtkIdType LookupTypedValue (ValueType value)
 
virtual void LookupTypedValue (ValueType value, vtkIdList *valueIds)
 
void DataChanged () override
 Tell the array explicitly that the data has changed. More...
 
void FillComponent (int compIdx, double value) override
 Fill a component of a data array with a specified value. More...
 
void * GetVoidPointer (vtkIdType valueIdx) override
 Default implementation raises a runtime error. More...
 
ValueTypeGetPointer (vtkIdType valueIdx)
 Default implementation raises a runtime error. More...
 
void SetVoidArray (void *, vtkIdType, int) override
 Default implementation raises a runtime error. More...
 
void SetVoidArray (void *, vtkIdType, int, int) override
 Default implementation raises a runtime error. More...
 
void * WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues) override
 Default implementation raises a runtime error. More...
 
ValueTypeWritePointer (vtkIdType valueIdx, vtkIdType numValues)
 Default implementation raises a runtime error. More...
 
void GetValueRange (ValueType range[2], int comp)
 Get the range of array values for the given component in the native data type. More...
 
ValueTypeGetValueRange (int comp)
 Get the range of array values for the given component in the native data type. More...
 
- Public Member Functions inherited from vtkDataArray
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataArrayNewInstance () const
 
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...
 
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 Fill (double value)
 Fill all values 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...
 
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...
 
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. More...
 
double * GetFiniteRange ()
 Return the range of the data array. More...
 
void GetFiniteRange (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 SetLookupTable (vtkLookupTable *lut)
 Set/get the lookup table associated with this scalar data, if any. More...
 
virtual vtkLookupTableGetLookupTable ()
 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...
 
double * GetFiniteRange (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
vtkAbstractArrayNewInstance () 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...
 
virtual void SetNumberOfValues (vtkIdType numValues)
 Specify the number of values (tuples * components) for this object to hold. 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...
 
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 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...
 
vtkInformationGetInformation ()
 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...
 
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 SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
 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 RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkPeriodicDataArray ()
 
 ~vtkPeriodicDataArray () override
 
virtual void Transform (Scalar *tuple) const =0
 Transform the provided tuple. More...
 
bool ComputeScalarRange (double *range) override
 Get the transformed range by components. More...
 
bool ComputeVectorRange (double range[2]) override
 Get the transformed range on all components. More...
 
virtual void ComputePeriodicRange ()
 Update the transformed periodic range. More...
 
void InvalidateRange ()
 Set the invalid range flag to false. More...
 
bool AllocateTuples (vtkIdType numTuples)
 Read only container, not supported. More...
 
bool ReallocateTuples (vtkIdType numTuples)
 Read only container, not supported. More...
 
- Protected Member Functions inherited from vtkGenericDataArray< DerivedT, ValueTypeT >
 vtkGenericDataArray ()
 
 ~vtkGenericDataArray () override
 
bool AllocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool ReallocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool EnsureAccessToTuple (vtkIdType tupleIdx)
 
- Protected Member Functions inherited from vtkDataArray
virtual vtkObjectBaseNewInstanceInternal () const
 
vtkInformationGetFiniteInformation ()
 Get an information object that can be used to annotate the array. More...
 
void SetFiniteInformation (vtkInformation *args)
 Set an information object that can be used to annotate the array. More...
 
virtual void ComputeRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
virtual void ComputeFiniteRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
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. More...
 
virtual bool ComputeFiniteVectorRange (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

bool Normalize
 
- Protected Attributes inherited from vtkGenericDataArray< DerivedT, ValueTypeT >
std::vector< double > LegacyTuple
 
std::vector< ValueTypeLegacyValueRange
 
vtkGenericDataArrayLookupHelper
< SelfType
Lookup
 
- Protected Attributes inherited from vtkDataArray
vtkLookupTableLookupTable
 
double Range [2]
 
double FiniteRange [2]
 
vtkInformationFiniteInformation
 
- Protected Attributes inherited from vtkAbstractArray
vtkIdType Size
 
vtkIdType MaxId
 
int NumberOfComponents
 
unsigned int MaxDiscreteValues
 
char * Name
 
bool RebuildArray
 
vtkInformationInformation
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkGenericDataArray< vtkPeriodicDataArray< Scalar >, Scalar >
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkDataArray
static int IsTypeOf (const char *type)
 
static vtkDataArraySafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayFastDownCast (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 vtkInformationStringKeyUNITS_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 vtkAbstractArraySafeDownCast (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 vtkInformationIntegerKeyGUI_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 vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Detailed Description

template<class Scalar>
class vtkPeriodicDataArray< Scalar >

Map native an Array into an angulat periodic array.

Map an array into a periodic array. Data from the original array aare rotated (on the fly) by the specified angle along the specified axis around the specified point. Lookup is not implemented. Creating the array is virtually free, accessing a tuple require some computation.

Definition at line 36 of file vtkPeriodicDataArray.h.

Member Typedef Documentation

template<class Scalar >
typedef Superclass::ValueType vtkPeriodicDataArray< Scalar >::ValueType

Definition at line 42 of file vtkPeriodicDataArray.h.

Constructor & Destructor Documentation

template<class Scalar >
vtkPeriodicDataArray< Scalar >::vtkPeriodicDataArray ( )
protected
template<class Scalar >
vtkPeriodicDataArray< Scalar >::~vtkPeriodicDataArray ( )
overrideprotected

Member Function Documentation

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::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 vtkDataArray.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InitializeArray ( vtkAOSDataArrayTemplate< Scalar > *  inputData)

Initialize the mapped array with the original input data array.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::Initialize ( )
overridevirtual

Initialize array with zero values.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::GetTuples ( vtkIdList ptIds,
vtkAbstractArray output 
)
overridevirtual

Copy tuples values, selected by ptIds into provided array.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::GetTuples ( vtkIdType  p1,
vtkIdType  p2,
vtkAbstractArray output 
)
overridevirtual

Copy tuples from id p1 to id p2 included into provided array.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::Squeeze ( )
overridevirtual

No effect.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
VTK_NEWINSTANCE vtkArrayIterator* vtkPeriodicDataArray< Scalar >::NewIterator ( )
overridevirtual

Not implemented.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::LookupValue ( vtkVariant  value)
overridevirtual

Not implemented.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::LookupValue ( vtkVariant  value,
vtkIdList ids 
)
overridevirtual

Not implemented.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkVariant vtkPeriodicDataArray< Scalar >::GetVariantValue ( vtkIdType  idx)
overridevirtual

Not implemented.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::ClearLookup ( )
overridevirtual

Not implemented.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
double* vtkPeriodicDataArray< Scalar >::GetTuple ( vtkIdType  i)
overridevirtual

Return tuple at location i.

Pointer valid until next call to this object

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::GetTuple ( vtkIdType  i,
double *  tuple 
)
overridevirtual

Copy tuple at location i into user provided array.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::LookupTypedValue ( Scalar  value)
override

Not implemented.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::LookupTypedValue ( Scalar  value,
vtkIdList ids 
)
override

Not implemented.

template<class Scalar >
ValueType vtkPeriodicDataArray< Scalar >::GetValue ( vtkIdType  idx) const

Get value at index idx.

Warning, it internally call GetTypedTuple, so it is an inneficcient way if reading all data

template<class Scalar >
ValueType& vtkPeriodicDataArray< Scalar >::GetValueReference ( vtkIdType  idx)

Get value at index idx as reference.

Warning, it internally call GetTypedTuple, so it is an inneficcient way if reading all data

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::GetTypedTuple ( vtkIdType  idx,
Scalar *  t 
) const

Copy tuple value at location idx into provided array.

template<class Scalar >
ValueType vtkPeriodicDataArray< Scalar >::GetTypedComponent ( vtkIdType  tupleIdx,
int  compIdx 
) const

Return the requested component of the specified tuple.

Warning, this internally calls GetTypedTuple, so it is an inefficient way of reading all data.

template<class Scalar >
unsigned long vtkPeriodicDataArray< Scalar >::GetActualMemorySize ( )
overridevirtual

Return the memory in kilobytes consumed by this data array.

Reimplemented from vtkDataArray.

template<class Scalar >
int vtkPeriodicDataArray< Scalar >::Allocate ( vtkIdType  sz,
vtkIdType  ext 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
int vtkPeriodicDataArray< Scalar >::Resize ( vtkIdType  numTuples)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetNumberOfTuples ( vtkIdType  number)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetTuple ( vtkIdType  i,
vtkIdType  j,
vtkAbstractArray source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetTuple ( vtkIdType  i,
const float *  source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetTuple ( vtkIdType  i,
const double *  source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTuple ( vtkIdType  i,
vtkIdType  j,
vtkAbstractArray source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTuple ( vtkIdType  i,
const float *  source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTuple ( vtkIdType  i,
const double *  source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTuples ( vtkIdList dstIds,
vtkIdList srcIds,
vtkAbstractArray source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTuples ( vtkIdType  dstStart,
vtkIdType  n,
vtkIdType  srcStart,
vtkAbstractArray source 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::InsertNextTuple ( vtkIdType  j,
vtkAbstractArray source 
)
overridevirtual

Read only container, error.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::InsertNextTuple ( const float *  source)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::InsertNextTuple ( const double *  source)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::DeepCopy ( vtkAbstractArray aa)
overridevirtual

Read only container, not supported.

Reimplemented from vtkDataArray.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::DeepCopy ( vtkDataArray da)
overridevirtual

Read only container, not supported.

Reimplemented from vtkDataArray.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InterpolateTuple ( vtkIdType  i,
vtkIdList ptIndices,
vtkAbstractArray source,
double *  weights 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InterpolateTuple ( vtkIdType  i,
vtkIdType  id1,
vtkAbstractArray source1,
vtkIdType  id2,
vtkAbstractArray source2,
double  t 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetVariantValue ( vtkIdType  idx,
vtkVariant  value 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertVariantValue ( vtkIdType  idx,
vtkVariant  value 
)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::RemoveTuple ( vtkIdType  id)
overridevirtual

Read only container, not supported.

Reimplemented from vtkGenericDataArray< DerivedT, ValueTypeT >.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::RemoveFirstTuple ( )
overridevirtual

Read only container, not supported.

Reimplemented from vtkDataArray.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::RemoveLastTuple ( )
overridevirtual

Read only container, not supported.

Reimplemented from vtkDataArray.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetTypedTuple ( vtkIdType  i,
const Scalar *  t 
)

Read only container, not supported.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetTypedComponent ( vtkIdType  t,
int  c,
Scalar  v 
)

Read only container, not supported.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertTypedTuple ( vtkIdType  i,
const Scalar *  t 
)

Read only container, not supported.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::InsertNextTypedTuple ( const Scalar *  t)

Read only container, not supported.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::SetValue ( vtkIdType  idx,
Scalar  value 
)

Read only container, not supported.

template<class Scalar >
vtkIdType vtkPeriodicDataArray< Scalar >::InsertNextValue ( Scalar  v)

Read only container, not supported.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InsertValue ( vtkIdType  idx,
Scalar  v 
)

Read only container, not supported.

template<class Scalar >
virtual void vtkPeriodicDataArray< Scalar >::SetNormalize ( bool  )
virtual

Set/Get normalize flag.

Default: false

template<class Scalar >
virtual bool vtkPeriodicDataArray< Scalar >::GetNormalize ( )
virtual

Set/Get normalize flag.

Default: false

template<class Scalar >
bool vtkPeriodicDataArray< Scalar >::AllocateTuples ( vtkIdType  numTuples)
protected

Read only container, not supported.

template<class Scalar >
bool vtkPeriodicDataArray< Scalar >::ReallocateTuples ( vtkIdType  numTuples)
protected

Read only container, not supported.

template<class Scalar >
virtual void vtkPeriodicDataArray< Scalar >::Transform ( Scalar *  tuple) const
protectedpure virtual

Transform the provided tuple.

Implemented in vtkAngularPeriodicDataArray< Scalar >.

template<class Scalar >
bool vtkPeriodicDataArray< Scalar >::ComputeScalarRange ( double *  range)
overrideprotectedvirtual

Get the transformed range by components.

Reimplemented from vtkDataArray.

template<class Scalar >
bool vtkPeriodicDataArray< Scalar >::ComputeVectorRange ( double  range[2])
overrideprotectedvirtual

Get the transformed range on all components.

Reimplemented from vtkDataArray.

template<class Scalar >
virtual void vtkPeriodicDataArray< Scalar >::ComputePeriodicRange ( )
protectedvirtual

Update the transformed periodic range.

template<class Scalar >
void vtkPeriodicDataArray< Scalar >::InvalidateRange ( )
protected

Set the invalid range flag to false.

Friends And Related Function Documentation

template<class Scalar >
friend class vtkGenericDataArray< vtkPeriodicDataArray< Scalar >, Scalar >
friend

Definition at line 353 of file vtkPeriodicDataArray.h.

Member Data Documentation

template<class Scalar >
bool vtkPeriodicDataArray< Scalar >::Normalize
protected

Definition at line 347 of file vtkPeriodicDataArray.h.


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