reads meta-files points to PLOT3D files More...

#include <vtkPlot3DMetaReader.h>

Inheritance diagram for vtkPlot3DMetaReader:

Collaboration diagram for vtkPlot3DMetaReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	Superclass

Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPlot3DMetaReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

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

vtkMultiBlockDataSet *	GetOutput ()

vtkMultiBlockDataSet *	GetOutput (int)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

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

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkPlot3DMetaReader *	New ()

static int	IsTypeOf (const char *type)

static vtkPlot3DMetaReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlot3DMetaReader ()

	~vtkPlot3DMetaReader ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetAutoDetectFormat (Json::Value *value)

void	SetByteOrder (Json::Value *value)

void	SetPrecision (Json::Value *val)

void	SetMultiGrid (Json::Value *val)

void	SetFormat (Json::Value *val)

void	SetBlanking (Json::Value *val)

void	Set2D (Json::Value *val)

void	SetR (Json::Value *val)

void	SetGamma (Json::Value *val)

void	SetFileNames (Json::Value *val)

void	SetLanguage (Json::Value *val)

void	AddFunctions (Json::Value *val)

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm ()

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

vtkDataObject *	GetInput (int port)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

reads meta-files points to PLOT3D files

The main goal of this reader is to make it easy to read PLOT3D files, specifically time series of PLOT3D files. PLOT3D files can take many different forms based on their content. Unfortunately, it is not a self-describing format therefore the user needs to pass information about the contents of the file to the reader. Normally, this is done by setting a number of member variables. The goal of this reader is to provide a simple format that enable the writer of the PLOT3D file to describe its settings as well as group a number of files as a time series. Note that for binary files, the auto-detect-format option, which is on by default negates the need to specify most other option. However, this reader is still very useful when trying to read file series even for binary files. The format for this meta-file is very simple and is based on JSON (there is no need to know anything about JSON to understand this format). Below is an example with comments (followed by //) that describe the format. Note that the PLOT3D file names are relative to the location of the meta-file unless they start with a leading /.

{
"auto-detect-format" : true // Tells the reader to try to figure out the format automatically. Only works
                            // with binary file. This is on by default, negating the need for most other
                            // options for binary files (format, byte-order, precision, multi-grid,
                            // blanking, 2D).
"format" : "binary",  // Is this a binary or ascii file, values : binary, ascii
"byte-order" : "big", // Byte order for binary files, values : little, big (denoting little or big endian)
"precision" : 32,     // Precision of floating point values, can be 32 or 64 (bits)
"multi-grid" : false, // Is this a multi-grid file, values: true, false
"language" : "C",     // Which language was this file written in, values : C, fortran. This is
                      // used to determine if an binary PLOT3D file contains byte counts, used by
                      // Fortran IO routines.
"blanking" : false,   // Does this file have blanking information (iblanks), values : true, false
"2D" : false,         // Is this a 2D dataset, values : true, false
"R" : 8.314,          // The value of the gas constant, default is 1.0. Set this according to the dimensions you use
"gamma" : 1.4,        // Ratio of specific heats. Default is 1.4.
"functions": [ 110, 200, 201 ],  // Additional derived values to calculate. This is an array of integers formatted
                                 // as [ value, value, value, ...]
"filenames" : [     // List of xyz (geometry) and q (value) file names along with the time values.
                    // This is an array which contains items in the format:
                    // {"time" : values, "xyz" : "xyz file name", "q" : "q file name", "function" : "function file name"}
                    // Note that q and function are optional. Also, you can repeat the same file name for xyz or q
                    // if they don't change over time. The reader will not read files unnecessarily.
 { "time" : 3.5, "xyz" : "combxyz.bin", "q" : "combq.1.bin", "function" : "combf.1.bin" },
 { "time" : 4.5, "xyz" : "combxyz.bin", "q" : "combq.2.bin", "function" : "combf.2.bin" }
]
}

This reader leverages vtkMultiBlockPLOT3DReader to do the actual reading so you may want to refer to the documenation of vtkMultiBlockPLOT3DReader about the details of some of these parameters including the function numbers for derived value calculation.

See also: vtkMultiBlockPLOT3DReader

Tests:: vtkPlot3DMetaReader (Tests)

Definition at line 95 of file vtkPlot3DMetaReader.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkPlot3DMetaReader::Superclass

Definition at line 99 of file vtkPlot3DMetaReader.h.

Constructor & Destructor Documentation

vtkPlot3DMetaReader::vtkPlot3DMetaReader ( )

protected

vtkPlot3DMetaReader::~vtkPlot3DMetaReader ( )

protected

Member Function Documentation

static vtkPlot3DMetaReader* vtkPlot3DMetaReader::New ( )

static

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

static

virtual int vtkPlot3DMetaReader::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 vtkMultiBlockDataSetAlgorithm.

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

static

virtual vtkObjectBase* vtkPlot3DMetaReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

vtkPlot3DMetaReader* vtkPlot3DMetaReader::NewInstance ( ) const

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

virtual

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

virtual void vtkPlot3DMetaReader::SetFileName ( const char * )

virtual

Set/Get the meta PLOT3D filename. See the class documentation for format details.

virtual char* vtkPlot3DMetaReader::GetFileName ( )

virtual

Set/Get the meta PLOT3D filename. See the class documentation for format details.

virtual int vtkPlot3DMetaReader::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

virtual int vtkPlot3DMetaReader::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

void vtkPlot3DMetaReader::SetAutoDetectFormat ( Json::Value * value )

protected

void vtkPlot3DMetaReader::SetByteOrder ( Json::Value * value )

protected

void vtkPlot3DMetaReader::SetPrecision ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetMultiGrid ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetFormat ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetBlanking ( Json::Value * val )

protected

void vtkPlot3DMetaReader::Set2D ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetR ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetGamma ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetFileNames ( Json::Value * val )

protected

void vtkPlot3DMetaReader::SetLanguage ( Json::Value * val )

protected

void vtkPlot3DMetaReader::AddFunctions ( Json::Value * val )

protected

Member Data Documentation

char* vtkPlot3DMetaReader::FileName

protected

Definition at line 121 of file vtkPlot3DMetaReader.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Parallel/vtkPlot3DMetaReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation