VTK: vtkParticleReader Class Reference

| VTK 9.3.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkParticleReader Class Reference

Read ASCII or binary particle data and (optionally) one scalar value associated with each particle. More...

`#include <vtkParticleReader.h>`

Inheritance diagram for vtkParticleReader:
[legend]
Collaboration diagram for vtkParticleReader:
[legend]

## Public Types
typedef vtkPolyDataAlgorithm | Superclass
Public Types inherited from vtkPolyDataAlgorithm
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...
vtkParticleReader * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
| vtkSetFilePathMacro (FileName)
| Specify file name. More...
| vtkGetFilePathMacro (FileName)
| Specify file name. More...
void | SetDataByteOrderToBigEndian ()
| These methods should be used instead of the SwapBytes methods. More...
void | SetDataByteOrderToLittleEndian ()
| These methods should be used instead of the SwapBytes methods. More...
int | GetDataByteOrder ()
| These methods should be used instead of the SwapBytes methods. More...
void | SetDataByteOrder (int)
| These methods should be used instead of the SwapBytes methods. More...
const char * | GetDataByteOrderAsString ()
| These methods should be used instead of the SwapBytes methods. More...
virtual void | SetSwapBytes (vtkTypeBool)
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
vtkTypeBool | GetSwapBytes ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | SwapBytesOn ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | SwapBytesOff ()
| Set/Get the byte swapping to explicitly swap the bytes of a file. More...
virtual void | SetHasScalar (vtkTypeBool)
| Default: 1. More...
virtual vtkTypeBool | GetHasScalar ()
| Default: 1. More...
virtual void | HasScalarOn ()
| Default: 1. More...
virtual void | HasScalarOff ()
| Default: 1. More...
virtual void | SetFileType (int)
| Get/Set the file type. More...
virtual int | GetFileType ()
| Get/Set the file type. More...
void | SetFileTypeToUnknown ()
| Get/Set the file type. More...
void | SetFileTypeToText ()
| Get/Set the file type. More...
void | SetFileTypeToBinary ()
| Get/Set the file type. More...
virtual void | SetDataType (int)
| Get/Set the data type. More...
virtual int | GetDataType ()
| Get/Set the data type. More...
void | SetDataTypeToFloat ()
| Get/Set the data type. More...
void | SetDataTypeToDouble ()
| Get/Set the data type. More...
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm * | NewInstance () const
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| see vtkAlgorithm for details More...
vtkDataObject * | GetInput ()
vtkDataObject * | GetInput (int port)
vtkPolyData * | GetPolyDataInput (int port)
vtkPolyData * | GetOutput ()
| Get the output data object for a port on this algorithm. More...
vtkPolyData * | GetOutput (int)
| Get the output data object for a port on this algorithm. More...
virtual void | SetOutput (vtkDataObject *d)
| 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...
void | AddInputData (vtkDataObject *)
| Assign a data object as input. More...
void | AddInputData (int, vtkDataObject *)
| Assign a data object as input. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | 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...
vtkTypeBool | 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 | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. 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 vtkTypeBool | 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 vtkTypeBool | 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...
bool | UsesGarbageCollector () const 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 double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
void | SetProgressShiftScale (double shift, double scale)
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressShift ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. 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 (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | 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)
vtkTypeBool | InvokeEvent (unsigned long event)
vtkTypeBool | InvokeEvent (const char *event)
std::string | GetObjectDescription () const override
| The object description printed in messages and PrintSelf output. More...
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...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
Public Member Functions inherited from vtkObjectBase
const char * | GetClassName () const
| Return the class name as a string. More...
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name)
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
virtual void | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
int | GetReferenceCount ()
| Return the current reference count of this object. More...
void | SetReferenceCount (int)
| Sets the reference count. More...
bool | GetIsInMemkind () const
| A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkParticleReader * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkParticleReader * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkPolyDataAlgorithm * | 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 vtkInformationIntegerKey * | ABORTED ()
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 (vtkTypeBool 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 vtkTypeBool | 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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name)
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void | SetMemkindDirectory (const char *directoryname)
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool | GetUsingMemkind ()
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

## Protected Types
enum | FILE_TYPE { FILE_TYPE_IS_UNKNOWN = 0 , FILE_TYPE_IS_TEXT , FILE_TYPE_IS_BINARY }
| Enumerate the supported file types. More...

## Protected Member Functions
virtual vtkObjectBase * | NewInstanceInternal () const
| vtkParticleReader ()
| ~vtkParticleReader () override
void | OpenFile ()
int | RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| This is called by the superclass. More...
int | DetermineFileType ()
| Determine the type of file based on an analysis of its contents. More...
void | DoProgressUpdate (size_t &bytesRead, size_t &fileLength)
| Update of the progress. More...
int | ProduceOutputFromTextFileDouble (vtkInformationVector *outputVector)
| The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value associated with the particle). More...
int | ProduceOutputFromTextFileFloat (vtkInformationVector *outputVector)
| The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value associated with the particle). More...
int | ProduceOutputFromBinaryFileDouble (vtkInformationVector *outputVector)
| This reader assumes that the file is binary and consists of floating point values by default. More...
int | ProduceOutputFromBinaryFileFloat (vtkInformationVector *outputVector)
| This reader assumes that the file is binary and consists of floating point values by default. More...
Protected Member Functions inherited from vtkPolyDataAlgorithm
| vtkPolyDataAlgorithm ()
| ~vtkPolyDataAlgorithm () override
virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
| This is called by the superclass. 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...
Protected Member Functions inherited from vtkAlgorithm
| vtkAlgorithm ()
| ~vtkAlgorithm () override
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. More...
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 association 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...
virtual vtkExecutive * | CreateDefaultExecutive ()
| Create a default executive. 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 ()
| vtkObjectBase (const vtkObjectBase &)
void | operator= (const vtkObjectBase &)

## Protected Attributes
char * | FileName
istream * | File
vtkTypeBool | HasScalar
int | FileType
| Used to decide which reader should be used. More...
int | DataType
| Used to specify the data type. More...
size_t | Alliquot
| Set an alliquot of bytes. More...
size_t | Count
| Count of the number of alliquots processed. More...
vtkTypeBool | SwapBytes
size_t | NumberOfPoints
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp | LastAbortCheckTime
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
std::string | ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > | ReferenceCount
vtkWeakPointerBase ** | WeakPointers

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction | GetCurrentMallocFunction ()
static vtkReallocingFunction | GetCurrentReallocFunction ()
static vtkFreeingFunction | GetCurrentFreeFunction ()
static vtkFreeingFunction | GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

Read ASCII or binary particle data and (optionally) one scalar value associated with each particle.

vtkParticleReader reads either a binary or a text file of particles. Each particle can have associated with it an optional scalar value. So the format is: x, y, z, scalar (all floats or doubles). The text file can consist of a comma delimited set of values. In most cases vtkParticleReader can automatically determine whether the file is text or binary. The data can be either float or double. Progress updates are provided. With respect to binary files, random access into the file to read pieces is supported.

Examples:
  vtkParticleReader (Examples)

Online Examples:

Tests:
  vtkParticleReader (Tests)

Definition at line 47 of file vtkParticleReader.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkPolyDataAlgorithm vtkParticleReader::Superclass

Definition at line 51 of file vtkParticleReader.h.

## Member Enumeration Documentation

## ◆ FILE_TYPE

enum vtkParticleReader::FILE_TYPE
| protected

Enumerate the supported file types.

- FILE_TYPE_IS_UNKNOWN, (default) the class will attempt to determine the file type.
- FILE_TYPE_IS_TEXT, the file type is text.
- FILE_TYPE_IS_BINARY, the file type is binary.

Enumerator
FILE_TYPE_IS_UNKNOWN |
FILE_TYPE_IS_TEXT |
FILE_TYPE_IS_BINARY |

Definition at line 192 of file vtkParticleReader.h.

## Constructor & Destructor Documentation

## ◆ vtkParticleReader()

vtkParticleReader::vtkParticleReader | ( |  | ) |
| protected

## ◆ ~vtkParticleReader()

vtkParticleReader::~vtkParticleReader | ( |  | ) |
| overrideprotected

## Member Function Documentation

## ◆ New()

static vtkParticleReader* vtkParticleReader::New | ( |  | ) |
| static

## ◆ IsTypeOf()

static vtkTypeBool vtkParticleReader::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

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

## ◆ SafeDownCast()

static vtkParticleReader* vtkParticleReader::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkParticleReader::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

## ◆ NewInstance()

vtkParticleReader* vtkParticleReader::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkParticleReader::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 vtkPolyDataAlgorithm.

## ◆ vtkSetFilePathMacro()

vtkParticleReader::vtkSetFilePathMacro | ( | FileName |  | ) |

Specify file name.

## ◆ vtkGetFilePathMacro()

vtkParticleReader::vtkGetFilePathMacro | ( | FileName |  | ) |

Specify file name.

## ◆ SetDataByteOrderToBigEndian()

void vtkParticleReader::SetDataByteOrderToBigEndian | ( |  | ) |

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

## ◆ SetDataByteOrderToLittleEndian()

void vtkParticleReader::SetDataByteOrderToLittleEndian | ( |  | ) |

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

## ◆ GetDataByteOrder()

int vtkParticleReader::GetDataByteOrder | ( |  | ) |

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

## ◆ SetDataByteOrder()

void vtkParticleReader::SetDataByteOrder | ( | int |  | ) |

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

## ◆ GetDataByteOrderAsString()

const char* vtkParticleReader::GetDataByteOrderAsString | ( |  | ) |

These methods should be used instead of the SwapBytes methods.

They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

## ◆ SetSwapBytes()

virtual void vtkParticleReader::SetSwapBytes | ( | vtkTypeBool |  | ) |
| virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

Not used when reading text files.

## ◆ GetSwapBytes()

vtkTypeBool vtkParticleReader::GetSwapBytes | ( |  | ) |
| inline

Set/Get the byte swapping to explicitly swap the bytes of a file.

Not used when reading text files.

Definition at line 90 of file vtkParticleReader.h.

## ◆ SwapBytesOn()

virtual void vtkParticleReader::SwapBytesOn | ( |  | ) |
| virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

Not used when reading text files.

## ◆ SwapBytesOff()

virtual void vtkParticleReader::SwapBytesOff | ( |  | ) |
| virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

Not used when reading text files.

## ◆ SetHasScalar()

virtual void vtkParticleReader::SetHasScalar | ( | vtkTypeBool |  | ) |
| virtual

Default: 1.

If 1 then each particle has a value associated with it.

## ◆ GetHasScalar()

virtual vtkTypeBool vtkParticleReader::GetHasScalar | ( |  | ) |
| virtual

Default: 1.

If 1 then each particle has a value associated with it.

## ◆ HasScalarOn()

virtual void vtkParticleReader::HasScalarOn | ( |  | ) |
| virtual

Default: 1.

If 1 then each particle has a value associated with it.

## ◆ HasScalarOff()

virtual void vtkParticleReader::HasScalarOff | ( |  | ) |
| virtual

Default: 1.

If 1 then each particle has a value associated with it.

## ◆ SetFileType()

virtual void vtkParticleReader::SetFileType | ( | int |  | ) |
| virtual

Get/Set the file type.

The options are:

- FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
- FILE_TYPE_IS_TEXT the file type is text.
- FILE_TYPE_IS_BINARY the file type is binary.

## ◆ GetFileType()

virtual int vtkParticleReader::GetFileType | ( |  | ) |
| virtual

Get/Set the file type.

The options are:

- FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
- FILE_TYPE_IS_TEXT the file type is text.
- FILE_TYPE_IS_BINARY the file type is binary.

## ◆ SetFileTypeToUnknown()

void vtkParticleReader::SetFileTypeToUnknown | ( |  | ) |
| inline

Get/Set the file type.

The options are:

- FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
- FILE_TYPE_IS_TEXT the file type is text.
- FILE_TYPE_IS_BINARY the file type is binary.

Definition at line 115 of file vtkParticleReader.h.

## ◆ SetFileTypeToText()

void vtkParticleReader::SetFileTypeToText | ( |  | ) |
| inline

Get/Set the file type.

The options are:

- FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
- FILE_TYPE_IS_TEXT the file type is text.
- FILE_TYPE_IS_BINARY the file type is binary.

Definition at line 116 of file vtkParticleReader.h.

## ◆ SetFileTypeToBinary()

void vtkParticleReader::SetFileTypeToBinary | ( |  | ) |
| inline

Get/Set the file type.

The options are:

- FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
- FILE_TYPE_IS_TEXT the file type is text.
- FILE_TYPE_IS_BINARY the file type is binary.

Definition at line 117 of file vtkParticleReader.h.

## ◆ SetDataType()

virtual void vtkParticleReader::SetDataType | ( | int |  | ) |
| virtual

Get/Set the data type.

The options are:

- VTK_FLOAT (default) single precision floating point.
- VTK_DOUBLE double precision floating point.

## ◆ GetDataType()

virtual int vtkParticleReader::GetDataType | ( |  | ) |
| virtual

Get/Set the data type.

The options are:

- VTK_FLOAT (default) single precision floating point.
- VTK_DOUBLE double precision floating point.

## ◆ SetDataTypeToFloat()

void vtkParticleReader::SetDataTypeToFloat | ( |  | ) |
| inline

Get/Set the data type.

The options are:

- VTK_FLOAT (default) single precision floating point.
- VTK_DOUBLE double precision floating point.

Definition at line 128 of file vtkParticleReader.h.

## ◆ SetDataTypeToDouble()

void vtkParticleReader::SetDataTypeToDouble | ( |  | ) |
| inline

Get/Set the data type.

The options are:

- VTK_FLOAT (default) single precision floating point.
- VTK_DOUBLE double precision floating point.

Definition at line 129 of file vtkParticleReader.h.

## ◆ OpenFile()

void vtkParticleReader::OpenFile | ( |  | ) |
| protected

## ◆ RequestInformation()

int vtkParticleReader::RequestInformation | ( | vtkInformation * | ,
|  | vtkInformationVector ** | ,
|  | vtkInformationVector * |
| ) |  |
| overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

## ◆ RequestData()

int vtkParticleReader::RequestData | ( | vtkInformation * | request,
|  | vtkInformationVector ** | inputVector,
|  | vtkInformationVector * | outputVector
| ) |  |
| overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

## ◆ ProduceOutputFromTextFileDouble()

int vtkParticleReader::ProduceOutputFromTextFileDouble | ( | vtkInformationVector * | outputVector | ) |
| protected

The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value associated with the particle).

Each line corresponding to a particle is terminated with a line feed. If y, z, or s is missing, zero is substituted for them. Comment lines in the file are handled as follows: 1) Any line containing "\/\/" "\#" "\%" anywhere in the line is discarded. 2) Lines containing "\/\*" are discarded until a "\*\/" is found. The line following the "\*\/" will be read.

## ◆ ProduceOutputFromTextFileFloat()

int vtkParticleReader::ProduceOutputFromTextFileFloat | ( | vtkInformationVector * | outputVector | ) |
| protected

The format that will be read if the file is a text file is: x, y, z, s (where s is some scalar value associated with the particle).

Each line corresponding to a particle is terminated with a line feed. If y, z, or s is missing, zero is substituted for them. Comment lines in the file are handled as follows: 1) Any line containing "\/\/" "\#" "\%" anywhere in the line is discarded. 2) Lines containing "\/\*" are discarded until a "\*\/" is found. The line following the "\*\/" will be read.

## ◆ ProduceOutputFromBinaryFileDouble()

int vtkParticleReader::ProduceOutputFromBinaryFileDouble | ( | vtkInformationVector * | outputVector | ) |
| protected

This reader assumes that the file is binary and consists of floating point values by default.

## ◆ ProduceOutputFromBinaryFileFloat()

int vtkParticleReader::ProduceOutputFromBinaryFileFloat | ( | vtkInformationVector * | outputVector | ) |
| protected

This reader assumes that the file is binary and consists of floating point values by default.

## ◆ DetermineFileType()

int vtkParticleReader::DetermineFileType | ( |  | ) |
| protected

Determine the type of file based on an analysis of its contents.

Up to 5000 bytes of the file are read and classified. The classification of a file as either binary or text is based on the proportions of bytes in various classifications. The classification of the file is not infallible but should work correctly most of the time. If it fails, use SetFileTypeToText() or SetFileTypeToBinary() to set the file type. This algorithm probably only identifies ASCII text correctly and will not work for UTF-8 UCS-2 (or UTF-16) or UCS-4 or EBCIDIC.

## ◆ DoProgressUpdate()

void vtkParticleReader::DoProgressUpdate | ( | size_t & | bytesRead,
|  | size_t & | fileLength
| ) |  |
| protected

Update of the progress.

## Member Data Documentation

## ◆ FileName

char* vtkParticleReader::FileName
| protected

Definition at line 138 of file vtkParticleReader.h.

## ◆ File

istream* vtkParticleReader::File
| protected

Definition at line 139 of file vtkParticleReader.h.

## ◆ HasScalar

vtkTypeBool vtkParticleReader::HasScalar
| protected

Definition at line 199 of file vtkParticleReader.h.

## ◆ FileType

int vtkParticleReader::FileType
| protected

Used to decide which reader should be used.

Definition at line 203 of file vtkParticleReader.h.

## ◆ DataType

int vtkParticleReader::DataType
| protected

Used to specify the data type.

Definition at line 207 of file vtkParticleReader.h.

## ◆ Alliquot

size_t vtkParticleReader::Alliquot
| protected

Set an alliquot of bytes.

Definition at line 212 of file vtkParticleReader.h.

## ◆ Count

size_t vtkParticleReader::Count
| protected

Count of the number of alliquots processed.

Definition at line 216 of file vtkParticleReader.h.

## ◆ SwapBytes

vtkTypeBool vtkParticleReader::SwapBytes
| protected

Definition at line 218 of file vtkParticleReader.h.

## ◆ NumberOfPoints

size_t vtkParticleReader::NumberOfPoints
| protected

Definition at line 219 of file vtkParticleReader.h.

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

- IO/Geometry/vtkParticleReader.h