GraphAnalysis_fe1fb978c73a11e889bcc860006dfcdd

author:

Dragonfly Team

contact:

http://theobjects.com

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

Oct 03 2018 14:34

dragonflyVersion:

4.0.0.514 (D)

UUID:

fe1fb978c73a11e889bcc860006dfcdd

Class Code

class OrsPythonPlugins.GraphAnalysis_fe1fb978c73a11e889bcc860006dfcdd.GraphAnalysis_fe1fb978c73a11e889bcc860006dfcdd.GraphAnalysis_fe1fb978c73a11e889bcc860006dfcdd(*args, **kwargs)
cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

interfacemethod exportAngles(aGraph, stringOfNodeConnectivityToExport, filename)

Finds The node-Type Abundance In the Graph

Parameters:

  • aGraph (ORSModel.ors.Graph) – a graph

  • stringOfNodeConnectivityToExport (str) – a string of node connectivity type to export

  • filename (str) – file name

interfacemethod exportEdgeScalarValuesToCSV(filename, aGraph: Graph)

Exports the graph edge scalar value to CSV

Parameters:
Returns:

output (bool) – True if succeeded, False otherwise

interfacemethod exportGraphToCSV(filename, aGraph)

Exports the graph to CSV

Parameters:
Returns:

output (bool) – True if succeeded, False otherwise

interfacemethod exportNodeAbundance(aGraph, stringOfNodeConnectivityToExport, filename)

Finds The node-Type Abundance In the Graph

Parameters:

  • aGraph (ORSModel.ors.Graph) – a graph

  • stringOfNodeConnectivityToExport (str) – a string of node connectivity type to export

  • filename (str) – file name

interfacemethod exportVertexScalarValuesToCSV(filename, aGraph: Graph)

Exports the graph vertex scalar values to CSV

Parameters:
Returns:

output (bool) – True if succeeded, False otherwise

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

classmethod menuItemDefinition()

Declaration of a plugin menu item.

This method has to be decorated by “menuItem(menuItemDefinition=True)”.

Returns:

output – Menu item instance

interfacemethod pruneGraph(aGraph, aROI, timestep)

Prunes the graph by removing duplicate edges, isolated edges and deadends. Also, it merges close vertices into a single vertex

Parameters:
Returns:

output (bool) – True if succeeded, False otherwise

classmethod startMenuItem(listSelectedObjectsRepr)

Contextual menu.

This code will be executed when a contextual menu has to be displayed.

The menu item instances used in this method should be taken from menu item definitions declared in this plugin and filled with proper values (section, action, enabled, …). If multiple menu items have to be used by this method, they should be defined using the same pattern.

Parameters:

listSelectedObjectsRepr – list of selected objects (this argument is given as string representation)

Returns:

output – None, a single menu item instance, or a list of menu item instances