vtkSLACParticleReader Class Reference
#include <vtkSLACParticleReader.h>
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 some conventions to store a list of particles in 3D space.This reader supports pieces, but in actuality only loads anything in piece 0. All other pieces are empty.
Definition at line 50 of file vtkSLACParticleReader.h.
Public Types | |
| typedef vtkPolyDataAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual char * | GetFileName () |
| virtual void | SetFileName (const char *) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkSLACParticleReader * | SafeDownCast (vtkObject *o) |
| static vtkSLACParticleReader * | New () |
| static int | CanReadFile (const char *filename) |
Protected Member Functions | |
| vtkSLACParticleReader () | |
| ~vtkSLACParticleReader () | |
| virtual int | RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| virtual vtkIdType | GetNumTuplesInVariable (int ncFD, int varId, int expectedNumComponents) |
Protected Attributes | |
| char * | FileName |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkSLACParticleReader::vtkSLACParticleReader | ( | ) | [protected] |
| vtkSLACParticleReader::~vtkSLACParticleReader | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkSLACParticleReader::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkPolyDataAlgorithm.
| static int vtkSLACParticleReader::IsTypeOf | ( | const char * | name | ) | [static] |
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.
Reimplemented from vtkPolyDataAlgorithm.
| virtual int vtkSLACParticleReader::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 vtkPolyDataAlgorithm.
| static vtkSLACParticleReader* vtkSLACParticleReader::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkPolyDataAlgorithm.
| static vtkSLACParticleReader* vtkSLACParticleReader::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkPolyDataAlgorithm.
| virtual void vtkSLACParticleReader::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 vtkPolyDataAlgorithm.
| virtual char* vtkSLACParticleReader::GetFileName | ( | ) | [virtual] |
| virtual void vtkSLACParticleReader::SetFileName | ( | const char * | ) | [virtual] |
| static int vtkSLACParticleReader::CanReadFile | ( | const char * | filename | ) | [static] |
Returns true if the given file can be read by this reader.
| virtual int vtkSLACParticleReader::RequestInformation | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
Reimplemented from vtkPolyDataAlgorithm.
| virtual int vtkSLACParticleReader::RequestData | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkPolyDataAlgorithm.
| virtual vtkIdType vtkSLACParticleReader::GetNumTuplesInVariable | ( | int | ncFD, | |
| int | varId, | |||
| int | expectedNumComponents | |||
| ) | [protected, virtual] |
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.
Member Data Documentation
char* vtkSLACParticleReader::FileName [protected] |
Definition at line 67 of file vtkSLACParticleReader.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkSLACParticleReader.h
