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

Produces a layout for a graph labeled with K-Core information. More...

#include <vtkKCoreLayout.h>

Inheritance diagram for vtkKCoreLayout:
Inheritance graph
[legend]
Collaboration diagram for vtkKCoreLayout:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkKCoreLayoutNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void SetGraphConnection (vtkAlgorithmOutput *)
 Convenience function provided for setting the graph input.
 vtkKCoreLayout ()
 ~vtkKCoreLayout ()
int FillInputPortInformation (int port, vtkInformation *info)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void SetKCoreLabelArrayName (const char *)
virtual bool GetPolar ()
virtual void SetPolar (bool)
virtual void PolarOn ()
virtual void PolarOff ()
virtual bool GetCartesian ()
virtual void SetCartesian (bool)
virtual void CartesianOn ()
virtual void CartesianOff ()
virtual void SetPolarCoordsRadiusArrayName (const char *)
virtual char * GetPolarCoordsRadiusArrayName ()
virtual void SetPolarCoordsAngleArrayName (const char *)
virtual char * GetPolarCoordsAngleArrayName ()
virtual void SetCartesianCoordsXArrayName (const char *)
virtual char * GetCartesianCoordsXArrayName ()
virtual void SetCartesianCoordsYArrayName (const char *)
virtual char * GetCartesianCoordsYArrayName ()
virtual void SetEpsilon (float)
virtual float GetEpsilon ()
virtual void SetUnitRadius (float)
virtual float GetUnitRadius ()

Static Public Member Functions

static vtkKCoreLayoutNew ()
static int IsTypeOf (const char *type)
static vtkKCoreLayoutSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const

Protected Attributes

char * KCoreLabelArrayName
char * PolarCoordsRadiusArrayName
char * PolarCoordsAngleArrayName
char * CartesianCoordsXArrayName
char * CartesianCoordsYArrayName
bool Cartesian
bool Polar
float Epsilon
float UnitRadius

Detailed Description

Produces a layout for a graph labeled with K-Core information.

vtkKCoreLayout creates coordinates for each vertex that can be used to perform a layout for a k-core view. Prerequisite: Vertices must have an attribute array containing their k-core number. This layout is based on the algorithm described in the paper: "k-core decomposition: a tool for the visualization of large scale networks", by Ignacio Alvarez-Hamelin et. al.

This graph algorithm appends either polar coordinates or cartesian coordinates as vertex attributes to the graph giving the position of the vertex in a layout. Input graphs must have the k-core number assigned to each vertex (default attribute array storing kcore numbers is "kcore").

Epsilon - this factor is used to adjust the amount vertices are 'pulled' out of their default ring radius based on the number of neighbors in higher cores. Default=0.2 UnitRadius - Tweaks the base unit radius value. Default=1.0

Still TODO: Still need to work on the connected-components within each shell and associated layout issues with that.

Input port 0: graph

Thanks:
Thanks to William McLendon from Sandia National Laboratories for providing this implementation.
Examples:
vtkKCoreLayout (Examples)
Tests:
vtkKCoreLayout (Tests)

Definition at line 64 of file vtkKCoreLayout.h.


Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 68 of file vtkKCoreLayout.h.


Constructor & Destructor Documentation


Member Function Documentation

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

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

Reimplemented from vtkGraphAlgorithm.

static int vtkKCoreLayout::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 vtkGraphAlgorithm.

virtual int vtkKCoreLayout::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 vtkGraphAlgorithm.

Reimplemented from vtkGraphAlgorithm.

virtual vtkObjectBase* vtkKCoreLayout::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkGraphAlgorithm.

Reimplemented from vtkGraphAlgorithm.

void vtkKCoreLayout::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 vtkGraphAlgorithm.

Convenience function provided for setting the graph input.

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkGraphAlgorithm.

virtual void vtkKCoreLayout::SetKCoreLabelArrayName ( const char *  ) [virtual]

Set the name of the vertex attribute array storing k-core labels. Default: kcore

virtual bool vtkKCoreLayout::GetPolar ( ) [virtual]

Output polar coordinates for vertices if True. Default column names are coord_radius, coord_angle. Default: False

virtual void vtkKCoreLayout::SetPolar ( bool  ) [virtual]

Output polar coordinates for vertices if True. Default column names are coord_radius, coord_angle. Default: False

virtual void vtkKCoreLayout::PolarOn ( ) [virtual]

Output polar coordinates for vertices if True. Default column names are coord_radius, coord_angle. Default: False

virtual void vtkKCoreLayout::PolarOff ( ) [virtual]

Output polar coordinates for vertices if True. Default column names are coord_radius, coord_angle. Default: False

virtual bool vtkKCoreLayout::GetCartesian ( ) [virtual]

Set whether or not to convert output to cartesian coordinates. If false, coordinates will be returned in polar coordinates (radius, angle). Default: True

virtual void vtkKCoreLayout::SetCartesian ( bool  ) [virtual]

Set whether or not to convert output to cartesian coordinates. If false, coordinates will be returned in polar coordinates (radius, angle). Default: True

virtual void vtkKCoreLayout::CartesianOn ( ) [virtual]

Set whether or not to convert output to cartesian coordinates. If false, coordinates will be returned in polar coordinates (radius, angle). Default: True

virtual void vtkKCoreLayout::CartesianOff ( ) [virtual]

Set whether or not to convert output to cartesian coordinates. If false, coordinates will be returned in polar coordinates (radius, angle). Default: True

virtual void vtkKCoreLayout::SetPolarCoordsRadiusArrayName ( const char *  ) [virtual]

Polar coordinates array name for radius values. This is only used if OutputCartesianCoordinates is False. Default: coord_radius

virtual char* vtkKCoreLayout::GetPolarCoordsRadiusArrayName ( ) [virtual]

Polar coordinates array name for radius values. This is only used if OutputCartesianCoordinates is False. Default: coord_radius

virtual void vtkKCoreLayout::SetPolarCoordsAngleArrayName ( const char *  ) [virtual]

Polar coordinates array name for angle values in radians. This is only used if OutputCartesianCoordinates is False. Default: coord_angle

virtual char* vtkKCoreLayout::GetPolarCoordsAngleArrayName ( ) [virtual]

Polar coordinates array name for angle values in radians. This is only used if OutputCartesianCoordinates is False. Default: coord_angle

virtual void vtkKCoreLayout::SetCartesianCoordsXArrayName ( const char *  ) [virtual]

Cartesian coordinates array name for the X coordinates. This is only used if OutputCartesianCoordinates is True. Default: coord_x

virtual char* vtkKCoreLayout::GetCartesianCoordsXArrayName ( ) [virtual]

Cartesian coordinates array name for the X coordinates. This is only used if OutputCartesianCoordinates is True. Default: coord_x

virtual void vtkKCoreLayout::SetCartesianCoordsYArrayName ( const char *  ) [virtual]

Cartesian coordinates array name for the Y coordinates. This is only used if OutputCartesianCoordinates is True. Default: coord_y

virtual char* vtkKCoreLayout::GetCartesianCoordsYArrayName ( ) [virtual]

Cartesian coordinates array name for the Y coordinates. This is only used if OutputCartesianCoordinates is True. Default: coord_y

virtual void vtkKCoreLayout::SetEpsilon ( float  ) [virtual]

Epsilon value used in the algorithm. Default = 0.2

virtual float vtkKCoreLayout::GetEpsilon ( ) [virtual]

Epsilon value used in the algorithm. Default = 0.2

virtual void vtkKCoreLayout::SetUnitRadius ( float  ) [virtual]

Unit Radius value used in the algorithm. Default = 1.0

virtual float vtkKCoreLayout::GetUnitRadius ( ) [virtual]

Unit Radius value used in the algorithm. Default = 1.0

int vtkKCoreLayout::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [virtual]

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

Reimplemented from vtkGraphAlgorithm.


Member Data Documentation

Definition at line 147 of file vtkKCoreLayout.h.

Definition at line 149 of file vtkKCoreLayout.h.

Definition at line 150 of file vtkKCoreLayout.h.

Definition at line 152 of file vtkKCoreLayout.h.

Definition at line 153 of file vtkKCoreLayout.h.

bool vtkKCoreLayout::Cartesian [protected]

Definition at line 155 of file vtkKCoreLayout.h.

bool vtkKCoreLayout::Polar [protected]

Definition at line 156 of file vtkKCoreLayout.h.

Definition at line 158 of file vtkKCoreLayout.h.

Definition at line 159 of file vtkKCoreLayout.h.


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