pyCAPS
pyCAPS: A Python Extension Module for CAPS
Loading...
Searching...
No Matches
VertexSetSequence Class Reference

Defines a Sequence of CAPS Bound Objects. More...

Inheritance diagram for VertexSetSequence:
Collaboration diagram for VertexSetSequence:

Public Member Functions

 create (self, analysis, vname=None)
 Create a CAPS VertexSet Object.
 
- Public Member Functions inherited from Sequence
 keys (self)
 Returns the keys of the Sequence.
 
 values (self)
 Returns the values of the Sequence.
 
 items (self)
 Returns the items of the Sequence.
 

Detailed Description

Defines a Sequence of CAPS Bound Objects.

Member Function Documentation

◆ create()

create (   self,
  analysis,
  vname = None 
)

Create a CAPS VertexSet Object.

Parameters
analysisA CAPS Analysis Object or the string name of an Analsysis Object instance
vnameName of the VertexSet (same as the Analysis Object if None)
Returns
The new VertexSet Object is added to the sequence and returned

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