VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGeoTransform Class Reference

A transformation between two geographic coordinate systems. More...

#include <vtkGeoTransform.h>

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

Public Types

typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
typedef vtkObject Superclass
 

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkGeoTransformNewInstance () const
 
void TransformPoints (vtkPoints *src, vtkPoints *dst) override
 Transform many points at once.
 
void Inverse () override
 Invert the transformation.
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type.
 
void SetSourceProjection (vtkGeoProjection *source)
 The source geographic projection.
 
virtual vtkGeoProjectionGetSourceProjection ()
 The source geographic projection.
 
void SetDestinationProjection (vtkGeoProjection *dest)
 The target geographic projection.
 
virtual vtkGeoProjectionGetDestinationProjection ()
 The target geographic projection.
 
void InternalTransformPoint (const float in[3], float out[3]) override
 This will calculate the transformation without calling Update.
 
void InternalTransformPoint (const double in[3], double out[3]) override
 This will calculate the transformation without calling Update.
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.
 
- Public Member Functions inherited from vtkAbstractTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void TransformPoint (const float in[3], float out[3])
 Apply the transformation to a coordinate.
 
void TransformPoint (const double in[3], double out[3])
 Apply the transformation to a double-precision coordinate.
 
double * TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate.
 
double * TransformPoint (const double point[3])
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 Apply the transformation to a series of points, and append the results to outPts.
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr)
 Apply the transformation to a combination of points, normals and vectors.
 
vtkAbstractTransformGetInverse ()
 Get the inverse of this transform.
 
void SetInverse (vtkAbstractTransform *transform)
 Set a transformation that this transform will be the inverse of.
 
virtual void Inverse ()=0
 Invert the transformation.
 
void DeepCopy (vtkAbstractTransform *)
 Copy this transform from another of the same type.
 
void Update ()
 Update the transform to account for any changes which have been made.
 
virtual vtkAbstractTransformMakeTransform ()=0
 Make another transform of the same type.
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference.
 
vtkMTimeType GetMTime () override
 Override GetMTime necessary because of inverse transforms.
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references.
 
float * TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate.
 
float * TransformFloatPoint (const float point[3])
 Apply the transformation to an (x,y,z) coordinate.
 
double * TransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate.
 
double * TransformDoublePoint (const double point[3])
 Apply the transformation to a double-precision (x,y,z) coordinate.
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a normal at the specified vertex.
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a normal at the specified vertex.
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex.
 
float * TransformFloatNormalAtPoint (const float point[3], const float normal[3])
 Apply the transformation to a single-precision normal at the specified vertex.
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a vector at the specified vertex.
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a vector at the specified vertex.
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex.
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex.
 
- 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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.
 
vtkCommandGetCommand (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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

Static Public Member Functions

static vtkGeoTransformNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeoTransformSafeDownCast (vtkObjectBase *o)
 
static int ComputeUTMZone (double lon, double lat)
 Computes Universal Transverse Mercator (UTM) zone given the longitude and latitude of the point.
 
static int ComputeUTMZone (double *lonlat)
 Computes Universal Transverse Mercator (UTM) zone given the longitude and latitude of the point.
 
- Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (int 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 int 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkGeoTransform ()
 
 ~vtkGeoTransform () override
 
void InternalTransformPoints (double *ptsInOut, vtkIdType numPts, int stride)
 
- Protected Member Functions inherited from vtkAbstractTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
virtual void InternalUpdate ()
 Perform any subclass-specific Update.
 
virtual void InternalDeepCopy (vtkAbstractTransform *)
 Perform any subclass-specific DeepCopy.
 
- 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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkGeoProjectionSourceProjection
 
vtkGeoProjectionDestinationProjection
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

A transformation between two geographic coordinate systems.

This class takes two geographic projections and transforms point coordinates between them.

Definition at line 36 of file vtkGeoTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkGeoTransform.h.

Constructor & Destructor Documentation

◆ vtkGeoTransform()

vtkGeoTransform::vtkGeoTransform ( )
protected

◆ ~vtkGeoTransform()

vtkGeoTransform::~vtkGeoTransform ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGeoTransform * vtkGeoTransform::New ( )
static

◆ PrintSelf()

void vtkGeoTransform::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 vtkAbstractTransform.

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGeoTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractTransform.

◆ NewInstance()

vtkGeoTransform * vtkGeoTransform::NewInstance ( ) const

◆ SetSourceProjection()

void vtkGeoTransform::SetSourceProjection ( vtkGeoProjection source)

The source geographic projection.

◆ GetSourceProjection()

virtual vtkGeoProjection * vtkGeoTransform::GetSourceProjection ( )
virtual

The source geographic projection.

◆ SetDestinationProjection()

void vtkGeoTransform::SetDestinationProjection ( vtkGeoProjection dest)

The target geographic projection.

◆ GetDestinationProjection()

virtual vtkGeoProjection * vtkGeoTransform::GetDestinationProjection ( )
virtual

The target geographic projection.

◆ TransformPoints()

void vtkGeoTransform::TransformPoints ( vtkPoints src,
vtkPoints dst 
)
overridevirtual

Transform many points at once.

Reimplemented from vtkAbstractTransform.

◆ Inverse()

void vtkGeoTransform::Inverse ( )
overridevirtual

Invert the transformation.

Implements vtkAbstractTransform.

◆ InternalTransformPoint() [1/2]

void vtkGeoTransform::InternalTransformPoint ( const float  in[3],
float  out[3] 
)
overridevirtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ InternalTransformPoint() [2/2]

void vtkGeoTransform::InternalTransformPoint ( const double  in[3],
double  out[3] 
)
overridevirtual

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ ComputeUTMZone() [1/2]

static int vtkGeoTransform::ComputeUTMZone ( double  lon,
double  lat 
)
static

Computes Universal Transverse Mercator (UTM) zone given the longitude and latitude of the point.

It correctly computes the zones in the two exception areas. It returns an integer between 1 and 60 for valid long lat, or 0 otherwise.

◆ ComputeUTMZone() [2/2]

static int vtkGeoTransform::ComputeUTMZone ( double *  lonlat)
inlinestatic

Computes Universal Transverse Mercator (UTM) zone given the longitude and latitude of the point.

It correctly computes the zones in the two exception areas. It returns an integer between 1 and 60 for valid long lat, or 0 otherwise.

Definition at line 87 of file vtkGeoTransform.h.

◆ InternalTransformDerivative() [1/2]

void vtkGeoTransform::InternalTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
overridevirtual

This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.

This method does not call Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ InternalTransformDerivative() [2/2]

void vtkGeoTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
overridevirtual

This will transform a point and, at the same time, calculate a 3x3 Jacobian matrix that provides the partial derivatives of the transformation at that point.

This method does not call Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ MakeTransform()

vtkAbstractTransform * vtkGeoTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ InternalTransformPoints()

void vtkGeoTransform::InternalTransformPoints ( double *  ptsInOut,
vtkIdType  numPts,
int  stride 
)
protected

Member Data Documentation

◆ SourceProjection

vtkGeoProjection* vtkGeoTransform::SourceProjection
protected

Definition at line 114 of file vtkGeoTransform.h.

◆ DestinationProjection

vtkGeoProjection* vtkGeoTransform::DestinationProjection
protected

Definition at line 115 of file vtkGeoTransform.h.


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