The C++ Augmented Reality Toolkit

Appendix D - ARLib Configuration File

The following configuration file is supplied as default with ARLib:

default.conf


#########################################################

# Default configuration settings for ARLib applications #

#########################################################



# The common section defines configuration options applicable

# to all ARLib applications.



###############################################################################

[Common]

###############################################################################



# Image is for specifying an image to be automatically loaded.



	Image =



# Sequence is for specifying the first image of a sequence of image to load.



	Sequence =



# MarkerFile is for specifying an alternate marker configuration file.

# The default is "config/markers.conf". If no value then default will be used.



	MarkerFile = 



# ModelFile is for specifying an alternate model configuration file.

# The default is "config/models.conf". If no value then default will be used.



	ModelFile = 



# ShowUI is an ovveride for the displaying of all user interface elements 

# (e.g. showfps). If this value is not set then no UI elements will display. 

# The default is 0 (off). Acceptable values are 1 or 0.



	showUI = 1



# Realtime denotes whether image sequences should run at realtime (as denoted

# by the fps setting). If realtime is off then frames will be displayed as

# they are processed. The default is 1 (on). Acceptable values are 1 or 0.



	realtime = 1



# denotes the required frames per second to display.

# The default is 25. Acceptible values are 1 to 100.



	fps = 25



# Zoom denotes how much the image should be zoomed or scaled

# The default is 1. Acceptible values are in the range of 1 to 20.



	Zoom = 2



 

# Fullscreen denotes whether the application should start in full screen mode.

# The default is 0 (off). Acceptable values are 1 or 0.



	FullScreen = 0



# WindowWidth defines the default startup width of the main window.

# The default is 800. Acceptable values are a position integer.



	WindowWidth = 800



# WindowHeight defines the default startup height of the main window.

# The default is 600. Acceptable values are a position integer.



	WindowHeight = 600

	

# ShowAR denotes whether the augmented elements should be display.

# The default is 1 (on). Acceptable values are 1 or 0.

	

	ShowAR = 1

	

# ShowFPS denotes whether frames per second should be displayed or not.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowFPS = 1



# ShowFrameNo denotes whether the current frame number should be displayed.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowFrameNo = 1



# ShowFocalLength denotes whether to display the current focal length.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowFocalLength = 1



# (LINUX) Denotes whether the image show be flipped upside down. Some (if not

# all webcam drivers appear to read the image upside down).

# The default is 1 (on). Acceptable values are 1 or 0.



	FlipHorizontal = 1



# (LINUX) Specifies the default device to open for streaming webcam support.

# The default is /dev/video0.



	DefaultDevice =

	



# Specifies the location to store snapshots.

# The default is "".



	SnapshotLocation = snapshots



# Specifies the prefix of the snapshot file name. The format of the final image

# will be SnapshotPrefix.n.tif.

# The default is "snapshot".



	SnapshotPrefix = snapshot

	



 

###############################################################################

[Segmentation]

###############################################################################



# The segmentation section defines options for producing a black and white

# image from the pixel colour values.



# The OtsuOffset defines how much the dynamically calculated threshold value

# should be adjusted. The Default is 0. Acceptable values are -255 to 255.



	OtsuOffset = 55



# UseLuminance denotes how the black and white values should be calculated from

# the colour values. If set then a lumunance formula is used otherwise an 

# average of the red, green and blue value is used. The default is 1 (On).

# Acceptable values are 1 or 0.

	

	UseLuminance = 1





###############################################################################

[Detection]

###############################################################################



# ShowBoundingBoxes denotes whether boxes should be draw around potential

# markers. The default is 0 (off). Acceptable values are 1 or 0.



	ShowBoundingBoxes = 1



# ShowCorners denotes whether potential marker corners should be display.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowCorners = 1



# ShowMarkerEdge denotes whether the markers outer edge should be highlighted.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowMarkerEdge = 1



# ShowMarkerID denotes whether to display the detected marker id.

# The default is 0 (off). Acceptable values are 1 or 0.



	ShowMarkerID = 1



# The MinArea defines the minimum size in pixels that a bounding box is deemed

# valid. The Default = 625. Acceptable values are a positive integer.



	MinArea = 400





###############################################################################

[Pose]

###############################################################################



# UseFixedFocal denotes whether the fixed Focal Length values should be used or

# whether the focal length should be dynamic calculated based on detected marker

# position. The Default = 1. Acceptable values are 1 or 0.



	UseFixedFocal = 1



 

# The FocalLength parameters defines the fixed focal length in the U and V

# directions.



	FocalLength = 800,400





# The Rotation parameter defines a default rotation for each model prior to

# being diplayed. The three values represent rotation degrees in the x, y and z

# axis. The default is 0,0,0.



	Rotation = 90,0,0



        

        

        
<< Appendix B - ARLib Application Command-Line Switches References >>