Measurements¶

Model definitions¶

Generic calibration class

Field	Type	Title (Description)
`calibration_date`	`datetime (timezone-aware)`	Date and time of calibration
`description`	`str`	Description (Brief description of what is being calibrated)
`measured_at`	`Optional[str]`	Measurement location
`input`	`List[float or str]`	Inputs (Calibration input)
`input_unit`	SizeUnit or MassUnit or FrequencyUnit or SpeedUnit or VolumeUnit or AngleUnit or TimeUnit or PowerUnit or CurrentUnit or ConcentrationUnit or TemperatureUnit or SoundIntensityUnit or VoltageUnit or MemoryUnit or UnitlessUnit or MagneticFieldUnit or PressureUnit or {TorqueUnit}	Input unit
`repeats`	`Optional[int]`	Number of repeats (If each input was repeated multiple times, provide the number of repeats)
`output`	`List[float or str]`	Outputs (Calibration output (provide the average if repeated))
`output_unit`	SizeUnit or MassUnit or FrequencyUnit or SpeedUnit or VolumeUnit or AngleUnit or TimeUnit or PowerUnit or CurrentUnit or ConcentrationUnit or TemperatureUnit or SoundIntensityUnit or VoltageUnit or MemoryUnit or UnitlessUnit or MagneticFieldUnit or PressureUnit or {TorqueUnit}	Output unit
`fit`	Optional[CalibrationFit]	Fit (Fit equation for the calibration data used during data acquisition)
`notes`	`Optional[str]`	Notes
`protocol_id`	`Optional[str]`	Protocol ID (DOI for protocols.io)
`device_name`	`str`	Device name (Must match a device defined in the instrument.json)

Fit equation for calibration data

Field	Type	Title (Description)
`fit_type`	FitType	Fit type
`fit_parameters`	`Optional[dict]`	Fit parameters (Parameters of the fit equation, e.g. slope and intercept for linear fit)

Type of fit for calibration data

Generic maintenance class

Field	Type	Title (Description)
`maintenance_date`	`datetime (timezone-aware)`	Date and time of maintenance
`description`	`str`	Description (Description on maintenance procedure)
`reagents`	Optional[List[Reagent]]	Reagents
`notes`	`Optional[str]`	Notes
`protocol_id`	`Optional[str]`	Protocol ID (DOI for protocols.io)
`device_name`	`str`	Device name (Must match a device defined in the instrument.json)

Calibration of a device that outputs power based on input strength

Field	Type	Title (Description)
`input`	`List[float]`	Input (Power, voltage, or percentage input strength)
`input_unit`	`aind_data_schema_models.units.PowerUnit or aind_data_schema_models.units.VoltageUnit`	Input unit
`output`	`List[float]`	Output (Power output (provide the average if repeated))
`output_unit`	PowerUnit	Output unit
`description`	`"Power measured for various power or percentage input strengths"`
`calibration_date`	`datetime (timezone-aware)`	Date and time of calibration
`measured_at`	`Optional[str]`	Measurement location
`repeats`	`Optional[int]`	Number of repeats (If each input was repeated multiple times, provide the number of repeats)
`fit`	Optional[CalibrationFit]	Fit (Fit equation for the calibration data used during data acquisition)
`notes`	`Optional[str]`	Notes
`protocol_id`	`Optional[str]`	Protocol ID (DOI for protocols.io)
`device_name`	`str`	Device name (Must match a device defined in the instrument.json)

Calibration of a liquid delivery device based on solenoid/valve opening times

Field	Type	Title (Description)
`input`	`List[float]`	Input times (Length of time solenoid/valve is open)
`input_unit`	TimeUnit	Input unit
`repeats`	`Optional[int]`	Number of repeats (If each input was repeated multiple times, provide the number of repeats)
`output`	`List[float]`	Output (Volume output (provide the average if repeated))
`output_unit`	VolumeUnit	Output unit
`description`	`"Volume measured for various solenoid opening times"`
`calibration_date`	`datetime (timezone-aware)`	Date and time of calibration
`measured_at`	`Optional[str]`	Measurement location
`fit`	Optional[CalibrationFit]	Fit (Fit equation for the calibration data used during data acquisition)
`notes`	`Optional[str]`	Notes
`protocol_id`	`Optional[str]`	Protocol ID (DOI for protocols.io)
`device_name`	`str`	Device name (Must match a device defined in the instrument.json)