Inheritance diagram for originpro.image.IPage:

Public Member Functions
	__repr__ (self)

	from_np (self, arr, dstack=False)

	to_np (self)

	to_np2d (self, frame)

	from_np2d (self, arr, frame)

	from_file (self, fname)

	rgb2gray (self)

	split (self)

	merge (self)

	layer (self)

	setup (self, channels, multiframe, channelType=-1)

	size (self)

	channels (self)

	frames (self)

	type (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)

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

Detailed Description

This class represents an Origin Image Window, it holds an instance of a PyOrigin ImagePage

Member Function Documentation

◆ channels()

originpro.image.IPage.channels ( self )

    Parameters:
        none
    Returns:
        image number of channels
    Examples:
        img=op.new_image()
        fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
        img.from_file(fn)
        print(img.channels)

◆ frames()

originpro.image.IPage.frames ( self )

    Parameters:
        none
    Returns:
        number of frames for an image stack, or return 1 if not multi-frames
    Examples:
        img=op.new_image()
        fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
        img.from_file(fn)
        print(img.frames)

◆ from_file()

originpro.image.IPage.from_file	(		self,
			fname )

load image(s) into the image window

Parameters:
    fname(str): file path to an image file or with wildcard to a group of image files to be loaded into an image stack

Returns:
    success of failure

Examples:
    im = op.find_image('Image1')
    folder = op.path('e') + r'Samples\Image Processing and Analysis'
    fn = folder + r'\Flower.jpg'
    im.from_file(fn)
    #load image stack simply by wildcard
    im2 = op.find_image('Image2')
    fn = folder + r'\*.tif'
    im2.from_file(fn)

    import originpro as op
    url = r'https://download.osgeo.org/geotiff/samples/gdal_eg/cea.tif'
    iw=op.new_image()
    iw.from_file(url)

◆ from_np()

originpro.image.IPage.from_np	(	self,
		arr,
		dstack = False )

Set an Image page data from a multi-dimensional numpy array.

Parameters:
    arr (numpy array):
    dstack (bool):  True if arr as row,col,frames, False if frames,row,col

Returns:
    None

Notes:
    It must first call setup() method to initialize the image window

Examples:
    img = op.new_image()
    data = np.array([[[1.0, 2.0],[3.0, 4.0]],[[5.0, 6.0],[7.0, 8.0]],[[9.0, 10.0],[11.0, 12.0]]])
    #print(data.shape)
    img.setup(1, True, 0)
    img.from_np(data, False)

◆ from_np2d()

originpro.image.IPage.from_np2d	(	self,
		arr,
		frame )

Transfers data from a 2D numpy array into one frame of an ImagePage.
The image must be multiframe, otherwise nothing is returned.
The size (width, height) of the supplied data must match the size of the image.

Parameters:
    frame (int) the index of the image frame

Returns:
    (bool) success or failure

Examples:
    im2=iw.to_np2d(1)
    im2*=10
    iw.from_np2d(im2,2)

◆ layer()

originpro.image.IPage.layer ( self )

Parameters:
    none
Returns:
    Graph layer as image holder
Examples:
    img=op.new_image()
    print(img.layer)

◆ merge()

originpro.image.IPage.merge ( self )

merge a image with 3 or 4 frames in Image Window to a single image
Parameters:
    none
Returns:
    none
Examples:
    img=op.find_image()#you should use imgstack.xfc to prepare a image with 3 or 4 frames first
    img.merge()

◆ rgb2gray()

originpro.image.IPage.rgb2gray ( self )

convert image window to grayscale
Parameters:
    none
Returns:
    none
Examples:
    img=op.new_image()
    fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
    img.from_file(fn)
    img.rgb2gray()

◆ setup()

originpro.image.IPage.setup	(	self,
		channels,
		multiframe,
		channelType = -1 )

It allows simple initialization by specifying the number of channels
and whether it should be multiframe or not. The existing image
held in the object (if present) is wiped out.

Parameters:
    channels(int): the number of channels (1, 3 or 4).
    multiframe(bool): whethwer it should be multiframe (Image Stack) or not.
    channelType (int, optional): the variable type of the channel.
                                Possible values are:
                                    0 : float64
                                    1 : float32
                                    8 : uint16
                                For all the other values the channel size will be set
                                to uint8.

Returns (bool): success or not

Examples:
    img = op.new_image()
    data = np.array([[[1.0, 2.0],[3.0, 4.0]],[[5.0, 6.0],[7.0, 8.0]],[[9.0, 10.0],[11.0, 12.0]]])
    #print(data.shape)
    img.setup(1, True, 0)
    img.from_np(data, False)

◆ size()

originpro.image.IPage.size ( self )

    width and height of the image
    Parameters:
        none
    Returns:
        (tuple) width, height value
    Examples:
        img=op.new_image()
        fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
        img.from_file(fn)
        print(img.size)

◆ split()

originpro.image.IPage.split ( self )

split a color image into RGB channels
Parameters:
    none
Returns:
    none
Examples:
    img=op.new_image()
    fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
    img.from_file(fn)
    img.split()

◆ to_np()

originpro.image.IPage.to_np ( self )

Transfers data from an ImagePage to a numpy array.

Parameters:

Returns:
    (numpy array)

Examples:
    npimg = im.to_np()

◆ to_np2d()

originpro.image.IPage.to_np2d	(		self,
			frame )

Transfers data from one frame of an ImagePage to a 2D numpy array.
The image must be multiframe, otherwise nothing is returned.

Parameters:
    frame (int) the index of the image frame

Returns:
    (numpy array)

Examples:
    im2=iw.to_np2d(1)

◆ type()

originpro.image.IPage.type ( self )

    Parameters:
        none
    Returns:
        image media type, 1=single image, 2=multi-frame, 3=video
    Examples:
        img=op.new_image()
        fn=op.path('e') + r'Samples\Image Processing and Analysis\Flower.jpg'
        img.from_file(fn)
        print(img.type)

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

src/originpro/image.py

Public Member Functions

Additional Inherited Members