cls.GOGraphNode.CGOGraphNode Class Reference

Storage class for semantic similarity specific data. More...

Public Member Functions
def	__init__ (s, goID, name, cnt=0, freq=0)
def	__str__ (s)
def	Normalize (s, freqRoot)
	Compute term probabilities and information content. More...
def	IsNone (s)
	Is this the empty node used to communicate undefined values? More...
def	IsNotNone (s)
	Is this a real node with valid GO ID and name? More...

Detailed Description

Storage class for semantic similarity specific data.

The following data is stored and can directly be accessed, they are
explained in @ref cls.GOGraphBase.CGOGraphBase.
- @c ID GO ID.
- @c Name GO term name.
- @c Cnt Node count.
- @c Freq Node frequency.
- @c Prob Node probability. Is set to @c None, if the node frequency is
  @c equal to zero.
- @c IC Node information content as -log10(Prob). Is set to @c None, if
  the node probability equals to @c None.

Constructor & Destructor Documentation

__init__()

def cls.GOGraphNode.CGOGraphNode.__init__	(		s,
			goID,
			name,
			cnt = 0,
			freq = 0
	)

Member Function Documentation

__str__()

def cls.GOGraphNode.CGOGraphNode.__str__

(

s

)

IsNone()

def cls.GOGraphNode.CGOGraphNode.IsNone

(

s

)

Is this the empty node used to communicate undefined values?

    @return @c True or @c False;

IsNotNone()

def cls.GOGraphNode.CGOGraphNode.IsNotNone

(

s

)

Is this a real node with valid GO ID and name?

    @return @c True or @c False;

Normalize()

def cls.GOGraphNode.CGOGraphNode.Normalize	(		s,
			freqRoot
	)

Compute term probabilities and information content.

    Computation of probabilities can only be done if the node's frequency
    is non-zero. If it is zero, the probability and information content
    are not defined and are set to @c None.
    @param freqRoot  The root term frequency, a positive non-zero integer.

---

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

• cls/GOGraphNode.py