VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkDEMReader Class Reference

read a digital elevation model (DEM) file More...

#include <vtkDEMReader.h>

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

List of all members.

Public Types

enum  { REFERENCE_SEA_LEVEL = 0, REFERENCE_ELEVATION_BOUNDS }
typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetElevationReference (int)
virtual int GetElevationReference ()
void SetElevationReferenceToSeaLevel ()
void SetElevationReferenceToElevationBounds ()
const char * GetElevationReferenceAsString (void)
virtual char * GetMapLabel ()
virtual int GetDEMLevel ()
virtual int GetElevationPattern ()
virtual int GetGroundSystem ()
virtual int GetGroundZone ()
virtual float * GetProjectionParameters ()
virtual void GetProjectionParameters (float data[15])
virtual int GetPlaneUnitOfMeasure ()
virtual int GetElevationUnitOfMeasure ()
virtual int GetPolygonSize ()
virtual float * GetElevationBounds ()
virtual void GetElevationBounds (float data[2])
virtual float GetLocalRotation ()
virtual int GetAccuracyCode ()
virtual float * GetSpatialResolution ()
virtual void GetSpatialResolution (float data[3])
virtual int * GetProfileDimension ()
virtual void GetProfileDimension (int data[2])
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkDEMReaderNew ()
static int IsTypeOf (const char *type)
static vtkDEMReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkDEMReader ()
 ~vtkDEMReader ()
void ComputeExtentOriginAndSpacing (int extent[6], double origin[6], double spacing[6])
int ReadTypeARecord ()
int ReadProfiles (vtkImageData *data)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkTimeStamp ReadHeaderTime
int NumberOfColumns
int NumberOfRows
int WholeExtent [6]
char * FileName
char MapLabel [145]
int DEMLevel
int ElevationPattern
int GroundSystem
int GroundZone
float ProjectionParameters [15]
int PlaneUnitOfMeasure
int ElevationUnitOfMeasure
int PolygonSize
float GroundCoords [4][2]
float ElevationBounds [2]
float LocalRotation
int AccuracyCode
float SpatialResolution [3]
int ProfileDimension [2]
int ProfileSeekOffset
int ElevationReference

Detailed Description

read a digital elevation model (DEM) file

vtkDEMReader reads digital elevation files and creates image data. Digital elevation files are produced by the US Geological Survey. A complete description of the DEM file is located at the USGS site. The reader reads the entire dem file and create a vtkImageData that contains a single scalar component that is the elevation in meters. The spacing is also expressed in meters. A number of get methods provide access to fields on the header.

Examples:
vtkDEMReader (Examples)
Tests:
vtkDEMReader (Tests)

Definition at line 39 of file vtkDEMReader.h.


Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Definition at line 43 of file vtkDEMReader.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
REFERENCE_SEA_LEVEL 
REFERENCE_ELEVATION_BOUNDS 

Definition at line 53 of file vtkDEMReader.h.


Constructor & Destructor Documentation

vtkDEMReader::vtkDEMReader ( )
protected
vtkDEMReader::~vtkDEMReader ( )
protected

Member Function Documentation

static vtkDEMReader* vtkDEMReader::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkDEMReader::GetClassName ( )
virtual

Reimplemented from vtkImageAlgorithm.

static int vtkDEMReader::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 vtkImageAlgorithm.

virtual int vtkDEMReader::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 vtkImageAlgorithm.

static vtkDEMReader* vtkDEMReader::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImageAlgorithm.

void vtkDEMReader::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 vtkImageAlgorithm.

virtual void vtkDEMReader::SetFileName ( const char *  )
virtual

Specify file name of Digital Elevation Model (DEM) file

virtual char* vtkDEMReader::GetFileName ( )
virtual

Specify file name of Digital Elevation Model (DEM) file

virtual void vtkDEMReader::SetElevationReference ( int  )
virtual

Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).

virtual int vtkDEMReader::GetElevationReference ( )
virtual

Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).

void vtkDEMReader::SetElevationReferenceToSeaLevel ( )
inline

Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).

Definition at line 63 of file vtkDEMReader.h.

void vtkDEMReader::SetElevationReferenceToElevationBounds ( )
inline

Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).

Definition at line 65 of file vtkDEMReader.h.

const char* vtkDEMReader::GetElevationReferenceAsString ( void  )

Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).

virtual char* vtkDEMReader::GetMapLabel ( )
virtual

An ASCII description of the map

virtual int vtkDEMReader::GetDEMLevel ( )
virtual

Code 1=DEM-1, 2=DEM_2, ...

virtual int vtkDEMReader::GetElevationPattern ( )
virtual

Code 1=regular, 2=random, reserved for future use

virtual int vtkDEMReader::GetGroundSystem ( )
virtual

Ground planimetric reference system

virtual int vtkDEMReader::GetGroundZone ( )
virtual

Zone in ground planimetric reference system

virtual float* vtkDEMReader::GetProjectionParameters ( )
virtual

Map Projection parameters. All are zero.

virtual void vtkDEMReader::GetProjectionParameters ( float  data[15])
virtual

Map Projection parameters. All are zero.

virtual int vtkDEMReader::GetPlaneUnitOfMeasure ( )
virtual

Defining unit of measure for ground planimetric coordinates throughout the file. 0 = radians, 1 = feet, 2 = meters, 3 = arc-seconds.

virtual int vtkDEMReader::GetElevationUnitOfMeasure ( )
virtual

Defining unit of measure for elevation coordinates throughout the file. 1 = feet, 2 = meters

virtual int vtkDEMReader::GetPolygonSize ( )
virtual

Number of sides in the polygon which defines the coverage of the DEM file. Set to 4.

virtual float* vtkDEMReader::GetElevationBounds ( )
virtual

Minimum and maximum elevation for the DEM. The units in the file are in ElevationUnitOfMeasure. This class converts them to meters.

virtual void vtkDEMReader::GetElevationBounds ( float  data[2])
virtual

Minimum and maximum elevation for the DEM. The units in the file are in ElevationUnitOfMeasure. This class converts them to meters.

virtual float vtkDEMReader::GetLocalRotation ( )
virtual

Counterclockwise angle (in radians) from the primary axis of the planimetric reference to the primary axis of the DEM local reference system. IGNORED BY THIS IMPLEMENTATION.

virtual int vtkDEMReader::GetAccuracyCode ( )
virtual

Accuracy code for elevations. 0=unknown accuracy

virtual float* vtkDEMReader::GetSpatialResolution ( )
virtual

DEM spatial resolution for x,y,z. Values are expressed in units of resolution. Since elevations are read as integers, this permits fractional elevations.

virtual void vtkDEMReader::GetSpatialResolution ( float  data[3])
virtual

DEM spatial resolution for x,y,z. Values are expressed in units of resolution. Since elevations are read as integers, this permits fractional elevations.

virtual int* vtkDEMReader::GetProfileDimension ( )
virtual

The number of rows and columns in the DEM.

virtual void vtkDEMReader::GetProfileDimension ( int  data[2])
virtual

The number of rows and columns in the DEM.

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

Reads the DEM Type A record to compute the extent, origin and spacing of the image data. The number of scalar components is set to 1 and the output scalar type is VTK_FLOAT.

Reimplemented from vtkImageAlgorithm.

void vtkDEMReader::ComputeExtentOriginAndSpacing ( int  extent[6],
double  origin[6],
double  spacing[6] 
)
protected
int vtkDEMReader::ReadTypeARecord ( )
protected
int vtkDEMReader::ReadProfiles ( vtkImageData data)
protected
virtual int vtkDEMReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

vtkTimeStamp vtkDEMReader::ReadHeaderTime
protected

Definition at line 161 of file vtkDEMReader.h.

int vtkDEMReader::NumberOfColumns
protected

Definition at line 162 of file vtkDEMReader.h.

int vtkDEMReader::NumberOfRows
protected

Definition at line 163 of file vtkDEMReader.h.

int vtkDEMReader::WholeExtent[6]
protected

Definition at line 164 of file vtkDEMReader.h.

char* vtkDEMReader::FileName
protected

Definition at line 165 of file vtkDEMReader.h.

char vtkDEMReader::MapLabel[145]
protected

Definition at line 166 of file vtkDEMReader.h.

int vtkDEMReader::DEMLevel
protected

Definition at line 167 of file vtkDEMReader.h.

int vtkDEMReader::ElevationPattern
protected

Definition at line 168 of file vtkDEMReader.h.

int vtkDEMReader::GroundSystem
protected

Definition at line 169 of file vtkDEMReader.h.

int vtkDEMReader::GroundZone
protected

Definition at line 170 of file vtkDEMReader.h.

float vtkDEMReader::ProjectionParameters[15]
protected

Definition at line 171 of file vtkDEMReader.h.

int vtkDEMReader::PlaneUnitOfMeasure
protected

Definition at line 172 of file vtkDEMReader.h.

int vtkDEMReader::ElevationUnitOfMeasure
protected

Definition at line 173 of file vtkDEMReader.h.

int vtkDEMReader::PolygonSize
protected

Definition at line 174 of file vtkDEMReader.h.

float vtkDEMReader::GroundCoords[4][2]
protected

Definition at line 175 of file vtkDEMReader.h.

float vtkDEMReader::ElevationBounds[2]
protected

Definition at line 176 of file vtkDEMReader.h.

float vtkDEMReader::LocalRotation
protected

Definition at line 177 of file vtkDEMReader.h.

int vtkDEMReader::AccuracyCode
protected

Definition at line 178 of file vtkDEMReader.h.

float vtkDEMReader::SpatialResolution[3]
protected

Definition at line 179 of file vtkDEMReader.h.

int vtkDEMReader::ProfileDimension[2]
protected

Definition at line 180 of file vtkDEMReader.h.

int vtkDEMReader::ProfileSeekOffset
protected

Definition at line 181 of file vtkDEMReader.h.

int vtkDEMReader::ElevationReference
protected

Definition at line 182 of file vtkDEMReader.h.


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