IVALab Python Libraries
Collection of code for computer vision and robotics with specific API.
Public Member Functions | Public Attributes | List of all members
Base Class Reference

Base class for camera runners. More...

Inheritance diagram for Base:
Inheritance graph
[legend]

Public Member Functions

None __init__ (self, configs, K=None)
 Base class instantiator for camera runners. More...
 
def get (self, key)
 
def get_configs (self)
 
def get_frames (self)
 
def readClicks (self)
 Read the mouse clicks recorded on a window. More...
 
def registerMouseClicks (self, str windowName)
 Register a window to record mouse clicks. More...
 
def set (self, key, value)
 
def set_configs (self, configs)
 
def set_intrinsic (self, K)
 
def start (self)
 
def stop (self)
 

Public Attributes

 configs
 configuration dictionary for the camera More...
 
 K
 the camera's intrinsic matrix More...
 
 pts
 callback to append clicks to points list More...
 

Detailed Description

Base class for camera runners.

Defines some shared functionality interfaces

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  configs,
  K = None 
)

Base class instantiator for camera runners.

Reimplemented in Grayscale, and Color.

Member Function Documentation

◆ get()

def get (   self,
  key 
)
Get a particular configuration.

Args:
    key (Any): The configuration name

Reimplemented in RGBD_Aligned, D435_Runner, and D435_Runner.

◆ get_configs()

def get_configs (   self)
Get all the configurations

Reimplemented in Depth, Color, Depth, Color, Depth, and Color.

◆ get_frames()

def get_frames (   self)
Get the next frames

Reimplemented in Color, and Color.

◆ readClicks()

def readClicks (   self)

Read the mouse clicks recorded on a window.

Returns
returnPts the x,y coordinates of the clicks or None if no clicks have happened
Read the mouse clicks recorded on a window. Returns None if there are no clicks ready

Returns:
    clicks :
        (ndarray(2, N)) - N is the number of clicks. Shape is [[x], [y]]

◆ registerMouseClicks()

def registerMouseClicks (   self,
str  windowName 
)

Register a window to record mouse clicks.

Parameters
windowNameThe name of the window to caputre clicks on
Register a window to record mouse clicks

Args:
    windowName (string) : The name of the window to caputre clicks on

◆ set()

def set (   self,
  key,
  value 
)
Set a particular configuration.

Args:
    key (Any): The configuration name
    value (Any): The value to be set

◆ set_configs()

def set_configs (   self,
  configs 
)
set all the configurations

Args:
    configs (Any): The desired configurations

Reimplemented in Depth, and Color.

◆ set_intrinsic()

def set_intrinsic (   self,
  K 
)
Sets the intrinsic matrix
Args:
    K (Any): the new intrinsic matrix

◆ start()

def start (   self)
Starts the camera

Reimplemented in Depth, Color, RGBD, Depth, Color, Depth, Color, Replay, D435_Runner, and ReplayColor.

◆ stop()

def stop (   self)
Stops the camera

Reimplemented in Depth, Color, RGBD, Depth, Color, Depth, Color, and D435_Runner.

Member Data Documentation

◆ configs

configs

configuration dictionary for the camera

◆ K

K

the camera's intrinsic matrix

◆ pts

pts

callback to append clicks to points list

Parameters
[in]eventthe event that happened
[in]xthe x location of the mouse
[in]ythe y location of the mouse
[in]flagsflags for the function
[in]paramsparameters for the function

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