vtkPOPReader Class Reference

#include <vtkPOPReader.h>

Inheritance diagram for vtkPOPReader:

[legend]Collaboration diagram for vtkPOPReader:

[legend]List of all members.

---

Detailed Description

read POP data files

vtkPOPReader Just converts from images to a structured grid for now.

Definition at line 30 of file vtkPOPReader.h.

Public Types
typedef vtkStructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int *	GetDimensions ()
virtual void	GetDimensions (int &, int &)
virtual void	GetDimensions (int[2])
virtual char *	GetGridFileName ()
virtual char *	GetUFlowFileName ()
virtual char *	GetVFlowFileName ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetRadius (double)
virtual double	GetRadius ()
virtual void	SetClipExtent (int, int, int, int, int, int)
virtual void	SetClipExtent (int[6])
virtual int *	GetClipExtent ()
virtual void	GetClipExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetClipExtent (int[6])
virtual void	SetNumberOfGhostLevels (int)
virtual int	GetNumberOfGhostLevels ()
Static Public Member Functions
static vtkPOPReader *	New ()
static int	IsTypeOf (const char *type)
static vtkPOPReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPOPReader ()
	~vtkPOPReader ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	ReadInformationFile ()
vtkPoints *	ReadPoints (vtkImageData *image, vtkInformation *outInfo)
void	ReadFlow (vtkStructuredGrid *output, vtkInformation *outInfo)
vtkPoints *	GeneratePoints ()
virtual void	SetGridFileName (const char *)
void	SetGridName (char *name)
void	DeleteArrays ()
void	AddArray (char *arrayName, char *fileName, unsigned long offset)
void	AddArrayName (char *arrayName, char *fileName, unsigned long offset)
virtual void	SetUFlowFileName (const char *)
virtual void	SetVFlowFileName (const char *)
int	IsFileName (char *name)
char *	MakeFileName (char *name)
	vtkPOPReader (const vtkPOPReader &)
void	operator= (const vtkPOPReader &)
Protected Attributes
char *	FileName
int	Dimensions [2]
char *	GridFileName
double	Radius
vtkFloatArray *	DepthValues
int	NumberOfGhostLevels
int	NumberOfArrays
int	MaximumNumberOfArrays
char **	ArrayNames
char **	ArrayFileNames
unsigned long *	ArrayOffsets
int	ArrayFileDimensionality
char *	UFlowFileName
unsigned long	UFlowFileOffset
char *	VFlowFileName
unsigned long	VFlowFileOffset
int	ClipExtent [6]

---

Member Typedef Documentation

typedef vtkStructuredGridAlgorithm vtkPOPReader::Superclass

Reimplemented from vtkStructuredGridAlgorithm. Definition at line 34 of file vtkPOPReader.h.

---

Constructor & Destructor Documentation

vtkPOPReader::vtkPOPReader (   )  [protected]

vtkPOPReader::~vtkPOPReader (   )  [protected]

vtkPOPReader::vtkPOPReader (  const vtkPOPReader &   )  [protected]

---

Member Function Documentation

static vtkPOPReader* vtkPOPReader::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkStructuredGridAlgorithm.

virtual const char* vtkPOPReader::GetClassName (   )  [virtual]

Reimplemented from vtkStructuredGridAlgorithm.

static int vtkPOPReader::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkStructuredGridAlgorithm.

virtual int vtkPOPReader::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkStructuredGridAlgorithm.

static vtkPOPReader* vtkPOPReader::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkStructuredGridAlgorithm.

void vtkPOPReader::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 vtkStructuredGridAlgorithm.

virtual int* vtkPOPReader::GetDimensions (   )  [virtual]

This is the longitude and latitude dimensions of the structured grid.

virtual void vtkPOPReader::GetDimensions (  int &  , int &  )  [virtual]

virtual void vtkPOPReader::GetDimensions (  int  [2]  )  [virtual]

virtual char* vtkPOPReader::GetGridFileName (   )  [virtual]

This file contains the latitude and longitude of the grid. It must be double with no header.

virtual char* vtkPOPReader::GetUFlowFileName (   )  [virtual]

These files contains the u and v components of the flow.

virtual char* vtkPOPReader::GetVFlowFileName (   )  [virtual]

These files contains the u and v components of the flow.

virtual void vtkPOPReader::SetFileName (  const char *   )  [virtual]

This file contains information about all the files.

virtual char* vtkPOPReader::GetFileName (   )  [virtual]

This file contains information about all the files.

virtual void vtkPOPReader::SetRadius (  double   )  [virtual]

Radius of the earth.

virtual double vtkPOPReader::GetRadius (   )  [virtual]

Radius of the earth.

virtual void vtkPOPReader::SetClipExtent (  int  , int  , int  , int  , int  , int  )  [virtual]

Because the data can be so large, here is an option to clip while reading.

virtual void vtkPOPReader::SetClipExtent (  int  [6]  )  [virtual]

Because the data can be so large, here is an option to clip while reading.

virtual int* vtkPOPReader::GetClipExtent (   )  [virtual]

Because the data can be so large, here is an option to clip while reading.

virtual void vtkPOPReader::GetClipExtent (  int &  , int &  , int &  , int &  , int &  , int &  )  [virtual]

Because the data can be so large, here is an option to clip while reading.

virtual void vtkPOPReader::GetClipExtent (  int  [6]  )  [virtual]

Because the data can be so large, here is an option to clip while reading.

virtual void vtkPOPReader::SetNumberOfGhostLevels (  int   )  [virtual]

Set the number of ghost levels to include in the data

virtual int vtkPOPReader::GetNumberOfGhostLevels (   )  [virtual]

Set the number of ghost levels to include in the data

virtual int vtkPOPReader::RequestInformation (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

Reimplemented from vtkStructuredGridAlgorithm.

virtual int vtkPOPReader::RequestData (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented from vtkStructuredGridAlgorithm.

void vtkPOPReader::ReadInformationFile (   )  [protected]

vtkPoints* vtkPOPReader::ReadPoints (  vtkImageData *  image, vtkInformation *  outInfo )  [protected]

void vtkPOPReader::ReadFlow (  vtkStructuredGrid *  output, vtkInformation *  outInfo )  [protected]

vtkPoints* vtkPOPReader::GeneratePoints (   )  [protected]

virtual void vtkPOPReader::SetGridFileName (  const char *   )  [protected, virtual]

void vtkPOPReader::SetGridName (  char *  name  )  [protected]

void vtkPOPReader::DeleteArrays (   )  [protected]

void vtkPOPReader::AddArray (  char *  arrayName, char *  fileName, unsigned long  offset )  [protected]

void vtkPOPReader::AddArrayName (  char *  arrayName, char *  fileName, unsigned long  offset )  [protected]

virtual void vtkPOPReader::SetUFlowFileName (  const char *   )  [protected, virtual]

virtual void vtkPOPReader::SetVFlowFileName (  const char *   )  [protected, virtual]

int vtkPOPReader::IsFileName (  char *  name  )  [protected]

char* vtkPOPReader::MakeFileName (  char *  name  )  [protected]

void vtkPOPReader::operator= (  const vtkPOPReader &   )  [protected]

---

Member Data Documentation

char* vtkPOPReader::FileName [protected]

Definition at line 92 of file vtkPOPReader.h.

int vtkPOPReader::Dimensions[2] [protected]

Definition at line 94 of file vtkPOPReader.h.

char* vtkPOPReader::GridFileName [protected]

Definition at line 97 of file vtkPOPReader.h.

double vtkPOPReader::Radius [protected]

Definition at line 99 of file vtkPOPReader.h.

vtkFloatArray* vtkPOPReader::DepthValues [protected]

Definition at line 100 of file vtkPOPReader.h.

int vtkPOPReader::NumberOfGhostLevels [protected]

Definition at line 101 of file vtkPOPReader.h.

int vtkPOPReader::NumberOfArrays [protected]

Definition at line 106 of file vtkPOPReader.h.

int vtkPOPReader::MaximumNumberOfArrays [protected]

Definition at line 107 of file vtkPOPReader.h.

char** vtkPOPReader::ArrayNames [protected]

Definition at line 108 of file vtkPOPReader.h.

char** vtkPOPReader::ArrayFileNames [protected]

Definition at line 109 of file vtkPOPReader.h.

unsigned long* vtkPOPReader::ArrayOffsets [protected]

Definition at line 110 of file vtkPOPReader.h.

int vtkPOPReader::ArrayFileDimensionality [protected]

Definition at line 111 of file vtkPOPReader.h.

char* vtkPOPReader::UFlowFileName [protected]

Definition at line 113 of file vtkPOPReader.h.

unsigned long vtkPOPReader::UFlowFileOffset [protected]

Definition at line 114 of file vtkPOPReader.h.

char* vtkPOPReader::VFlowFileName [protected]

Definition at line 116 of file vtkPOPReader.h.

unsigned long vtkPOPReader::VFlowFileOffset [protected]

Definition at line 117 of file vtkPOPReader.h.

int vtkPOPReader::ClipExtent[6] [protected]

Definition at line 123 of file vtkPOPReader.h.

---

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

• dox/Parallel/vtkPOPReader.h

---