Measurement Header Data

With the Measurement Header Data the user can tag stored recordings with specific user defined data lines. The lines are managed via the Oxygen System Setup.

The following SCPI commands allows to retrieve and manipulate the measurement header data lines from the System Setup.

:HEADer:ADD <key>,<description>

Syntax

  1. :HEADer:ADD <key>, <description>

  2. :HEADer:ADD TEXT, <key>, <description>

  3. :HEADer:ADD NUMERIC_CONSTANT, <key>, <VALUE>

Description

Add a new measure header data line

Parameter

Name

Type

Range

Default

<KEY>

ASCII String

None

<DESCRIPTION>

ASCII String

None

<VALUE>

Nrf

None

Explanation

Command (1) + (2): Adds a new measurement header data line entry with the specified key

Command (3) Adds a named constant with the specified value. Constants need to have unique names and can only edited while not in a measurement.

Example

-> :HEAD:GET? "Header 1"
-> :HEAD:ADD "Header 1","Description in Line 1"
-> :HEAD:GET? "Header 1"
<- :HEAD:GET "Description in Line 1"

:HEADer:GET? <key>

Syntax

:HEADer:GET? <key>

Description

Query a measurement data line

Parameter

Name

Type

Range

Default

<KEY>

ASCII String

None

Explanation

Returns the content (description) of the header data line with the specified key.

Return Format

String

Example

-> :HEADer:GET? "Key 1"
<- :HEAD:GET "HEAD DATA Line 1"

:HEADer:KEYs?

Syntax

:HEADer:KEYs?

Description

Query all keys of the measurement header data

Parameter

None

Explanation

Returns a list of all keys (names) of all measurement header data lines.

Return Format

[String[,String[]…]] | None

Example

-> :HEAD:ADD "Header 1","Description in Line 1"
-> :HEAD:ADD TEXT,"Header 2","Description in Line 2"
-> :HEAD:KEYs?
<- :HEAD:KEY "Header 1","Header 2"

:HEADer:SET <key>,<description>

Syntax

  1. :HEADer:SET <key>,<description>

  2. :HEADer:SET TEXT, <key>, <description>

  3. :HEADer:SET NUMERIC_CONSTANT, <key>, <VALUE>

Description

Sets a content to a measure header data line

Parameter

Name

Type

Range

Default

<KEY>

ASCII String

None

<DESCRIPTION>

ASCII String

None

<VALUE>

Nrf

None

Explanation

Command (1) + (2): Set the description value of the measurement header data line with the key <key>.

Command (3) Set the value of the specified constant. Constants need to have unique names and can only edited while not in a measurement.

Example

-> :HEAD:GET? "Header 1"
<- :HEAD:GET "Description in Line 1”
-> :HEAD:SET "Header 1","A new description in line 1"
-> :HEAD:GET? "Header 1"
<- :HEAD:GET "A new description in line 1"

:HEADer:DELete <key>[,<key>[,…]]

Syntax

:HEADer:DELete <key>,<key>,…

Description

Delete measurement header data line(s)

Parameter

Name

Type

Range

Default

<KEY>

ASCII String

None

Explanation

This command allows to delete one or more measurement header data lines. Constants cannot be deleted during measurement.

Example

-> :HEAD:GET? "Header 1"
<- :HEAD:GET "Description in Line 1”
-> :HEAD:KEYs?
<- :HEAD:KEY "Header 1","Header 2",”Header 3”
-> :HEAD:DELete "Header 1","Header 3"
-> :HEAD:KEYs?
<- :HEAD:KEY "Header 2"

:HEADer:VALues?

Syntax

:HEADer:VALues?

Description

Query the measurement header data

Parameter

Explanation

Returns a list of all key value fields stored in the measurement header data.

The third element is the data type, currently either TEXT or NUMERIC_CONSTANT.

New elements may be added to the fields in the future depending on the type.

Return Format

(String, String),(String, String),…

Example

-> :HEAD:VALues?
<- :HEAD:VAL ("Header 1","Description in line 1",TEXT),("Header 2","Description in Line 2",TEXT)