originpro.matrix.MBook Class Reference

Inheritance diagram for originpro.matrix.MBook:

Public Member Functions
	add_sheet (self, name='', active=True)
	show_image (self, show=True)
Public Member Functions inherited from originpro.base.DBook
	__repr__ (self)
	__getitem__ (self, index)
	__iter__ (self)
Public Member Functions inherited from originpro.base.BasePage
	__len__ (self)
	is_open (self)
	is_active (self)
	lt_range (self)
	activate (self)
	destroy (self)
	duplicate (self)
Public Member Functions inherited from originpro.base.BaseObject
	__init__ (self, obj)
	__del__ (self)
	__str__ (self)
	__bool__ (self)
	index (self)
	get_str (self, prop)
	get_int (self, prop)
	get_float (self, prop)
	set_str (self, prop, value)
	set_int (self, prop, value)
	set_float (self, prop, value)
	method_int (self, name, arg='')
	method_float (self, name, arg='')
	method_str (self, name, arg='')
	lt_exec (self, labtalk)
	name (self)
	name (self, value)
	lname (self)
	lname (self, value)
	comments (self)
	comments (self, value)
	show (self)
	show (self, value)
	usertree (self)
	usertree (self, tr)
	userprops (self)

Protected Member Functions
	_sheet (self, obj)
Protected Member Functions inherited from originpro.base.DBook
	_get_book_type (self)
	_add_sheet (self, name, active)

Additional Inherited Members
Public Attributes inherited from originpro.base.DBook
	obj
Public Attributes inherited from originpro.base.BaseObject
	obj = obj

Detailed Description

This class represents an Origin Matrix Book, it holds an instance of a PyOrigin MatrixPage.

Member Function Documentation

_sheet()

originpro.matrix.MBook._sheet ( self, obj )

protected

Reimplemented from originpro.base.DBook.

add_sheet()

originpro.matrix.MBook.add_sheet	(		self,
			name = '',
			active = True )

add a new matrix sheet to the matrix book

Parameters:
    name (str): the name of the new sheet. If not specified, default names will be used
    active (bool): Activate the newly added sheet or not

Return:
    (MSheet)

Examples:
    mb = ma.get_book().add_sheet('Dot Product')
    print(mb.shape)

show_image()

originpro.matrix.MBook.show_image	(		self,
			show = True )

similar to MSheet, but set all sheets in matrix book

Parameters:
    show (bool): If True, show as images

Returns:
    None

Examples:
    mb = op.find_book('m', 'MBook1')
    mb.show_image()

---

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

• src/originpro/matrix.py