mglib

Personal IDL library for M. Galloy

single page | use frames     summary     class     fields     routine details     file attributes

vis/vtk/

mgffserialvtk__define.pro


Class description for mgffserialvtk

Properties

Properties in mgffserialvtk

_extra init
file_type get
header get
version get

Routines

Routines from mgffserialvtk__define.pro

result = mgffserialvtk::readConnectivityListSection(nItems, size)

Reads connectivity list section and returns the connectivity list.

result = mgffserialvtk::readPointsSection(nPoints, type)

Reads a POINTS section and returns the points.

mgffserialvtk::readPolydataDataset

Reads the sections of a POLYDATA dataset.

mgffserialvtk::readTextureCoordinatesAttribute, nPoints, dataName, dim, dataType
mgffserialvtk::readVectorsAttribute, nPoints, dataName, dataType
readScalarsAttribute, nPoints, dataName, dataType, numComp
mgffserialvtk::readNormalsAttribute, nPoints, dataName, dataType
mgffserialvtk::readCellData, nCells
mgffserialvtk::readPointData, nPoints
mgffserialvtk::readDataset, datasetType
mgffserialvtk::readTopLevelLine
result = mgffserialvtk::read()
mgffserialvtk::readHeader

Read version line, header line, and file format line.

result = mgffserialvtk::convertVtkTypeToIdlType(vtkType)

Converts a VTK type into an IDL type code.

mgffserialvtk::putBackLine, line
result = mgffserialvtk::getLine()
mgffserialvtk::getData, data

Reads any already dimensioned variable.

mgffserialvtk::getProperty [, version=string] [, file_type=string] [, header=string]

Get properties of the object.

mgffserialvtk::cleanup

Free resources of object.

result = mgffserialvtk::init(filename, _extra=_extra)

Initialize object.

mgffserialvtk__define

Define member variables for the class.

Routine details

top mgffserialvtk::readConnectivityListSection

result = mgffserialvtk::readConnectivityListSection(nItems, size)

Reads connectivity list section and returns the connectivity list.

Return value

Parameters

nItems in required type=integer

the number of polygons

size in required type=integer

total number of elements in the connectivity list

top mgffserialvtk::readPointsSection

result = mgffserialvtk::readPointsSection(nPoints, type)

Reads a POINTS section and returns the points.

Return value

(3, nPoints) array of given type

Parameters

nPoints in required type=integer

number of points

type in required type=integer

IDL type code for the data type of the points

top mgffserialvtk::readPolydataDataset

mgffserialvtk::readPolydataDataset

Reads the sections of a POLYDATA dataset.

top mgffserialvtk::readTextureCoordinatesAttribute

mgffserialvtk::readTextureCoordinatesAttribute, nPoints, dataName, dim, dataType

Parameters

nPoints
dataName
dim
dataType

top mgffserialvtk::readVectorsAttribute

mgffserialvtk::readVectorsAttribute, nPoints, dataName, dataType

Parameters

nPoints
dataName
dataType

top readScalarsAttribute

readScalarsAttribute, nPoints, dataName, dataType, numComp

Parameters

nPoints
dataName
dataType
numComp

top mgffserialvtk::readNormalsAttribute

mgffserialvtk::readNormalsAttribute, nPoints, dataName, dataType

Parameters

nPoints
dataName
dataType

top mgffserialvtk::readCellData

mgffserialvtk::readCellData, nCells

Parameters

nCells

top mgffserialvtk::readPointData

mgffserialvtk::readPointData, nPoints

Parameters

nPoints

top mgffserialvtk::readDataset

mgffserialvtk::readDataset, datasetType

Parameters

datasetType

top mgffserialvtk::readTopLevelLine

mgffserialvtk::readTopLevelLine

top mgffserialvtk::read

result = mgffserialvtk::read()

top mgffserialvtk::readHeader

mgffserialvtk::readHeader

Read version line, header line, and file format line.

top mgffserialvtk::convertVtkTypeToIdlType

result = mgffserialvtk::convertVtkTypeToIdlType(vtkType)

Converts a VTK type into an IDL type code.

Return value

integer

Parameters

vtkType in required type=string

one of the VTK types: bit, unsigned_char, char, unsigned_short, short, unsigned_int, int, unsigned_long, long, float, double

top mgffserialvtk::putBackLine

mgffserialvtk::putBackLine, line

Parameters

line

top mgffserialvtk::getLine

result = mgffserialvtk::getLine()

top mgffserialvtk::getData

mgffserialvtk::getData, data

Reads any already dimensioned variable.

Parameters

data in out required type=any

IDL variable type to be used with READU or READF

top mgffserialvtk::getProperty

mgffserialvtk::getProperty [, version=string] [, file_type=string] [, header=string]

Get properties of the object.

Keywords

version out optional type=string

version of the VTK data file

file_type out optional type=string

either ASCII or BINARY

header out optional type=string

comments about file

top mgffserialvtk::cleanup

mgffserialvtk::cleanup

Free resources of object.

top mgffserialvtk::init

result = mgffserialvtk::init(filename, _extra=_extra)

Initialize object.

Return value

1 for success, 0 for failure

Parameters

filename in required type=string

filename of VTK serial data file

Keywords

_extra

top mgffserialvtk__define

mgffserialvtk__define

Define member variables for the class.

File attributes

Modification date: Wed May 14 15:07:15 2014
Lines: 299
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.