xapp.aoSim Namespace Reference

Classes
class	aoSim
class	aoSimConfig

Functions
	create_if_not_exist_shmim (name, shape, dtype=np.float32)

Variables
	main = aoSim.console_app

Function Documentation

create_if_not_exist_shmim()

xapp.aoSim.create_if_not_exist_shmim	(		name,
			shape,
			dtype = np.float32
	)

Create or verify a shared memory image (shmim) with the specified parameters.

Creates a new shared memory image if it does not exist, or verifies that an existing
image has the correct shape and data type. If an existing image has incompatible
parameters, it is destroyed and recreated.

Args:
    name (str): The name of the shared memory image to create or access.
    shape (tuple): The desired shape of the array as (height, width).
    dtype (type, optional): The numpy data type for the array. 
        Defaults to np.float32 (FLOAT). Can also be np.float64 (DOUBLE).

Returns:
    None
    
Note:
    This function closes the connection to the shmim after creation/verification.
    Other processes can open the shmim by its name independently.

Definition at line 12 of file __init__.py.

Variable Documentation

main

xapp.aoSim.main = aoSim.console_app

Definition at line 152 of file __init__.py.