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

config general parameters of Kinect v1 camera More...

Inheritance diagram for ConfigKinect:
Inheritance graph
[legend]
Collaboration diagram for ConfigKinect:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, str yamlFilePath=None)
 the constructor. More...
 
def getConfig (self)
 returns config dictionary More...
 
def setConfig (self, str filePath)
 allows setting all configs at once More...
 
def setConfigParameter (self, cam, param, value)
 allows the setting of a specific parameter of a camera to a certain value More...
 
- Public Member Functions inherited from CfgCamera
def __init__ (self, init_dict=None, key_list=None, new_allowed=True)
 
- Public Member Functions inherited from AlgConfig
def __setattr__ (self, name, value)
 
def dump (self, **kwargs)
 

Detailed Description

config general parameters of Kinect v1 camera

config general parameters of Kinect v1 camera

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
str   yamlFilePath = None 
)

the constructor.

If yamlFilePath is not given, default initialization is done

Parameters
[in]yamlFilePaththe file path of the yaml to read camera initialization parameters from
config general parameters of Kinect v1 camera

Args:
    yamlFilePath (str):
        path of yaml configuration file

Member Function Documentation

◆ getConfig()

def getConfig (   self)

returns config dictionary

Returns
config the config dictionary
returns config dictionary

Returns:
    config:
        the config dictionary

◆ setConfig()

def setConfig (   self,
str  filePath 
)

allows setting all configs at once

Parameters
[in]filePathpath of yaml configuration file
allows setting all configs at once

Args:
    filePath (str):
        path of yaml configuration file

◆ setConfigParameter()

def setConfigParameter (   self,
  cam,
  param,
  value 
)

allows the setting of a specific parameter of a camera to a certain value

Parameters
[in]camname of the camera/config section to change the value of
[in]paramthe name of the camera parameter
[in]valuevalue to set parameter to
Note
if parameters are unclear, print out config
allows the setting of a specific parameter of a camera to a certain value

Args:
    cam:
        name of camera/config section
    param:
        name of camera parameter
    value:
        value to set parameter to

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