Phyphox file format - Revision history

Sebastian Kuhlen: /* View-Element: camera-gui */

2026-02-12T13:43:12Z

View-Element: camera-gui

Hcszt: Typo: ends with

2025-10-25T08:25:48Z

Typo: <edit …> ends with </value>

Sebastian Kuhlen: /* View-Element: value */

2025-04-11T13:20:08Z

View-Element: value

Sebastian Kuhlen: /* Input module: camera */

2025-04-02T08:58:42Z

Input module: camera

Sebastian Kuhlen: /* View-Element: value */

2025-03-21T12:45:37Z

View-Element: value

Sebastian Kuhlen: /* View-Element: button */

2025-03-21T12:13:16Z

View-Element: button

Sebastian Kuhlen: /* Block: views */

2025-03-21T11:29:55Z

Block: views

Sebastian Kuhlen: /* Block: views */

2025-03-21T11:17:21Z

Block: views

Sebastian Kuhlen: /* Block: views */

2025-03-21T10:52:23Z

Block: views

Sebastian Kuhlen: /* Other graph types */

2025-03-21T01:10:23Z

Other graph types

@@ Line 1,196: / Line 1,196: @@
   <nowiki>
-<camera-gui label="LABEL" exposureAdjustmentLevel="INTEGER" showControls="STRING" grayscale="BOOLEAN" markOverexposure="COLOR" markUnderexposure="COLOR"/>
+<camera-gui label="LABEL" exposure_adjustment_level="INTEGER" showControls="STRING" grayscale="BOOLEAN" markOverexposure="COLOR" markUnderexposure="COLOR"/>
 </nowiki>
 This is a preview and control for a camera input, showing a preview of the camera and allowing for selecting an acquisition area and several camera settings. Note that this only makes sense if you also use a camera input in the configuration.
-''exposureAdjustmentLevel'' and ''showControls'' determine which controls are available to the user and when they are shown. In the default experiments of phyphox you typically see ''exposureAdjustmentLevel="3"'' and ''showControls="full_view_only"'.
+''exposure_adjustment_level'' and ''showControls'' determine which controls are available to the user and when they are shown. In the default experiments of phyphox you typically see ''exposure_adjustment_level="3"'' and ''showControls="full_view_only"'.
 ''grayscale'' and the ''markOverexposure'' and ''markUnderexposure'' are modifiers that influence the look of the image to make it easier to use for some measurements.
-;exposureAdjustmentLevel
+;exposure_adjustment_level
 : This determines which controls are available to the user in three different levels of how much control over the exposure is possible: Level 1 only allows for changing the camera and zoom, but no control over exposure settings. Level 2 is a simplified exposure control, allowing the same as level 1 and adding a toggle to turn auto exposure on or off as well as a simple exposure value control, adjusting for a slight over or underexposure from the auto exposure result. Level 3 finally offers all controls, replacing the exposure value control from level 2 with shutter speed (exposure time), ISO and aperture and also showing the white balance control.
 : ''optional'', default: 1
@@ Line 1,226: / Line 1,226: @@
 : Underexposed parts of the image are replaced by the given color
 : ''optional'', default: not used
 === View-Element: depth-gui ===

@@ Line 1,045: / Line 1,045: @@
 <edit label="LABEL" signed="BOOLEAN" decimal="BOOLEAN" min="FLOAT" max="FLOAT" unit="UNIT" factor="FLOAT" default="FLOAT">
      <output>BUFFER</output>
-</value>
+</edit>
 </nowiki>

@@ Line 834: / Line 834: @@
 :;degree-minutes-seconds
 :: Split the decimal part of the value of and show it separately in minutes (part of 60) and seconds (part of 3600). The output is formatted as degrees, minutes and seconds and the attribute ''precision'' affects the seconds part in this format. Example: 42.385 becomes 42° 23' 6"
 : ''optional'', default: float, '''Available since phyphox file format 1.19 (phyphox 1.2.0)'''

@@ Line 300: / Line 300: @@
   <nowiki>
-<depth x1="FLOAT" x2="FLOAT" y1="FLOAT" y2="FLOAT" autoExposure="BOOLEAN" aeStrategy="STRING" locked="STRING" feature="STRING">
+<camera x1="FLOAT" x2="FLOAT" y1="FLOAT" y2="FLOAT" autoExposure="BOOLEAN" aeStrategy="STRING" locked="STRING" feature="STRING">
      <output component="t">BUFFER</output>
      <output component="luma">BUFFER</output>
@@ Line 310: / Line 310: @@
      <output component="iso">BUFFER</output>
      <output component="apertue">BUFFER</output>
-</depth>
+</camera>
 </nowiki>
@@ Line 381: / Line 381: @@
 : This determines the kind of camera analysis. At the moment the only option and the default is ''photometric''.
 : ''optional'', default: photometric
 === Input module: depth ===

@@ Line 787: / Line 787: @@
   <nowiki>
-<value label="LABEL" size="FLOAT" precision="INTEGER" scientific="BOOLEAN" unit="UNIT" factor="FLOAT" color="COLOR">
+<value label="LABEL" size="FLOAT" precision="INTEGER" scientific="BOOLEAN" unit="UNIT" factor="FLOAT" format="STRING" color="COLOR">
      <input>BUFFER</input>
      <map min="DOUBLE" max="DOUBLE">STRING</map>
@@ Line 796: / Line 796: @@
 The value element displays a single value to the user. If the input buffer contains more than one value, the latest value will be displayed. The input is defined by a simple ''input'' tag within the value block and needs to be a data-container (see above).
-Since version 1.5 (phyphox 1.0.7) you can define range mappings with the map-tag. The map tag includes a string which will replace the number and unit that would be displayed otherwise. phyphox will test all mappings in the order they are given and replace the output with the first mapping that applies. A mapping applies if the value to be shown falls in the range given by the attributes ''min'' and ''max'' (inclusive). ''min'' and ''max'' can be left out and default to negative and positive infinity. So, a map-tag without any attributes acts as a catch-all case.
+Since file format version 1.5 (phyphox 1.0.7) you can define range mappings with the map-tag. The map tag includes a string which will replace the number and unit that would be displayed otherwise. phyphox will test all mappings in the order they are given and replace the output with the first mapping that applies. A mapping applies if the value to be shown falls in the range given by the attributes ''min'' and ''max'' (inclusive). ''min'' and ''max'' can be left out and default to negative and positive infinity. So, a map-tag without any attributes acts as a catch-all case.
 ;label
@@ Line 816: / Line 818: @@
 : A unit to be displayed after the value
 : ''optional'', default: no unit
 ;factor
 : A factor to be applied to the value before displaying it. This is usually used for unit conversion. Example: The data is in meter, but should be displayed in cm. The factor would be 0.01
 : ''optional'', default: 1.0
 === View-Element: graph ===

@@ Line 1,062: / Line 1,062: @@
   <nowiki>
-<button label="LABEL">
+<button label="LABEL" dynamicLabel="BUFFER">
      <input>BUFFER1</input>
      <output>BUFFER1</output>
@@ Line 1,070: / Line 1,070: @@
      <output>BUFFER3</output>
      <trigger>ID</trigger>
 </button>
 </nowiki>
@@ Line 1,078: / Line 1,082: @@
 Since version 1.8 (phyphox 1.1.3) in addition to defining in and out buffer (or usually as an alternative), you can set a trigger tag defining an id. This triggers matching processes with the same id like a [[Network Connections|network connection]] (the only example at the time of this writing).
 ;label
 : A label for this element
 : ''required''
+;dynamicLabel
 === View-Element: toggle ===

← Older revision		Revision as of 11:29, 21 March 2025
Line 1,142:		Line 1,142:
	: ''optional'', default: true		: ''optional'', default: true

		+	=== View-Element: dropdown ===
		+
		+	'''Available since phyphox file format 1.19 (phyphox 1.2.0)'''
		+
		+	<nowiki>
		+	<dropdown label="LABEL" default="FLOAT">
		+	<output>BUFFER</output>
		+	<map value="FLOAT">OPTION 1</map>
		+	<map value="FLOAT">OPTION 2</map>
		+	...
		+	<map value="FLOAT">OPTION 3</map>
		+	</dropdown>
		+	</nowiki>
		+
		+	The dropdown view element gives the user a list of options, each of which is associated with a value. The user simply taps the dropdown box, picks an option and the associated value is written to the output buffer.
		+
		+	;label
		+	: A label for this element
		+	: ''required''
		+	;default
		+	: The value with which the associated buffer should start.
		+	: ''optional'', default: do not set a starting value

	=== View-Element: camera-gui ===		=== View-Element: camera-gui ===

← Older revision		Revision as of 11:17, 21 March 2025
Line 1,102:		Line 1,102:
	: The value with which the associated buffer should start.		: The value with which the associated buffer should start.
	: ''optional'', default: do not set a starting value		: ''optional'', default: do not set a starting value
		+
		+	=== View-Element: slider ===
		+
		+	'''Available since phyphox file format 1.19 (phyphox 1.2.0)'''
		+
		+	<nowiki>
		+	<slider label="LABEL" type="STRING" default="FLOAT" minValue="FLOAT" maxValue="FLOAT" stepSize="FLOAT" precision="INTEGER" showValue="BOOL">
		+	<output>BUFFER_NORMAL</output>
		+	<output value="lowerValue">BUFFER_RANGE_LOWER</output>
		+	<output value="upperValue">BUFFER_RANGE_UPPER</output>
		+	</slider>
		+	</nowiki>
		+
		+	This is a view element used to input values from a limited range determined by a minimum and maximum value as well as a step size. The current value is also shown separately. With ''type="range"'' the slider can be used as a range slider with two handles, allowing the user to select a range by picking a lower and an upper value.
		+
		+	;label
		+	: A label for this element
		+	: ''required''
		+	;type
		+	: Can either be "normal" or "range". Normal is a slider representing a single value, while "range" is a range slider with two handles that allow picking a lower and an upper value.
		+	: ''optional'', default: normal
		+	;default
		+	: The value with which the associated buffer should start. (Does not work in range slider mode. Use the init property of the data containers instead.)
		+	: ''optional'', default: do not set a starting value
		+	;minValue
		+	: Value for a handle at the lower end of the slider.
		+	: ''optional'', default: 0
		+	;maxValue
		+	: Value for a handle at the upper end of the slider.
		+	: ''optional'', default: 1
		+	;stepSize
		+	: Determines the minimum distance between to values that can be selected with the slider. This is always relative to minValue, so a stepSize of 0.2 and a minValue of 0.1 will force the user to pick 0.1, 0.3, 0.5, etc.
		+	: ''optional'', default: 1
		+	;precision
		+	: The number of decimal places shown in the field with the current vlaue
		+	: ''optional'', default: 2
		+	;showValue
		+	: Show a title and the current value above the slider. If turned off, the title is also hidden, making the slider very thin and compact.
		+	: ''optional'', default: true

← Older revision		Revision as of 10:52, 21 March 2025
Line 1,082:		Line 1,082:
	: A label for this element		: A label for this element
	: ''required''		: ''required''
		+
		+
		+	=== View-Element: toggle ===
		+
		+	'''Available since phyphox file format 1.19 (phyphox 1.2.0)'''
		+
		+	<nowiki>
		+	<toggle label="LABEL" default="FLOAT">
		+	<output>BUFFER</output>
		+	</toggle>
		+	</nowiki>
		+
		+	The toggle element displays a simple toggle (or a checkbox in the remote control interface), which allows the user to turn something off or on. The output buffer receives a 0 for off and a 1 for on. If the buffer is changed externally, a 0 is always interpreted as off while any other value is displayed as on.
		+
		+	;label
		+	: A label for this element
		+	: ''required''
		+	;default
		+	: The value with which the associated buffer should start.
		+	: ''optional'', default: do not set a starting value

@@ Line 987: / Line 987: @@
 : n-th color in the color map
 : ''optional'', if none are defined, phyphox uses a black-orange-white color gradient
 You can also define your own color palette. Phyphox uses a black-orange-white gradient by default, but introducing more colors can be very helpful to improve contrast. Colors a simply defined as a series of colors that are spread across the z range: