[sphinx] Sphinxy docstrings example

sphinx_docs_strings_example.py

#the docstrings for the method calculate from pyslid

def calculate( conn, iid, scale=1, set="slf33", field=True, rid=None, pixels=0, channels=[], zslice=0, timepoint=0, threshold=None, debug=False ):
    '''
    Calculates and returns a feature ids vector, a feature vector and the output scale given a valid
    image identification (iid). It currently can calculate SLF33, SLF34, SLF35 and SLF36.

    This method will try to retrieve the resolution of the image from the annotations. 

    If the method is unable to connect to the OMERO.server, then the method will return None.

    If the method doesn't find an image associated with the given image id (iid), then the method will return None.

    For detailed outputs, set debug flag to True.
    
    :param conn: connection
    :param iid: image id
    :type iid: long
    :param scale: image scale
    :type scale: double
    :param set: feature set name
    :type set: string
    :param field: true if field features, false otherwise
    :type field: boolean
    :param rid: region id
    :type rid: long
    :param pixels: pixel index associated with the image
    :type pixels: integer
    :param channels: list of channel indices
    :type channels: list of integers
    :param zslice: zslice index
    :type zslice: integer
    :param timepoint: time point index
    :type timepoint: integer
    :param threshold: image size threshold value
    :type threshold: integer
    :param debug: debug flag
    :type debug: boolean
    :rtype: a list of feature ids, a feature vector and the scale at which the features where calculated
    '''