pyCAPS
pyCAPS: A Python Extension Module for CAPS
|
Functions to interact with a CAPS dataSet object. More...
Public Member Functions | |
def | getData (self) |
Executes caps_getData on data set object to retrieve data set variable, dataSetName. More... | |
def | getDataXYZ (self) |
Executes caps_getData on data set object to retrieve XYZ coordinates of the data set. More... | |
def | getDataConnect (self) |
Executes caps_triangulate on data set's vertex set to retrieve the connectivity (triangles only) information for the data set. More... | |
def | viewData (self, fig=None, numDataSet=1, dataSetIndex=0, kwargs) |
Visualize data set. More... | |
def | writeTecplot (self, file=None, filename=None) |
Write data set to a Tecplot compatible data file. More... | |
Public Attributes | |
dataSetName | |
Data set name (variable name). More... | |
capsBound | |
Reference to the bound object (pyCAPS._capsBound) that data set pertains to. More... | |
capsVertexSet | |
Reference to the vertex set object (pyCAPS._capsVertexSet) that data set pertains to. More... | |
dataSetMethod | |
Data method: Analysis, Interpolate, Conserve. More... | |
dataRank | |
Rank of data set. More... | |
Functions to interact with a CAPS dataSet object.
Should be initiated within pyCAPS._capsBound (not a standalone class)
def getData | ( | self | ) |
Executes caps_getData on data set object to retrieve data set variable, dataSetName.
def getDataConnect | ( | self | ) |
Executes caps_triangulate on data set's vertex set to retrieve the connectivity (triangles only) information for the data set.
def getDataXYZ | ( | self | ) |
Executes caps_getData on data set object to retrieve XYZ coordinates of the data set.
def viewData | ( | self, | |
fig = None , |
|||
numDataSet = 1 , |
|||
dataSetIndex = 0 , |
|||
kwargs | |||
) |
Visualize data set.
The function currently relies on matplotlib to plot the data.
fig | Figure object (matplotlib::figure) to append image to. |
numDataSet | Number of data sets in $fig. |
dataSetIndex | Index of data set being added to $fig. |
**kwargs | See below. |
Valid keywords:
filename | Save image(s) to file specified (default - None). |
colorMap | Valid string for a, matplotlib::cm, colormap (default - 'Blues'). |
showImage | Show image(s) (default - True). |
def writeTecplot | ( | self, | |
file = None , |
|||
filename = None |
|||
) |
Write data set to a Tecplot compatible data file.
A triagulation of the data set will be used for the connectivity.
file | Optional open file object to append data to. If not provided a filename must be given via the keyword arguement $filename. |
filename | Write Tecplot file with the specified name. |
capsBound |
Reference to the bound object (pyCAPS._capsBound) that data set pertains to.
capsVertexSet |
Reference to the vertex set object (pyCAPS._capsVertexSet) that data set pertains to.
dataRank |
Rank of data set.
dataSetMethod |
Data method: Analysis, Interpolate, Conserve.
dataSetName |
Data set name (variable name).