freesasa.Result Class Reference

Stores results from SASA calculation. More...

Public Member Functions
def	__cinit__ (self)
	The constructor.
def	__dealloc__ (self)
	The destructor.
def	nAtoms (self)
	Number of atoms in the results. More...
def	totalArea (self)
	Total SASA. More...
def	atomArea (self, i)
	SASA for a given atom. More...

Detailed Description

Stores results from SASA calculation.

The type of object returned by calc(), not intended to be used outside of that context.

Wraps the C struct freesasa_result.

Definition at line 166 of file freesasa.pyx.

Member Function Documentation

def freesasa.Result.nAtoms

(

self

)

Number of atoms in the results.

Returns

Number of atoms

Definition at line 180 of file freesasa.pyx.

def freesasa.Result.totalArea

(

self

)

Total SASA.

Returns

The total area in Å^2.

Exceptions

AssertionError

If no results have been associated with the object

Definition at line 190 of file freesasa.pyx.

def freesasa.Result.atomArea	(		self,
			i
	)

SASA for a given atom.

Parameters

i	(int) index of atom.

Returns

SASA of atom i in Å^2.

Exceptions

AssertionError

If no results have been associated with the object or if index is out of bounds

Definition at line 199 of file freesasa.pyx.

---

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

• freesasa.pyx