Convert between VTK image representation and GDAL datasets. More...

#include <vtkGDALRasterConverter.h>

Inheritance diagram for vtkGDALRasterConverter:

Collaboration diagram for vtkGDALRasterConverter:

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

vtkGDALRasterConverter *	NewInstance () const

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

GDALDataset *	CreateGDALDataset (int xDim, int yDim, int vtkDataType, int numberOfBands)
	Create GDAL dataset in memory.

GDALDataset *	CreateGDALDataset (vtkImageData data, const char mapProjection, int flipAxis[3])
	Create GDALDataset to match vtkImageData.

void	CopyBandInfo (GDALDataset src, GDALDataset dest)
	Copies color interpretation and color tables.

vtkUniformGrid *	CreateVTKUniformGrid (GDALDataset *input)
	Create vtkUniformGrid to match GDALDataset.

void	SetGDALProjection (GDALDataset dataset, const char projectionString)
	Set projection on GDAL dataset, using any projection string recognized by GDAL.

void	SetGDALGeoTransform (GDALDataset *dataset, double origin[2], double spacing[2], int flipAxis[2])
	Set geo-transform on GDAL dataset.

void	CopyNoDataValues (GDALDataset src, GDALDataset dest)
	Copies NoDataValue info from 1st to 2nd dataset.

void	WriteTifFile (GDALDataset dataset, VTK_FILEPATH const char filename)
	Write GDALDataset to tiff file.

bool	FindDataRange (GDALDataset dataset, int bandId, double minValue, double *maxValue)
	Traverse values in specified band to find min/max.


virtual void	SetNoDataValue (double)
	No-data value for pixels in the source image Default is NaN (not used).

virtual double	GetNoDataValue ()
	No-data value for pixels in the source image Default is NaN (not used).

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkGDALRasterConverter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGDALRasterConverter *	SafeDownCast (vtkObjectBase *o)

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGDALRasterConverter ()

	~vtkGDALRasterConverter () override

bool	CopyToGDAL (vtkImageData input, GDALDataset output, int flipAxis[3])
	Copies vtkImageData contents to GDALDataset GDALDataset must be initialized to same dimensions as vtk image.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	NoDataValue

vtkGDALRasterConverterInternal *	Internal

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
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Convert between VTK image representation and GDAL datasets.

vtkGDALRasterConverter is an internal implementation class used to convert between VTK and GDAL data formats.

See also: vtkRasterReprojectionFilter

Definition at line 27 of file vtkGDALRasterConverter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkGDALRasterConverter::Superclass

Definition at line 31 of file vtkGDALRasterConverter.h.

Constructor & Destructor Documentation

◆ vtkGDALRasterConverter()

vtkGDALRasterConverter::vtkGDALRasterConverter ( )

protected

◆ ~vtkGDALRasterConverter()

vtkGDALRasterConverter::~vtkGDALRasterConverter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGDALRasterConverter * vtkGDALRasterConverter::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGDALRasterConverter::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkGDALRasterConverter * vtkGDALRasterConverter::NewInstance ( ) const

◆ PrintSelf()

void vtkGDALRasterConverter::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 vtkObjectBase.

◆ SetNoDataValue()

virtual void vtkGDALRasterConverter::SetNoDataValue ( double )

virtual

No-data value for pixels in the source image Default is NaN (not used).

◆ GetNoDataValue()

virtual double vtkGDALRasterConverter::GetNoDataValue ( )

virtual

No-data value for pixels in the source image Default is NaN (not used).

◆ CreateGDALDataset() [1/2]

GDALDataset * vtkGDALRasterConverter::CreateGDALDataset	(	int	xDim,
		int	yDim,
		int	vtkDataType,
		int	numberOfBands
	)

Create GDAL dataset in memory.

This dataset must be released by the calling code, using GDALClose().

◆ CreateGDALDataset() [2/2]

GDALDataset * vtkGDALRasterConverter::CreateGDALDataset	(	vtkImageData *	data,
		const char *	mapProjection,
		int	flipAxis[3]
	)

Create GDALDataset to match vtkImageData.

This dataset must be released by the calling code, using GDALClose().

◆ CopyBandInfo()

void vtkGDALRasterConverter::CopyBandInfo	(	GDALDataset *	src,
		GDALDataset *	dest
	)

Copies color interpretation and color tables.

◆ CreateVTKUniformGrid()

vtkUniformGrid * vtkGDALRasterConverter::CreateVTKUniformGrid ( GDALDataset * input )

Create vtkUniformGrid to match GDALDataset.

The calling code must call the Delete() method to release the returned instance.

◆ SetGDALProjection()

void vtkGDALRasterConverter::SetGDALProjection	(	GDALDataset *	dataset,
		const char *	projectionString
	)

Set projection on GDAL dataset, using any projection string recognized by GDAL.

◆ SetGDALGeoTransform()

void vtkGDALRasterConverter::SetGDALGeoTransform	(	GDALDataset *	dataset,
		double	origin[2],
		double	spacing[2],
		int	flipAxis[2]
	)

Set geo-transform on GDAL dataset.

◆ CopyNoDataValues()

void vtkGDALRasterConverter::CopyNoDataValues	(	GDALDataset *	src,
		GDALDataset *	dest
	)

Copies NoDataValue info from 1st to 2nd dataset.

◆ WriteTifFile()

void vtkGDALRasterConverter::WriteTifFile	(	GDALDataset *	dataset,
		VTK_FILEPATH const char *	filename
	)

Write GDALDataset to tiff file.

◆ FindDataRange()

bool vtkGDALRasterConverter::FindDataRange	(	GDALDataset *	dataset,
		int	bandId,
		double *	minValue,
		double *	maxValue
	)

Traverse values in specified band to find min/max.

Note that the bandId starts at 1, not zero. Returns boolean indicating success.

◆ CopyToGDAL()

bool vtkGDALRasterConverter::CopyToGDAL	(	vtkImageData *	input,
		GDALDataset *	output,
		int	flipAxis[3]
	)

protected

Copies vtkImageData contents to GDALDataset GDALDataset must be initialized to same dimensions as vtk image.

Member Data Documentation

◆ NoDataValue

double vtkGDALRasterConverter::NoDataValue

protected

Definition at line 102 of file vtkGDALRasterConverter.h.

◆ Internal

vtkGDALRasterConverterInternal* vtkGDALRasterConverter::Internal

protected

Definition at line 111 of file vtkGDALRasterConverter.h.

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

Geovis/GDAL/vtkGDALRasterConverter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkGDALRasterConverter()

◆ ~vtkGDALRasterConverter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetNoDataValue()

◆ GetNoDataValue()

◆ CreateGDALDataset() [1/2]

◆ CreateGDALDataset() [2/2]

◆ CopyBandInfo()

◆ CreateVTKUniformGrid()

◆ SetGDALProjection()

◆ SetGDALGeoTransform()

◆ CopyNoDataValues()

◆ WriteTifFile()

◆ FindDataRange()

◆ CopyToGDAL()

Member Data Documentation

◆ NoDataValue

◆ Internal