Changeset 8936:84b6bf763318 in orange


Ignore:
Timestamp:
09/09/11 13:16:28 (3 years ago)
Author:
matejd <matejd@…>
Branch:
default
Convert:
c6fb32542baf96ea41fa3da39d36d28265956e85
Message:

Some more docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orange/OrangeWidgets/plot/owplot3d.py

    r8935 r8936  
    291291 
    292292        self.gui = OWPlotGUI(self) 
     293    ''' 
     294            An :obj:`.OWPlotGUI` object associated with this plot 
     295    ''' 
    293296 
    294297    def __del__(self): 
     
    678681            data_scale=array([1., 1., 1.]), 
    679682            data_translation=array([0., 0., 0.])): 
     683        ''' 
     684        Explains to the plot how to interpret the data set by :meth:`set_plot_data`. Its arguments 
     685        are indices (must be less than the size of an example) into the dataset (each one 
     686        specifies a column). Additionally, it accepts a list of colors (when color is a discrete 
     687        attribute), a value specifying how many different symbols are needed to display the data, 
     688        information whether or not positional data is discrete, and data transformations (scale and 
     689        translation). 
     690 
     691        .. note:: This function does not add items to the legend automatically.  
     692                  You will have to add them yourself with :meth:`.OWLegend.add_item`.  
     693        ''' 
    680694        start = time.time() 
    681695        self.makeCurrent() 
     
    763777 
    764778    def set_plot_data(self, data, subset_data=None): 
     779        ''' 
     780        Sets the data to be drawn. 
     781 
     782        :param data: Data 
     783        :type data: numpy array 
     784 
     785        ''' 
    765786        self.makeCurrent() 
    766787        self.data = data 
     
    786807 
    787808    def set_valid_data(self, valid_data): 
     809        ''' 
     810        Specifies which examples are invalid and should not be displayed. 
     811 
     812        :param valid_data: List of booleans: true for valid indices, false otherwise 
     813        :type valid_data: list of bool 
     814        ''' 
    788815        self.valid_data = numpy.array(valid_data, dtype=bool) # QList<bool> is being a PITA 
    789816        orangeqt.Plot3D.set_valid_data(self, long(self.valid_data.ctypes.data)) 
Note: See TracChangeset for help on using the changeset viewer.