Class SimulatedSpectrometer

java.lang.Object

org.episteme.core.device.AbstractDevice

org.episteme.core.device.AbstractSensor<Dimensionless>

org.episteme.core.device.sim.AbstractSimulatedSensor<Dimensionless>

org.episteme.natural.device.sim.SimulatedSpectrometer

All Implemented Interfaces:

Serializable, AutoCloseable, Device, Sensor<Dimensionless>, Commented, ComprehensiveIdentification, Identified<Identification>, Named, Spectrometer

public class SimulatedSpectrometer
extends AbstractSimulatedSensor<Dimensionless>
implements Spectrometer

Simulated spectrometer.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractDevice

AbstractDevice.Record

Nested classes/interfaces inherited from interface Device

Device.Record, Device.Status

Nested classes/interfaces inherited from interface Spectrometer

Spectrometer.SpectroscopyType

Field Summary

Fields inherited from class AbstractSimulatedSensor

support

Fields inherited from class AbstractDevice

accuracy, calibrationHistory, currentValue, displayUnit, firmware, history, identification, lastCalibration, locationDescription, manufacturer, maxRange, minRange, model, precisionDescription, resolution, sensitivity, status

Constructor Summary

Constructors

Constructor	Description
SimulatedSpectrometer(Identification id, Spectrometer.SpectroscopyType type, double minNm, double maxNm, double resNm)

Method Summary

Modifier and Type	Method	Description
void	calibrate(Quantity<Length>[] ref, Quantity<Length>[] measured)
double[][]	captureSpectrum()
Quantity<Time>	getIntegrationTime()
Quantity<Dimensionless>	getIntensityAt(Quantity<Length> wavelength)
Quantity<Length>	getMaxWavelength()
Quantity<Length>	getMinWavelength()
Quantity<Length>	getSpectralResolution()
Spectrometer.SpectroscopyType	getType()
Quantity<Dimensionless>	readValue()	Reads a value from the sensor.
void	setIntegrationTime(Quantity<Time> time)

Methods inherited from class AbstractSimulatedSensor

addCustomReadings, close, connect, disconnect, getCapabilities, getFormattedInfo, getReadings, getStatus, isConnected

Methods inherited from class AbstractSensor

getValue

Methods inherited from class AbstractDevice

calibrate, getAccuracy, getCalibrationHistory, getDeviceStatus, getDisplayUnit, getFirmware, getHistory, getId, getLastCalibration, getLocationDescription, getManufacturer, getMaxRange, getMeasurableQuantities, getMinRange, getModel, getPrecisionDescription, getResolution, getSensitivity, getTrait, getTraitOptional, getTraits, isEnabled, measure, needsCalibration, performCalibration, recordMeasurement, setAccuracy, setCurrentValue, setDisplayUnit, setEnabled, setFirmware, setLastCalibration, setLocationDescription, setManufacturer, setMaxRange, setMinRange, setModel, setPrecisionDescription, setResolution, setSensitivity, setStatus

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AutoCloseable

close

Methods inherited from interface Commented

getComments, getTrait, setComments

Methods inherited from interface ComprehensiveIdentification

getName, getTrait, getTraits, setName, setTrait

Methods inherited from interface Device

calibrate, calibrate, connect, disconnect, getAccuracy, getCalibrationHistory, getCapabilities, getDeviceStatus, getDisplayUnit, getFirmware, getHistory, getId, getLastCalibration, getLocationDescription, getManufacturer, getMaxRange, getMeasurableQuantities, getMinRange, getModel, getPrecisionDescription, getReadings, getResolution, getSensitivity, getStatus, getValue, isConnected, isEnabled, measure, needsCalibration, setDisplayUnit, setEnabled

Constructor Details

SimulatedSpectrometer

public SimulatedSpectrometer(Identification id,
 Spectrometer.SpectroscopyType type,
 double minNm,
 double maxNm,
 double resNm)

Method Details

getType

public Spectrometer.SpectroscopyType getType()

Specified by:

getType in interface Spectrometer

getMinWavelength

public Quantity<Length> getMinWavelength()

Specified by:

getMinWavelength in interface Spectrometer

getMaxWavelength

public Quantity<Length> getMaxWavelength()

Specified by:

getMaxWavelength in interface Spectrometer

getSpectralResolution

public Quantity<Length> getSpectralResolution()

Specified by:

getSpectralResolution in interface Spectrometer

setIntegrationTime

public void setIntegrationTime(Quantity<Time> time)

Specified by:

setIntegrationTime in interface Spectrometer

getIntegrationTime

public Quantity<Time> getIntegrationTime()

Specified by:

getIntegrationTime in interface Spectrometer

captureSpectrum

public double[][] captureSpectrum()

Specified by:

captureSpectrum in interface Spectrometer

getIntensityAt

public Quantity<Dimensionless> getIntensityAt(Quantity<Length> wavelength)

Specified by:

getIntensityAt in interface Spectrometer

calibrate

public void calibrate(Quantity<Length>[] ref,
 Quantity<Length>[] measured)

Specified by:

calibrate in interface Spectrometer

readValue

public Quantity<Dimensionless> readValue()
                                  throws IOException

Description copied from interface: Sensor

Reads a value from the sensor.

Specified by:

readValue in interface Sensor<Dimensionless>

Returns:

the measured value

Throws:

IOException - if the read operation fails