# encoding: utf-8 # module vtkmodules.vtkCommonDataModel # from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkCommonDataModel.cp311-win_amd64.pyd # by generator 1.147 # no doc # imports import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore import vtkmodules.vtkCommonMath as __vtkmodules_vtkCommonMath import vtkmodules.vtkCommonTransforms as __vtkmodules_vtkCommonTransforms class vtkFieldData(__vtkmodules_vtkCommonCore.vtkObject): """ vtkFieldData - represent and manipulate fields of data Superclass: vtkObject vtkFieldData represents and manipulates fields of data. The model of a field is a m x n matrix of data values, where m is the number of tuples, and n is the number of components. (A tuple is a row of n components in the matrix.) The field is assumed to be composed of a set of one or more data arrays, where the data in the arrays are of different types (e.g., int, double, char, etc.), and there may be variable numbers of components in each array. Note that each data array is assumed to be "m" in length (i.e., number of tuples), which typically corresponds to the number of points or cells in a dataset. Also, each data array must have a character-string name. (This is used to manipulate data.) There are two ways of manipulating and interfacing to fields. You can do it generically by manipulating components/tuples via a double-type data exchange, or you can do it by grabbing the arrays and manipulating them directly. The former is simpler but performs type conversion, which is bad if your data has non-castable types like (void) pointers, or you lose information as a result of the cast. The, more efficient method means managing each array in the field. Using this method you can create faster, more efficient algorithms that do not lose information. @sa vtkAbstractArray vtkDataSetAttributes vtkPointData vtkCellData """ def AddArray(self, array): # real signature unknown; restored from __doc__ """ AddArray(self, array:vtkAbstractArray) -> int C++: int AddArray(vtkAbstractArray *array) Add an array to the array list. If an array with the same name already exists - then the added array will replace it. Return the index of the added array. """ return 0 def Allocate(self, sz, ext=1000): # real signature unknown; restored from __doc__ """ Allocate(self, sz:int, ext:int=1000) -> int C++: vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext=1000) Allocate data for each array. Note that ext is no longer used. """ return 0 def AllocateArrays(self, num): # real signature unknown; restored from __doc__ """ AllocateArrays(self, num:int) -> None C++: void AllocateArrays(int num) AllocateOfArrays actually sets the number of vtkAbstractArray pointers in the vtkFieldData object, not the number of used pointers (arrays). Adding more arrays will cause the object to dynamically adjust the number of pointers if it needs to extend. Although AllocateArrays can be used if the number of arrays which will be added is known, it can be omitted with a small computation cost. """ pass def CopyAllOff(self, unused=0): # real signature unknown; restored from __doc__ """ CopyAllOff(self, unused:int=0) -> None C++: virtual void CopyAllOff(int unused=0) Turn off copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array """ pass def CopyAllOn(self, unused=0): # real signature unknown; restored from __doc__ """ CopyAllOn(self, unused:int=0) -> None C++: virtual void CopyAllOn(int unused=0) Turn on copying of all data. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array """ pass def CopyFieldOff(self, name): # real signature unknown; restored from __doc__ """ CopyFieldOff(self, name:str) -> None C++: void CopyFieldOff(const char *name) """ pass def CopyFieldOn(self, name): # real signature unknown; restored from __doc__ """ CopyFieldOn(self, name:str) -> None C++: void CopyFieldOn(const char *name) Turn on/off the copying of the field specified by name. During the copying/passing, the following rules are followed for each array: 1. If the copy flag for an array is set (on or off), it is applied This overrides rule 2. 2. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array """ pass def CopyStructure(self, __a): # real signature unknown; restored from __doc__ """ CopyStructure(self, __a:vtkFieldData) -> None C++: void CopyStructure(vtkFieldData *) Copy data array structure from a given field. The same arrays will exist with the same types, but will contain nothing in the copy. """ pass def DeepCopy(self, da): # real signature unknown; restored from __doc__ """ DeepCopy(self, da:vtkFieldData) -> None C++: virtual void DeepCopy(vtkFieldData *da) Copy a field by creating new data arrays (i.e., duplicate storage). """ pass def ExtendedNew(self): # real signature unknown; restored from __doc__ """ ExtendedNew() -> vtkFieldData C++: static vtkFieldData *ExtendedNew() """ return vtkFieldData def GetAbstractArray(self, i): # real signature unknown; restored from __doc__ """ GetAbstractArray(self, i:int) -> vtkAbstractArray C++: vtkAbstractArray *GetAbstractArray(int i) GetAbstractArray(self, arrayName:str, index:int) -> vtkAbstractArray C++: vtkAbstractArray *GetAbstractArray(const char *arrayName, int &index) GetAbstractArray(self, arrayName:str) -> vtkAbstractArray C++: vtkAbstractArray *GetAbstractArray(const char *arrayName) Returns the ith array in the field. Unlike GetArray(), this method returns a vtkAbstractArray and can be used to access any array type. A nullptr is returned only if the index i is out of range. """ pass def GetActualMemorySize(self): # real signature unknown; restored from __doc__ """ GetActualMemorySize(self) -> int C++: virtual unsigned long GetActualMemorySize() Return the memory in kibibytes (1024 bytes) consumed by this field data. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. """ return 0 def GetArray(self, i): # real signature unknown; restored from __doc__ """ GetArray(self, i:int) -> vtkDataArray C++: vtkDataArray *GetArray(int i) GetArray(self, arrayName:str, index:int) -> vtkDataArray C++: vtkDataArray *GetArray(const char *arrayName, int &index) GetArray(self, arrayName:str) -> vtkDataArray C++: vtkDataArray *GetArray(const char *arrayName) Not recommended for use. Use GetAbstractArray(int i) instead. Return the ith array in the field. A nullptr is returned if the index i is out of range, or if the array at the given index is not a vtkDataArray. To access vtkStringArray, or vtkVariantArray, use GetAbstractArray(int i). """ pass def GetArrayContainingComponent(self, i, arrayComp): # real signature unknown; restored from __doc__ """ GetArrayContainingComponent(self, i:int, arrayComp:int) -> int C++: int GetArrayContainingComponent(int i, int &arrayComp) Return the array containing the ith component of the field. The return value is an integer number n 0<=nNumberOfArrays. Also, an integer value is returned indicating the component in the array is returned. Method returns -1 if specified component is not in the field. """ return 0 def GetArrayName(self, i): # real signature unknown; restored from __doc__ """ GetArrayName(self, i:int) -> str C++: const char *GetArrayName(int i) Get the name of ith array. Note that this is equivalent to: GetAbstractArray(i)->GetName() if ith array pointer is not nullptr """ return "" def GetField(self, ptId, f): # real signature unknown; restored from __doc__ """ GetField(self, ptId:vtkIdList, f:vtkFieldData) -> None C++: void GetField(vtkIdList *ptId, vtkFieldData *f) Get a field from a list of ids. Supplied field f should have same types and number of data arrays as this one (i.e., like CopyStructure() creates). This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. """ pass def GetFiniteRange(self, name, range, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ """ GetFiniteRange(self, name:str, range:[float, float], comp:int=0) -> bool C++: bool GetFiniteRange(const char *name, double range[2], int comp=0) GetFiniteRange(self, index:int, range:[float, float], comp:int=0) -> bool C++: bool GetFiniteRange(int index, double range[2], int comp=0) """ pass def GetGhostArray(self): # real signature unknown; restored from __doc__ """ GetGhostArray(self) -> vtkUnsignedCharArray C++: virtual vtkUnsignedCharArray *GetGhostArray() Get the ghost array, if present in this field data. If no ghost array is set, returns `nullptr`. A ghost array is a `vtkUnsignedCharArray` called `vtkGhostType`. See `vtkDataSetAttributes` for more context on ghost types. @sa vtkDataSetAttributes """ pass def GetGhostsToSkip(self): # real signature unknown; restored from __doc__ """ GetGhostsToSkip(self) -> int C++: virtual unsigned char GetGhostsToSkip() Set / Get the binary mask filtering out certain types of ghosts when calling `GetRange`. By default, it is set to 0xff for pure `vtkFieldData`. In `vtkCellData`, it is set to `HIDDENCELL` and in `vtkPointData`, it is set to `HIDDENPOINT` by default. See `vtkDataSetAttributes` for more context on ghost types definitions. @sa vtkDataSetAttributes vtkPointData vtkCellData """ return 0 def GetMTime(self): # real signature unknown; restored from __doc__ """ GetMTime(self) -> int C++: vtkMTimeType GetMTime() override; Check object's components for modified times. """ return 0 def GetNumberOfArrays(self): # real signature unknown; restored from __doc__ """ GetNumberOfArrays(self) -> int C++: int GetNumberOfArrays() Get the number of arrays of data available. This does not include nullptr array pointers therefore after fd->AllocateArray(n); nArrays = GetNumberOfArrays() nArrays is not necessarily equal to n. """ return 0 def GetNumberOfComponents(self): # real signature unknown; restored from __doc__ """ GetNumberOfComponents(self) -> int C++: int GetNumberOfComponents() Get the number of components in the field. This is determined by adding up the components in each non-nullptr array. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. """ return 0 def GetNumberOfGenerationsFromBase(self, type): # real signature unknown; restored from __doc__ """ GetNumberOfGenerationsFromBase(self, type:str) -> int C++: vtkIdType GetNumberOfGenerationsFromBase(const char *type) override; 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). If the named class is not in this class's inheritance tree, return a negative value. Valid responses will always be nonnegative. This method works in combination with vtkTypeMacro found in vtkSetGet.h. """ return 0 def GetNumberOfGenerationsFromBaseType(self, type): # real signature unknown; restored from __doc__ """ GetNumberOfGenerationsFromBaseType(type:str) -> int C++: static vtkIdType GetNumberOfGenerationsFromBaseType( const char *type) 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). If the named class is not in this class's inheritance tree, return a negative value. Valid responses will always be nonnegative. This method works in combination with vtkTypeMacro found in vtkSetGet.h. """ return 0 def GetNumberOfTuples(self): # real signature unknown; restored from __doc__ """ GetNumberOfTuples(self) -> int C++: vtkIdType GetNumberOfTuples() Get the number of tuples in the field. Note: some fields have arrays with different numbers of tuples; this method returns the number of tuples in the first array. Mixed-length arrays may have to be treated specially. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. """ return 0 def GetRange(self, name, range, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ """ GetRange(self, name:str, range:[float, float], comp:int=0) -> bool C++: bool GetRange(const char *name, double range[2], int comp=0) GetRange(self, index:int, range:[float, float], comp:int=0) -> bool C++: bool GetRange(int index, double range[2], int comp=0) Computes the range of the input data array (specified through its `name` or the `index` in this field data). If the targeted array is not polymorphic with a `vtkDataArray`, or if no array match the input `name` or `index`, or if `comp` is out of bounds, then the returned range is `[NaN, NaN]`. The computed range is cached to avoid recomputing it. The range is recomputed if the held array has been modified, if `GhostsToSkip` has been changed, or if the ghost array has been changed / modified. If a ghost array is present in the field data, then the binary mask `GhostsToSkip` is used to skip values associated with a ghost that intersects this mask. `comp` targets which component of the array the range is to be computed on. Setting it to -1 results in computing the range of the magnitude of the array. The `Finite` version of this method skips infinite values in the array in addition to ghosts matching with `GhostsToSkip`. """ pass def HasArray(self, name): # real signature unknown; restored from __doc__ """ HasArray(self, name:str) -> int C++: int HasArray(const char *name) Return 1 if an array with the given name could be found. 0 otherwise. """ return 0 def Initialize(self): # real signature unknown; restored from __doc__ """ Initialize(self) -> None C++: virtual void Initialize() Release all data but do not delete object. Also, clear the copy flags. """ pass def InsertNextTuple(self, j, source): # real signature unknown; restored from __doc__ """ InsertNextTuple(self, j:int, source:vtkFieldData) -> int C++: vtkIdType InsertNextTuple(const vtkIdType j, vtkFieldData *source) Insert the jth tuple in source field data at the end of the tuple matrix. Range checking is performed and memory is allocated as necessary. """ return 0 def InsertTuple(self, i, j, source): # real signature unknown; restored from __doc__ """ InsertTuple(self, i:int, j:int, source:vtkFieldData) -> None C++: void InsertTuple(const vtkIdType i, const vtkIdType j, vtkFieldData *source) Insert the jth tuple in source field data at the ith location. Range checking is performed and memory allocates as necessary. """ pass def IsA(self, type): # real signature unknown; restored from __doc__ """ IsA(self, type:str) -> int C++: vtkTypeBool IsA(const char *type) override; 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. """ return 0 def IsTypeOf(self, type): # real signature unknown; restored from __doc__ """ IsTypeOf(type:str) -> int C++: static vtkTypeBool IsTypeOf(const char *type) Return 1 if this class type 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. """ return 0 def NewInstance(self): # real signature unknown; restored from __doc__ """ NewInstance(self) -> vtkFieldData C++: vtkFieldData *NewInstance() """ return vtkFieldData def NullData(self, id): # real signature unknown; restored from __doc__ """ NullData(self, id:int) -> None C++: void NullData(vtkIdType id) Sets every vtkDataArray at index id to a null tuple. """ pass def PassData(self, fd): # real signature unknown; restored from __doc__ """ PassData(self, fd:vtkFieldData) -> None C++: virtual void PassData(vtkFieldData *fd) Pass entire arrays of input data through to output. Obey the "copy" flags. """ pass def RemoveArray(self, name): # real signature unknown; restored from __doc__ """ RemoveArray(self, name:str) -> None C++: virtual void RemoveArray(const char *name) RemoveArray(self, index:int) -> None C++: virtual void RemoveArray(int index) Remove an array (with the given name or index) from the list of arrays. """ pass def Reset(self): # real signature unknown; restored from __doc__ """ Reset(self) -> None C++: void Reset() Resets each data array in the field (Reset() does not release memory but it makes the arrays look like they are empty.) """ pass def SafeDownCast(self, o): # real signature unknown; restored from __doc__ """ SafeDownCast(o:vtkObjectBase) -> vtkFieldData C++: static vtkFieldData *SafeDownCast(vtkObjectBase *o) """ return vtkFieldData def SetGhostsToSkip(self, __a): # real signature unknown; restored from __doc__ """ SetGhostsToSkip(self, __a:int) -> None C++: virtual void SetGhostsToSkip(unsigned char) """ pass def SetNumberOfTuples(self, number): # real signature unknown; restored from __doc__ """ SetNumberOfTuples(self, number:int) -> None C++: void SetNumberOfTuples(const vtkIdType number) Set the number of tuples for each data array in the field. This method should not be used if the instance is from a subclass of vtkFieldData (vtkPointData or vtkCellData). This is because in those cases, the attribute data is stored with the other fields and will cause the method to behave in an unexpected way. """ pass def SetTuple(self, i, j, source): # real signature unknown; restored from __doc__ """ SetTuple(self, i:int, j:int, source:vtkFieldData) -> None C++: void SetTuple(const vtkIdType i, const vtkIdType j, vtkFieldData *source) Set the jth tuple in source field data at the ith location. Set operations mean that no range checking is performed, so they're faster. """ pass def ShallowCopy(self, da): # real signature unknown; restored from __doc__ """ ShallowCopy(self, da:vtkFieldData) -> None C++: virtual void ShallowCopy(vtkFieldData *da) Copy a field by reference counting the data arrays. """ pass def Squeeze(self): # real signature unknown; restored from __doc__ """ Squeeze(self) -> None C++: void Squeeze() Squeezes each data array in the field (Squeeze() reclaims unused memory.) """ pass def __delattr__(self, *args, **kwargs): # real signature unknown """ Implement delattr(self, name). """ pass def __getattribute__(self, *args, **kwargs): # real signature unknown """ Return getattr(self, name). """ pass def __init__(self, *args, **kwargs): # real signature unknown pass @staticmethod # known case of __new__ def __new__(*args, **kwargs): # real signature unknown """ Create and return a new object. See help(type) for accurate signature. """ pass def __repr__(self, *args, **kwargs): # real signature unknown """ Return repr(self). """ pass def __setattr__(self, *args, **kwargs): # real signature unknown """ Implement setattr(self, name, value). """ pass def __str__(self, *args, **kwargs): # real signature unknown """ Return str(self). """ pass __this__ = property(lambda self: object(), lambda self, v: None, lambda self: None) # default """Pointer to the C++ object.""" __dict__ = None # (!) real value is 'mappingproxy({\'__vtkname__\': \'vtkFieldData\', \'ExtendedNew\': , \'IsTypeOf\': , \'IsA\': , \'SafeDownCast\': , \'NewInstance\': , \'GetNumberOfGenerationsFromBaseType\': , \'GetNumberOfGenerationsFromBase\': , \'Initialize\': , \'Allocate\': , \'CopyStructure\': , \'AllocateArrays\': , \'GetNumberOfArrays\': , \'AddArray\': , \'NullData\': , \'RemoveArray\': , \'GetArray\': , \'GetAbstractArray\': , \'HasArray\': , \'GetArrayName\': , \'PassData\': , \'CopyFieldOn\': , \'CopyFieldOff\': , \'CopyAllOn\': , \'CopyAllOff\': , \'DeepCopy\': , \'ShallowCopy\': , \'Squeeze\': , \'Reset\': , \'GetActualMemorySize\': , \'GetMTime\': , \'GetField\': , \'GetArrayContainingComponent\': , \'GetNumberOfComponents\': , \'GetNumberOfTuples\': , \'SetNumberOfTuples\': , \'SetTuple\': , \'InsertTuple\': , \'InsertNextTuple\': , \'GetRange\': , \'GetFiniteRange\': , \'GetGhostsToSkip\': , \'SetGhostsToSkip\': , \'GetGhostArray\': , \'__new__\': , \'__repr__\': , \'__str__\': , \'__getattribute__\': , \'__setattr__\': , \'__delattr__\': , \'__dict__\': , \'__this__\': , \'__doc__\': \'vtkFieldData - represent and manipulate fields of data\\n\\nSuperclass: vtkObject\\n\\nvtkFieldData represents and manipulates fields of data. The model of\\na field is a m x n matrix of data values, where m is the number of\\ntuples, and n is the number of components. (A tuple is a row of n\\ncomponents in the matrix.) The field is assumed to be composed of a\\nset of one or more data arrays, where the data in the arrays are of\\ndifferent types (e.g., int, double, char, etc.), and there may be\\nvariable numbers of components in each array. Note that each data\\narray is assumed to be "m" in length (i.e., number of tuples), which\\ntypically corresponds to the number of points or cells in a dataset.\\nAlso, each data array must have a character-string name. (This is\\nused to manipulate data.)\\n\\nThere are two ways of manipulating and interfacing to fields. You can\\ndo it generically by manipulating components/tuples via a double-type\\ndata exchange, or you can do it by grabbing the arrays and\\nmanipulating them directly. The former is simpler but performs type\\nconversion, which is bad if your data has non-castable types like\\n(void) pointers, or you lose information as a result of the cast.\\nThe, more efficient method means managing each array in the field. \\nUsing this method you can create faster, more efficient algorithms\\nthat do not lose information.\\n\\n@sa\\nvtkAbstractArray vtkDataSetAttributes vtkPointData vtkCellData\\n\\n\'})' __vtkname__ = 'vtkFieldData'