A reader for a data format used by Omega3p, Tau3p, and several other tools used at the Standford Linear Accelerator Center (SLAC). More...

#include <vtkSLACReader.h>

Inheritance diagram for vtkSLACReader:

[legend]

Collaboration diagram for vtkSLACReader:

[legend]

Classes
class	EdgeEndpoints
	Simple class used internally to define an edge based on the endpoints. More...

class	MidpointCoordinateMap
	Manages a map from edges to midpoint coordinates. More...

class	MidpointCoordinates
	Simple class used internally for holding midpoint information. More...

class	MidpointIdMap
	Manages a map from edges to the point id of the midpoint. More...

Public Types
enum	{ SURFACE_OUTPUT = 0, VOLUME_OUTPUT = 1, NUM_OUTPUTS = 2 }

typedef vtkMultiBlockDataSetAlgorithm	Superclass

Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkSLACReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual char *	GetMeshFileName ()

virtual void	SetMeshFileName (const char *)


virtual void	AddModeFileName (const char *fname)
	There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series). More...

virtual void	RemoveAllModeFileNames ()
	There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series). More...

virtual unsigned int	GetNumberOfModeFileNames ()
	There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series). More...

virtual const char *	GetModeFileName (unsigned int idx)
	There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series). More...


virtual vtkTypeBool	GetReadInternalVolume ()
	If on, reads the internal volume of the data set. More...

virtual void	SetReadInternalVolume (vtkTypeBool)
	If on, reads the internal volume of the data set. More...

virtual void	ReadInternalVolumeOn ()
	If on, reads the internal volume of the data set. More...

virtual void	ReadInternalVolumeOff ()
	If on, reads the internal volume of the data set. More...


virtual vtkTypeBool	GetReadExternalSurface ()
	If on, reads the external surfaces of the data set. More...

virtual void	SetReadExternalSurface (vtkTypeBool)
	If on, reads the external surfaces of the data set. More...

virtual void	ReadExternalSurfaceOn ()
	If on, reads the external surfaces of the data set. More...

virtual void	ReadExternalSurfaceOff ()
	If on, reads the external surfaces of the data set. More...


virtual vtkTypeBool	GetReadMidpoints ()
	If on, reads midpoint information for external surfaces and builds quadratic surface triangles. More...

virtual void	SetReadMidpoints (vtkTypeBool)
	If on, reads midpoint information for external surfaces and builds quadratic surface triangles. More...

virtual void	ReadMidpointsOn ()
	If on, reads midpoint information for external surfaces and builds quadratic surface triangles. More...

virtual void	ReadMidpointsOff ()
	If on, reads midpoint information for external surfaces and builds quadratic surface triangles. More...


virtual int	GetNumberOfVariableArrays ()
	Variable array selection. More...

virtual const char *	GetVariableArrayName (int idx)
	Variable array selection. More...

virtual int	GetVariableArrayStatus (const char *name)
	Variable array selection. More...

virtual void	SetVariableArrayStatus (const char *name, int status)
	Variable array selection. More...


virtual void	ResetFrequencyScales ()
	Sets the scale factor for each mode. More...

virtual void	SetFrequencyScale (int index, double scale)
	Sets the scale factor for each mode. More...


virtual void	ResetPhaseShifts ()
	Sets the phase offset for each mode. More...

virtual void	SetPhaseShift (int index, double shift)
	Sets the phase offset for each mode. More...


virtual vtkDoubleArray *	GetFrequencyScales ()
	NOTE: This is not thread-safe. More...

virtual vtkDoubleArray *	GetPhaseShifts ()
	NOTE: This is not thread-safe. More...

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

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details More...

vtkMultiBlockDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkMultiBlockDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

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

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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 ()

vtkTypeBool	HasObserver (unsigned long event)

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

vtkCommand *	GetCommand (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...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSLACReader *	SafeDownCast (vtkObjectBase *o)

static vtkSLACReader *	New ()

static int	CanReadFile (const char *filename)
	Returns true if the given file can be read by this reader. More...

static vtkInformationIntegerKey *	IS_INTERNAL_VOLUME ()
	This key is attached to the metadata information of all data sets in the output that are part of the internal volume. More...

static vtkInformationIntegerKey *	IS_EXTERNAL_SURFACE ()
	This key is attached to the metadata information of all data sets in the output that are part of the external surface. More...


static vtkInformationObjectBaseKey *	POINTS ()
	All the data sets stored in the multiblock output share the same point data. More...

static vtkInformationObjectBaseKey *	POINT_DATA ()
	All the data sets stored in the multiblock output share the same point data. More...

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Types
enum	{ NumPerTetInt = 5, NumPerTetExt = 9 }
	Helpful constants equal to the amount of identifiers per tet. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSLACReader ()

	~vtkSLACReader () override

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	This is called by the superclass. More...

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	This is called by the superclass. More...

virtual vtkIdType	GetNumTuplesInVariable (int ncFD, int varId, int expectedNumComponents)
	Convenience function that checks the dimensions of a 2D netCDF array that is supposed to be a set of tuples. More...

virtual int	CheckTetrahedraWinding (int meshFD)
	Checks the winding of the tetrahedra in the mesh file. More...

virtual int	ReadConnectivity (int meshFD, vtkMultiBlockDataSet surfaceOutput, vtkMultiBlockDataSet volumeOutput)
	Read the connectivity information from the mesh file. More...

virtual vtkSmartPointer< vtkDataArray >	ReadPointDataArray (int ncFD, int varId)
	Reads point data arrays. More...


virtual int	ReadTetrahedronInteriorArray (int meshFD, vtkIdTypeArray *connectivity)
	Reads tetrahedron connectivity arrays. More...

virtual int	ReadTetrahedronExteriorArray (int meshFD, vtkIdTypeArray *connectivity)
	Reads tetrahedron connectivity arrays. More...

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm () override

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...

vtkDataObject *	GetInput (int port)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. 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=nullptr)
	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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	SelectionModifiedCallback (vtkObject caller, unsigned long eid, void clientdata, void *calldata)
	Callback registered with the VariableArraySelection. More...

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

Protected Attributes
vtkInternal *	Internal

char *	MeshFileName

vtkTypeBool	ReadInternalVolume

vtkTypeBool	ReadExternalSurface

vtkTypeBool	ReadMidpoints

bool	ReadModeData
	True if reading from a proper mode file. More...

bool	TimeStepModes
	True if "mode" files are a sequence of time steps. More...

bool	FrequencyModes
	True if mode files describe vibrating fields. More...

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkInternal

vtkTimeStamp	MeshReadTime
	A time stamp for the last time the mesh file was read. More...

virtual int	ReadCoordinates (int meshFD, vtkMultiBlockDataSet *output)
	Read in the point coordinate data from the mesh file. More...

virtual int	ReadMidpointCoordinates (int meshFD, vtkMultiBlockDataSet *output, MidpointCoordinateMap &map)
	Reads in the midpoint coordinate data from the mesh file and returns a map from edges to midpoints. More...

virtual int	ReadMidpointData (int meshFD, vtkMultiBlockDataSet *output, MidpointIdMap &map)
	Read in the midpoint data from the mesh file. More...

virtual int	RestoreMeshCache (vtkMultiBlockDataSet surfaceOutput, vtkMultiBlockDataSet volumeOutput, vtkMultiBlockDataSet *compositeOutput)
	Instead of reading data from the mesh file, restore the data from the previous mesh file read. More...

virtual int	ReadFieldData (const int modeFDArray, int numModeFDs, vtkMultiBlockDataSet output)
	Read in the field data from the mode file. More...

virtual int	InterpolateMidpointData (vtkMultiBlockDataSet *output, MidpointIdMap &map)
	Takes the data read on the fields and interpolates data for the midpoints. More...

virtual int	MeshUpToDate ()
	Returns 1 if the mesh is up to date, 0 if the mesh needs to be read from disk. More...

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

A reader for a data format used by Omega3p, Tau3p, and several other tools used at the Standford Linear Accelerator Center (SLAC).

The underlying format uses netCDF to store arrays, but also imposes several conventions to form an unstructured grid of elements.

Tests:: vtkSLACReader (Tests)

Definition at line 52 of file vtkSLACReader.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkSLACReader::Superclass

Definition at line 55 of file vtkSLACReader.h.

Member Enumeration Documentation

anonymous enum

Enumerator
SURFACE_OUTPUT
VOLUME_OUTPUT
NUM_OUTPUTS

Definition at line 214 of file vtkSLACReader.h.

anonymous enum

protected

Helpful constants equal to the amount of identifiers per tet.

Enumerator
NumPerTetInt
NumPerTetExt

Definition at line 307 of file vtkSLACReader.h.

Constructor & Destructor Documentation

vtkSLACReader::vtkSLACReader ( )

protected

vtkSLACReader::~vtkSLACReader ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkSLACReader::IsTypeOf ( const char * type )

static

virtual vtkTypeBool vtkSLACReader::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.

Reimplemented in vtkPSLACReader.

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

static

virtual vtkObjectBase* vtkSLACReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPSLACReader.

vtkSLACReader* vtkSLACReader::NewInstance ( ) const

static vtkSLACReader* vtkSLACReader::New ( )

static

void vtkSLACReader::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPSLACReader.

virtual char* vtkSLACReader::GetMeshFileName ( )

virtual

virtual void vtkSLACReader::SetMeshFileName ( const char * )

virtual

virtual void vtkSLACReader::AddModeFileName ( const char * fname )

virtual

There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series).

These methods set and clear the list of mode files (which can be a single mode file).

virtual void vtkSLACReader::RemoveAllModeFileNames ( )

virtual

There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series).

These methods set and clear the list of mode files (which can be a single mode file).

virtual unsigned int vtkSLACReader::GetNumberOfModeFileNames ( )

virtual

There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series).

These methods set and clear the list of mode files (which can be a single mode file).

virtual const char* vtkSLACReader::GetModeFileName ( unsigned int idx )

virtual

There may be one mode file (usually for actual modes) or multiple mode files (which usually actually represent time series).

These methods set and clear the list of mode files (which can be a single mode file).

virtual vtkTypeBool vtkSLACReader::GetReadInternalVolume ( )

virtual

If on, reads the internal volume of the data set.

Set to off by default.

virtual void vtkSLACReader::SetReadInternalVolume ( vtkTypeBool )

virtual

If on, reads the internal volume of the data set.

Set to off by default.

virtual void vtkSLACReader::ReadInternalVolumeOn ( )

virtual

If on, reads the internal volume of the data set.

Set to off by default.

virtual void vtkSLACReader::ReadInternalVolumeOff ( )

virtual

If on, reads the internal volume of the data set.

Set to off by default.

virtual vtkTypeBool vtkSLACReader::GetReadExternalSurface ( )

virtual

If on, reads the external surfaces of the data set.

Set to on by default.

virtual void vtkSLACReader::SetReadExternalSurface ( vtkTypeBool )

virtual

If on, reads the external surfaces of the data set.

Set to on by default.

virtual void vtkSLACReader::ReadExternalSurfaceOn ( )

virtual

If on, reads the external surfaces of the data set.

Set to on by default.

virtual void vtkSLACReader::ReadExternalSurfaceOff ( )

virtual

If on, reads the external surfaces of the data set.

Set to on by default.

virtual vtkTypeBool vtkSLACReader::GetReadMidpoints ( )

virtual

If on, reads midpoint information for external surfaces and builds quadratic surface triangles.

Set to on by default.

virtual void vtkSLACReader::SetReadMidpoints ( vtkTypeBool )

virtual

If on, reads midpoint information for external surfaces and builds quadratic surface triangles.

Set to on by default.

virtual void vtkSLACReader::ReadMidpointsOn ( )

virtual

If on, reads midpoint information for external surfaces and builds quadratic surface triangles.

Set to on by default.

virtual void vtkSLACReader::ReadMidpointsOff ( )

virtual

If on, reads midpoint information for external surfaces and builds quadratic surface triangles.

Set to on by default.

virtual int vtkSLACReader::GetNumberOfVariableArrays ( )

virtual

Variable array selection.

virtual const char* vtkSLACReader::GetVariableArrayName ( int idx )

virtual

Variable array selection.

virtual int vtkSLACReader::GetVariableArrayStatus ( const char * name )

virtual

Variable array selection.

virtual void vtkSLACReader::SetVariableArrayStatus	(	const char *	name,
		int	status
	)

virtual

Variable array selection.

virtual void vtkSLACReader::ResetFrequencyScales ( )

virtual

Sets the scale factor for each mode.

Each scale factor is reset to 1.

virtual void vtkSLACReader::SetFrequencyScale	(	int	index,
		double	scale
	)

virtual

Sets the scale factor for each mode.

Each scale factor is reset to 1.

virtual void vtkSLACReader::ResetPhaseShifts ( )

virtual

Sets the phase offset for each mode.

Each shift is reset to 0.

virtual void vtkSLACReader::SetPhaseShift	(	int	index,
		double	shift
	)

virtual

Sets the phase offset for each mode.

Each shift is reset to 0.

virtual vtkDoubleArray* vtkSLACReader::GetFrequencyScales ( )

virtual

NOTE: This is not thread-safe.

virtual vtkDoubleArray* vtkSLACReader::GetPhaseShifts ( )

virtual

NOTE: This is not thread-safe.

static int vtkSLACReader::CanReadFile ( const char * filename )

static

Returns true if the given file can be read by this reader.

static vtkInformationIntegerKey* vtkSLACReader::IS_INTERNAL_VOLUME ( )

static

This key is attached to the metadata information of all data sets in the output that are part of the internal volume.

static vtkInformationIntegerKey* vtkSLACReader::IS_EXTERNAL_SURFACE ( )

static

This key is attached to the metadata information of all data sets in the output that are part of the external surface.

static vtkInformationObjectBaseKey* vtkSLACReader::POINTS ( )

static

All the data sets stored in the multiblock output share the same point data.

For convenience, the point coordinates (vtkPoints) and point data (vtkPointData) are saved under these keys in the vtkInformation of the output data set.

static vtkInformationObjectBaseKey* vtkSLACReader::POINT_DATA ( )

static

All the data sets stored in the multiblock output share the same point data.

For convenience, the point coordinates (vtkPoints) and point data (vtkPointData) are saved under these keys in the vtkInformation of the output data set.

int vtkSLACReader::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPSLACReader.

int vtkSLACReader::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkPSLACReader.

static void vtkSLACReader::SelectionModifiedCallback	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientdata,
		void *	calldata
	)

staticprotected

Callback registered with the VariableArraySelection.

virtual vtkIdType vtkSLACReader::GetNumTuplesInVariable	(	int	ncFD,
		int	varId,
		int	expectedNumComponents
	)

protectedvirtual

Convenience function that checks the dimensions of a 2D netCDF array that is supposed to be a set of tuples.

It makes sure that the number of dimensions is expected and that the number of components in each tuple agree with what is expected. It then returns the number of tuples. An error is emitted and 0 is returned if the checks fail.

virtual int vtkSLACReader::CheckTetrahedraWinding ( int meshFD )

protectedvirtual

Checks the winding of the tetrahedra in the mesh file.

Returns 1 if the winding conforms to VTK, 0 if the winding needs to be corrected.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadConnectivity	(	int	meshFD,
		vtkMultiBlockDataSet *	surfaceOutput,
		vtkMultiBlockDataSet *	volumeOutput
	)

protectedvirtual

Read the connectivity information from the mesh file.

Returns 1 on success, 0 on failure.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadTetrahedronInteriorArray	(	int	meshFD,
		vtkIdTypeArray *	connectivity
	)

protectedvirtual

Reads tetrahedron connectivity arrays.

Called by ReadConnectivity.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadTetrahedronExteriorArray	(	int	meshFD,
		vtkIdTypeArray *	connectivity
	)

protectedvirtual

Reads tetrahedron connectivity arrays.

Called by ReadConnectivity.

Reimplemented in vtkPSLACReader.

virtual vtkSmartPointer<vtkDataArray> vtkSLACReader::ReadPointDataArray	(	int	ncFD,
		int	varId
	)

protectedvirtual

Reads point data arrays.

Called by ReadCoordinates and ReadFieldData.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadCoordinates	(	int	meshFD,
		vtkMultiBlockDataSet *	output
	)

protectedvirtual

Read in the point coordinate data from the mesh file.

Returns 1 on success, 0 on failure.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadMidpointCoordinates	(	int	meshFD,
		vtkMultiBlockDataSet *	output,
		MidpointCoordinateMap &	map
	)

protectedvirtual

Reads in the midpoint coordinate data from the mesh file and returns a map from edges to midpoints.

This method is called by ReadMidpointData. Returns 1 on success, 0 on failure.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadMidpointData	(	int	meshFD,
		vtkMultiBlockDataSet *	output,
		MidpointIdMap &	map
	)

protectedvirtual

Read in the midpoint data from the mesh file.

Returns 1 on success, 0 on failure. Also fills a midpoint id map that will be passed into InterpolateMidpointFieldData.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::RestoreMeshCache	(	vtkMultiBlockDataSet *	surfaceOutput,
		vtkMultiBlockDataSet *	volumeOutput,
		vtkMultiBlockDataSet *	compositeOutput
	)

protectedvirtual

Instead of reading data from the mesh file, restore the data from the previous mesh file read.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::ReadFieldData	(	const int *	modeFDArray,
		int	numModeFDs,
		vtkMultiBlockDataSet *	output
	)

protectedvirtual

Read in the field data from the mode file.

Returns 1 on success, 0 on failure.

Reimplemented in vtkPSLACReader.

virtual int vtkSLACReader::InterpolateMidpointData	(	vtkMultiBlockDataSet *	output,
		MidpointIdMap &	map
	)

protectedvirtual

Takes the data read on the fields and interpolates data for the midpoints.

map is the same map that was created in ReadMidpointData.

virtual int vtkSLACReader::MeshUpToDate ( )

protectedvirtual

Returns 1 if the mesh is up to date, 0 if the mesh needs to be read from disk.

Reimplemented in vtkPSLACReader.

Friends And Related Function Documentation

friend class vtkInternal

friend

Definition at line 229 of file vtkSLACReader.h.

Member Data Documentation

vtkInternal* vtkSLACReader::Internal

protected

Definition at line 224 of file vtkSLACReader.h.

char* vtkSLACReader::MeshFileName

protected

Definition at line 231 of file vtkSLACReader.h.

vtkTypeBool vtkSLACReader::ReadInternalVolume

protected

Definition at line 233 of file vtkSLACReader.h.

vtkTypeBool vtkSLACReader::ReadExternalSurface

protected

Definition at line 234 of file vtkSLACReader.h.

vtkTypeBool vtkSLACReader::ReadMidpoints

protected

Definition at line 235 of file vtkSLACReader.h.

bool vtkSLACReader::ReadModeData

protected

True if reading from a proper mode file.

Set in RequestInformation.

Definition at line 240 of file vtkSLACReader.h.

bool vtkSLACReader::TimeStepModes

protected

True if "mode" files are a sequence of time steps.

Definition at line 245 of file vtkSLACReader.h.

bool vtkSLACReader::FrequencyModes

protected

True if mode files describe vibrating fields.

Definition at line 250 of file vtkSLACReader.h.

vtkTimeStamp vtkSLACReader::MeshReadTime

protected

A time stamp for the last time the mesh file was read.

This is used to determine whether the mesh needs to be read in again or if we just need to read the mode data.

Definition at line 435 of file vtkSLACReader.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/IO/NetCDF/vtkSLACReader.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation