RF Sweep

This page contains definitions for schemas used for configuring RF Sweep measurements.

RFSensorMasterList

This is configuration that is used to validate settings by matching a sensor’s name against its expected model. It is a file that is supplied in addition to the measurement RFSweepConfiguration.

properties
RFSOURCES	RF Sources used to produce a signal.
	type	array
	items	type	string
CALORIMETERS	Names of commercial mounts that just produce a power reading.
	type	array
	items	type	string
COMMERCIAL_MOUNTS	Names of commercial mounts that just produce a power reading.
	type	array
	items	type	string
SPECIAL_MOUNTS	Names of special mounts that have no sensing element.
	type	array
	items	type	string
THIN_FILM_MOUNTS	Names of thinfilm mounts that require a PTC feedback loop.
	type	array
	items	type	string
THERMISTOR_MOUNTS	Name of thermistor mounts that require an NTC feedback loop
	type	array
	items	type	string
KEYSIGHT_THERMOPILE_BALANCE_MOUNTS	Name of keysight balance mounts are not operated with a feedback loop.
	type	array
	items	type	string
EXPECTED_RESISTANCE	Key-value pairs of every sensor and what they’re resistance should be (if applicable).
	type	object
	additionalProperties	type	number
EXPECTED_LINEAR_TERM_BOUNDS	Key-value pairs of the expected linear term of the thermoelectric sensor in volts per watts.
	type	object
	additionalProperties	type	array
		items	type	number
			minimum	0
		maxItems	2
		minItems	2
additionalProperties	False

Configuration of an RF Sweep

type	object
properties
measurement_description	Descriptive metadata about the experiment.
	RFSweepMeasurementDescription
output_settings	Describes data ouput settings for the data-record.
	RFSweepOutputSettings
levelling_settings	Describes the configuration for active RF levelling procedures.
	RFSweepLevellingSettings
stats_settings	Describes statistical tests used for determining if the thermopile element is level.
	RFSweepStatsSettings
column_model_mapping	Maps the columns of the data-record file to a model of the sensor.
	RFSweepColumnModelMapping.json
run_settings_columns	Describes the names of the columns from the run settings file. Shouldn’t change.
	RFSweepRunSettingsColumns
gpib_interface	Address to the GPIB interface being used (e.g. GPIB0::INTFC)
	type	string
instruments	type	object
	properties
	names	type	array
		items	type	string
	additionalProperties	Additional properties are all instrument roles.
		RFSweepInstrumentRole

RFSweepMeasurementDescription

A set of descriptive properties of the measurement

properties
connector_type	Connector type of the microcalorimeter.
	type	string
system	Designation for measurement system (i.e. system A, B, etc)
	type	string
water_bath_temperature	Temperature of the water bath in Celsius.
	type	number
notes	Additional notes about the measurement.
	type	string
calorimeter_name	Name of the calorimeter being used.
	type	string
DUT_name	Name of the device under test (DUT) inside the microcalorimeter.
	type	string
thermal_ref_name	Name of the device used as a thermal reference (if applicable).
	type	string
monitor_name	Name of the sidearm (S3) inside the microcalorimeter.
	type	string
RF_source_name	Name of the sidearm (S3) inside the microcalorimeter.
	type	string
splitter_name	Name of the splitter being used
	type	string
connect_number	Connect number of the DUT.
	type	integer
DC_source_type	What type of DC source is being used to bias the DUT (if applicable)
	type	string
	enum	PTC_SMU, NTC_SMU, NTC_TYPE_IV, PTC_TYPE_IV
RF_source_type	What type of DC source is being used to bias the DUT (if applicable)
	type	string
	enum	signal_generator, VNA
lead_resistance	Resistance of DC lead connected to the DUT (usually zero).
additionalProperties	False

RFSweepOutputSettings

Describes the settings for outputing data from an RF sweep.

properties
out_file_name	Name of the file (with.csv extension) for saving the data-record.
	type	string
metadata_file_name	Name of the metadata file (with.csv extension) for saving the data-record.
	type	string
maxlen	Maximum length of the in memory data record.
	type	integer
minlen	Minimum length of the in memory data record.
	type	integer
columns	a list of every column for the datarecord.
	type	string / array
	items	type	string
plot_interval	How often to produce a short plot of whats in the active memory of the data-record (seconds).
	type	number
short_plot_time_window	Time window (in seconds) for short plot made every plot_interval.
	type	number
additionalProperties	False

RFSweepLevellingSettings

Settings that define the levelling behaviour of the RF sweep.

properties
level_to	DUT or monitor, which sensor to use for leveling feedback.
	type	string
	enum	DUT_power, monitor_power
use_GPIB_levelling	If true, utilize levelling over GPIB commands.
	type	boolean
GPIB_levelling_C	constant of integration for the GPIB levelling feedback.
	type	number
	exclusiveMaximum	1
	minimum	0
GPIB_levelling_time	Duration of levelling via GPIB in seconds (starts immediatley, AM levelling starts after this finished).
	type	number
	minimum	0
use_AM_levelling	If true, utilize AM levelling via a voltage source.
	type	boolean
AM_levelling_C	constant of integration for the AM levelling feedback.
	type	number
	exclusiveMaximum	1
	minimum	0
AM_levelling_time	Duration of levelling via AM in seconds (after GPIB levelling finishes).
	type	number
	minimum	0
max_source_power_change_dB	rf power will not change by more than this ammount in a levelling step
	type	number
	exclusiveMaximum	1
	minimum	0
V_off_slow_min	in volts. If V_off slow is less than this number, assume an error has occurred and stop the experiment. Only applies to bolometers.
	type	number
	exclusiveMaximum	10
	minimum	0
V_off_slow_max	in volts. If V_off slow is less than this number, assume an error has occurred and stop the experiment. Only applies to bolometers.
	type	number
	exclusiveMaximum	10
	minimum	0
AM_HARDMAX	Max allowed power for for the DUT in dBm.
	type	number
	exclusiveMaximum	0.5
HARD_MAX_dBm	type	object
	properties
	monitor_power	Max allowed power for the monitor in dBm.
		type	number
	DUT_power	Max allowed power for the DUT in dBm.
		type	number
	calorimeter_power	Max allowed power for for the calorimeter_thermopile in dBm.
		type	number
	RF_source_power	Max allowed power for for the rfsource in dBm.
		type	number
	additionalProperties	False
additionalProperties	False

RFSweepSignalConfig

Defines signals in an RF sweep. These relate raw data in the record to physical signals at physical locations in the measurement.

type	object
properties
DUT_power	Mapping of sensor models and columns for the device under test (DUT) inside the calorimeter
	oneOf	ThermoelectricSignal
		BolometerSignal
		CommercialPowerSensorSignal
		SpecialSensorSignal
RF_source_power	Mapping of sensor models and columns for the rfsource outside the calorimeter
monitor_power	Mapping of sensor models and columns for the monitor outside the calorimeter
	oneOf	ThermoelectricSignal
		BolometerSignal
		CommercialPowerSensorSignal
calorimeter_power	Describes the signal that can be associated with the calorimeter thermopile.
	ThermoelectricSignal
additionalProperties	False

Units

Possible units of a quantity.

type	string
enum	V, W, A, dBm

RecordedQuantity

A quantity connected to a column in the record produced by an instrument.

type	object
properties
units	Units
column	type	string
instrument	type	string
additionalProperties	False

SignalConfigGeneral

Describes required properties of a signal.

type	object
properties
type	type	string
units	Units
can_level	type	boolean
input_signals	type	string / array
	items	type	string
		enum	e, vdc, idc, power

ThermoelectricSignal

A signal associated with a thermoelectric power sensor.

properties
type	enum	thermoelectric
coeffs
e	RecordedQuantity
allOf	SignalConfigGeneral

BolometerSignal

A signal associated with a bolometer power sensor.

properties
type	enum	bolometer
resistance	type	number
can_level	enum	True
vdc	RecordedQuantity
idc	RecordedQuantity
allOf	SignalConfigGeneral

RFSourceSignal

A signal associated with an RF source.

properties
type	enum	RF_source
can_level	enum	True
power	RecordedQuantity
vdc	RecordedQuantity
allOf	SignalConfigGeneral

SpecialSensorSignal

A signal associated with a special sensor used in microcalorimetry.

properties
type	enum	special
idc	RecordedQuantity
vdc	RecordedQuantity
allOf	SignalConfigGeneral

CommercialPowerSensorSignal

A signal associated with a commercial power sensor.

properties
type	enum	commercial
power	RecordedQuantity
allOf	SignalConfigGeneral

RFSweepRunSettingsColumns

Describes the names of the columns used in the run settings file. These should never change, but are checked here.

properties
names	Names of the columns in the run settings file.
	type	array
types	Names of the columns in the run settings file.
	type	array
	items	type	string
		enum	float
additionalProperties	False

RFSweepStatsSettings

Defines the names of the columns in the data-record.

properties
names	How long to wait before starting the sweep (in seconds).
	type	number
	minimum	0
initial_wait	Warm up time before the measurement starts (in seconds).
	type	number
	minimum	0
minimum_wait	Minimum time to wait before stability tests are allowed to pass (in seconds).
	type	number
	minimum	0
use_traditional_stats	If True, use kendal test and runs test to check stability.
	type	boolean
stats_window	Thermopile voltage must be stable over this time period to proceed to the next frequency (in seconds).
	type	number
stats_Rcv	Used by runs test. Hiher = more stringent test.
	type	number
stats_Tcv	Used by Kendall test. Higher = more stringent.
	type	number
measurement_interval	Thermopile voltage sampling interval for computing stability stats in seconds.
	type	number
additionalProperties	False

RFSweepMeasurementMode

describes what settings to use on an instrument for a particular mode of the experiment.

allOf	AnyInstrument
	type	object
	properties
	enable	enables the instrument for a particular mode of the experiment.
		type	boolean

RFSweepInstrumentRole

type	object
properties
output_column	Name of the output column to save to the data record.
	type	string
model	Manufacturer model code of instrument. See possible instruments.
	type	string
serial	Property tag or serial used to ID instruments.
	type	string
*IDN?	Response to a *IDN? query or equivalent.
	type	string
GPIB_address	Address of the GPIB Resouce
	type	string
role	Designates the behaviour of the instrument during the measurement.
	type	string
	enum	thermopile_monitor, bias_monitor, RF_source, RF_amplitude_adjuster, power_meter
initial_settings	Describes the initial state of the instrument.
	type	object
	AnyInstrument
monitor_mode_settings	Describes how the instrument should behave during the monitor mode of the experiment.
	RFSweepMeasurementMode
fast_off_mode_settings	Describes how the instrument should behave during the monitor mode of the experiment.
	RFSweepMeasurementMode
additionalProperties	False