ome.formats.model

Class UnitsFactory

java.lang.Object

ome.formats.model.UnitsFactory

public class UnitsFactory
extends java.lang.Object

Utility class to generate and convert unit objects. Be especially careful when using methods which take a string since there are 2 types of enumerations, CODE-based and SYMBOL-based.

Field Summary

Fields

Modifier and Type	Field and Description
static omero.model.enums.UnitsLength	Channel_EmissionWavelength
static omero.model.enums.UnitsLength	Channel_ExcitationWavelength
static omero.model.enums.UnitsLength	Channel_PinholeSize
static omero.model.enums.UnitsElectricPotential	Detector_Voltage
static omero.model.enums.UnitsFrequency	DetectorSettings_ReadOutRate
static omero.model.enums.UnitsElectricPotential	DetectorSettings_Voltage
static omero.model.enums.UnitsPressure	ImagingEnvironment_AirPressure
static omero.model.enums.UnitsTemperature	ImagingEnvironment_Temperature
static omero.model.enums.UnitsFrequency	Laser_RepetitionRate
static omero.model.enums.UnitsLength	Laser_Wavelength
static omero.model.enums.UnitsPower	LightSource_Power
static omero.model.enums.UnitsLength	LightSourceSettings_Wavelength
static omero.model.enums.UnitsLength	Objective_WorkingDistance
static omero.model.enums.UnitsLength	Pixels_PhysicalSizeX
static omero.model.enums.UnitsLength	Pixels_PhysicalSizeY
static omero.model.enums.UnitsLength	Pixels_PhysicalSizeZ
static omero.model.enums.UnitsTime	Pixels_TimeIncrement
static omero.model.enums.UnitsTime	Plane_DeltaT
static omero.model.enums.UnitsTime	Plane_ExposureTime
static omero.model.enums.UnitsLength	Plane_PositionX
static omero.model.enums.UnitsLength	Plane_PositionY
static omero.model.enums.UnitsLength	Plane_PositionZ
static omero.model.enums.UnitsLength	Plate_WellOriginX
static omero.model.enums.UnitsLength	Plate_WellOriginY
static omero.model.enums.UnitsLength	Shape_FontSize
static omero.model.enums.UnitsLength	Shape_StrokeWidth
static omero.model.enums.UnitsLength	StageLabel_X
static omero.model.enums.UnitsLength	StageLabel_Y
static omero.model.enums.UnitsLength	StageLabel_Z
static omero.model.enums.UnitsLength	TransmittanceRange_CutIn
static omero.model.enums.UnitsLength	TransmittanceRange_CutInTolerance
static omero.model.enums.UnitsLength	TransmittanceRange_CutOut
static omero.model.enums.UnitsLength	TransmittanceRange_CutOutTolerance
static omero.model.enums.UnitsLength	WellSample_PositionX
static omero.model.enums.UnitsLength	WellSample_PositionY

Constructor Summary

Constructors

Constructor and Description
UnitsFactory()

Method Summary

Modifier and Type	Method and Description
static omero.model.ElectricPotential	convertElectricPotential(ome.units.quantity.ElectricPotential value) Convert a Bio-Formats ElectricPotential to an OMERO ElectricPotential.
static ome.units.quantity.ElectricPotential	convertElectricPotential(omero.model.ElectricPotential t)
static omero.model.ElectricPotential	convertElectricPotential(omero.model.ElectricPotential value, ome.units.unit.Unit<ome.units.quantity.ElectricPotential> ul)
static omero.model.ElectricPotential	convertElectricPotentialXML(omero.model.ElectricPotential value, java.lang.String xml)
static omero.model.Frequency	convertFrequency(ome.units.quantity.Frequency value) Convert a Bio-Formats Frequency to an OMERO Frequency.
static ome.units.quantity.Frequency	convertFrequency(omero.model.Frequency t)
static omero.model.Frequency	convertFrequency(omero.model.Frequency value, ome.units.unit.Unit<ome.units.quantity.Frequency> ul)
static omero.model.Frequency	convertFrequencyXML(omero.model.Frequency value, java.lang.String xml)
static omero.model.Length	convertLength(ome.units.quantity.Length value) Convert a Bio-Formats Length to an OMERO Length.
static ome.units.quantity.Length	convertLength(omero.model.Length t)
static omero.model.Length	convertLength(omero.model.Length value, ome.units.unit.Unit<ome.units.quantity.Length> ul)
static omero.model.Length	convertLengthXML(omero.model.Length value, java.lang.String xml)
static omero.model.Power	convertPower(ome.units.quantity.Power value) Convert a Bio-Formats Power to an OMERO Power.
static ome.units.quantity.Power	convertPower(omero.model.Power t)
static omero.model.Power	convertPower(omero.model.Power value, ome.units.unit.Unit<ome.units.quantity.Power> ul)
static omero.model.Power	convertPowerXML(omero.model.Power value, java.lang.String xml)
static omero.model.Pressure	convertPressure(ome.units.quantity.Pressure value) Convert a Bio-Formats Pressure to an OMERO Pressure.
static ome.units.quantity.Pressure	convertPressure(omero.model.Pressure t)
static omero.model.Pressure	convertPressure(omero.model.Pressure value, ome.units.unit.Unit<ome.units.quantity.Pressure> ul)
static omero.model.Pressure	convertPressureXML(omero.model.Pressure value, java.lang.String xml)
static omero.model.Temperature	convertTemperature(ome.units.quantity.Temperature value) Convert a Bio-Formats Temperature to an OMERO Temperature.
static ome.units.quantity.Temperature	convertTemperature(omero.model.Temperature t)
static omero.model.Temperature	convertTemperature(omero.model.Temperature value, ome.units.unit.Unit<ome.units.quantity.Temperature> ul)
static omero.model.Temperature	convertTemperatureXML(omero.model.Temperature value, java.lang.String xml)
static omero.model.Time	convertTime(ome.units.quantity.Time value) Convert a Bio-Formats Time to an OMERO Time.
static ome.units.quantity.Time	convertTime(omero.model.Time t)
static omero.model.Time	convertTime(omero.model.Time value, ome.units.unit.Unit<ome.units.quantity.Time> ul)
static omero.model.Time	convertTimeXML(omero.model.Time value, java.lang.String xml)
static omero.model.ElectricPotential	makeElectricPotential(double d, ome.units.unit.Unit<ome.units.quantity.ElectricPotential> unit)
static omero.model.ElectricPotential	makeElectricPotential(double d, omero.model.enums.UnitsElectricPotential unit)
static ome.xml.model.enums.UnitsElectricPotential	makeElectricPotentialUnitXML(java.lang.String unit)
static ome.units.quantity.ElectricPotential	makeElectricPotentialXML(double d, java.lang.String unit)
static omero.model.Frequency	makeFrequency(double d, ome.units.unit.Unit<ome.units.quantity.Frequency> unit)
static omero.model.Frequency	makeFrequency(double d, omero.model.enums.UnitsFrequency unit)
static ome.xml.model.enums.UnitsFrequency	makeFrequencyUnitXML(java.lang.String unit)
static ome.units.quantity.Frequency	makeFrequencyXML(double d, java.lang.String unit)
static omero.model.Length	makeLength(double d, ome.units.unit.Unit<ome.units.quantity.Length> unit)
static omero.model.Length	makeLength(double d, omero.model.enums.UnitsLength unit)
static ome.xml.model.enums.UnitsLength	makeLengthUnitXML(java.lang.String unit)
static ome.units.quantity.Length	makeLengthXML(double d, java.lang.String unit)
static omero.model.Power	makePower(double d, ome.units.unit.Unit<ome.units.quantity.Power> unit)
static omero.model.Power	makePower(double d, omero.model.enums.UnitsPower unit)
static ome.xml.model.enums.UnitsPower	makePowerUnitXML(java.lang.String unit)
static ome.units.quantity.Power	makePowerXML(double d, java.lang.String unit)
static omero.model.Pressure	makePressure(double d, ome.units.unit.Unit<ome.units.quantity.Pressure> unit)
static omero.model.Pressure	makePressure(double d, omero.model.enums.UnitsPressure unit)
static ome.xml.model.enums.UnitsPressure	makePressureUnitXML(java.lang.String unit)
static ome.units.quantity.Pressure	makePressureXML(double d, java.lang.String unit)
static omero.model.Temperature	makeTemperature(double d, ome.units.unit.Unit<ome.units.quantity.Temperature> unit)
static omero.model.Temperature	makeTemperature(double d, omero.model.enums.UnitsTemperature unit)
static ome.xml.model.enums.UnitsTemperature	makeTemperatureUnitXML(java.lang.String unit)
static ome.units.quantity.Temperature	makeTemperatureXML(double d, java.lang.String unit)
static omero.model.Time	makeTime(double d, ome.units.unit.Unit<ome.units.quantity.Time> unit)
static omero.model.Time	makeTime(double d, omero.model.enums.UnitsTime unit)
static ome.xml.model.enums.UnitsTime	makeTimeUnitXML(java.lang.String unit)
static ome.units.quantity.Time	makeTimeXML(double d, java.lang.String unit)
static java.lang.String	xmlElectricPotentialEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlElectricPotentialEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.ElectricPotential> xml)
static java.lang.String	xmlFrequencyEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlFrequencyEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Frequency> xml)
static java.lang.String	xmlLengthEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlLengthEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Length> xml)
static java.lang.String	xmlPowerEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlPowerEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Power> xml)
static java.lang.String	xmlPressureEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlPressureEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Pressure> xml)
static java.lang.String	xmlTemperatureEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlTemperatureEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Temperature> xml)
static java.lang.String	xmlTimeEnumToOMERO(java.lang.String xml)
static java.lang.String	xmlTimeEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Time> xml)

Methods inherited from class java.lang.Object

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

Field Detail

Plane_PositionX

public static omero.model.enums.UnitsLength Plane_PositionX

Plane_PositionZ

public static omero.model.enums.UnitsLength Plane_PositionZ

Plane_PositionY

public static omero.model.enums.UnitsLength Plane_PositionY

Plane_DeltaT

public static omero.model.enums.UnitsTime Plane_DeltaT

Plane_ExposureTime

public static omero.model.enums.UnitsTime Plane_ExposureTime

Shape_StrokeWidth

public static omero.model.enums.UnitsLength Shape_StrokeWidth

Shape_FontSize

public static omero.model.enums.UnitsLength Shape_FontSize

DetectorSettings_Voltage

public static omero.model.enums.UnitsElectricPotential DetectorSettings_Voltage

DetectorSettings_ReadOutRate

public static omero.model.enums.UnitsFrequency DetectorSettings_ReadOutRate

ImagingEnvironment_Temperature

public static omero.model.enums.UnitsTemperature ImagingEnvironment_Temperature

ImagingEnvironment_AirPressure

public static omero.model.enums.UnitsPressure ImagingEnvironment_AirPressure

LightSourceSettings_Wavelength

public static omero.model.enums.UnitsLength LightSourceSettings_Wavelength

Plate_WellOriginX

public static omero.model.enums.UnitsLength Plate_WellOriginX

Plate_WellOriginY

public static omero.model.enums.UnitsLength Plate_WellOriginY

Objective_WorkingDistance

public static omero.model.enums.UnitsLength Objective_WorkingDistance

Pixels_PhysicalSizeX

public static omero.model.enums.UnitsLength Pixels_PhysicalSizeX

Pixels_PhysicalSizeZ

public static omero.model.enums.UnitsLength Pixels_PhysicalSizeZ

Pixels_PhysicalSizeY

public static omero.model.enums.UnitsLength Pixels_PhysicalSizeY

Pixels_TimeIncrement

public static omero.model.enums.UnitsTime Pixels_TimeIncrement

StageLabel_Z

public static omero.model.enums.UnitsLength StageLabel_Z

StageLabel_Y

public static omero.model.enums.UnitsLength StageLabel_Y

StageLabel_X

public static omero.model.enums.UnitsLength StageLabel_X

LightSource_Power

public static omero.model.enums.UnitsPower LightSource_Power

Detector_Voltage

public static omero.model.enums.UnitsElectricPotential Detector_Voltage

WellSample_PositionX

public static omero.model.enums.UnitsLength WellSample_PositionX

WellSample_PositionY

public static omero.model.enums.UnitsLength WellSample_PositionY

Channel_EmissionWavelength

public static omero.model.enums.UnitsLength Channel_EmissionWavelength

Channel_PinholeSize

public static omero.model.enums.UnitsLength Channel_PinholeSize

Channel_ExcitationWavelength

public static omero.model.enums.UnitsLength Channel_ExcitationWavelength

TransmittanceRange_CutOutTolerance

public static omero.model.enums.UnitsLength TransmittanceRange_CutOutTolerance

TransmittanceRange_CutInTolerance

public static omero.model.enums.UnitsLength TransmittanceRange_CutInTolerance

TransmittanceRange_CutOut

public static omero.model.enums.UnitsLength TransmittanceRange_CutOut

TransmittanceRange_CutIn

public static omero.model.enums.UnitsLength TransmittanceRange_CutIn

Laser_RepetitionRate

public static omero.model.enums.UnitsFrequency Laser_RepetitionRate

Laser_Wavelength

public static omero.model.enums.UnitsLength Laser_Wavelength

Constructor Detail

UnitsFactory

public UnitsFactory()

Method Detail

makeElectricPotentialUnitXML

public static ome.xml.model.enums.UnitsElectricPotential makeElectricPotentialUnitXML(java.lang.String unit)

makeElectricPotentialXML

public static ome.units.quantity.ElectricPotential makeElectricPotentialXML(double d,
                                                                            java.lang.String unit)

makeElectricPotential

public static omero.model.ElectricPotential makeElectricPotential(double d,
                                                                  ome.units.unit.Unit<ome.units.quantity.ElectricPotential> unit)

makeElectricPotential

public static omero.model.ElectricPotential makeElectricPotential(double d,
                                                                  omero.model.enums.UnitsElectricPotential unit)

convertElectricPotential

public static omero.model.ElectricPotential convertElectricPotential(ome.units.quantity.ElectricPotential value)

Convert a Bio-Formats ElectricPotential to an OMERO ElectricPotential. A null will be returned if the input is null.

convertElectricPotential

public static ome.units.quantity.ElectricPotential convertElectricPotential(omero.model.ElectricPotential t)

convertElectricPotential

public static omero.model.ElectricPotential convertElectricPotential(omero.model.ElectricPotential value,
                                                                     ome.units.unit.Unit<ome.units.quantity.ElectricPotential> ul)
                                                              throws BigResult

Throws:

BigResult

convertElectricPotentialXML

public static omero.model.ElectricPotential convertElectricPotentialXML(omero.model.ElectricPotential value,
                                                                        java.lang.String xml)
                                                                 throws BigResult

Throws:

BigResult

xmlElectricPotentialEnumToOMERO

public static java.lang.String xmlElectricPotentialEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.ElectricPotential> xml)

xmlElectricPotentialEnumToOMERO

public static java.lang.String xmlElectricPotentialEnumToOMERO(java.lang.String xml)

makeFrequencyUnitXML

public static ome.xml.model.enums.UnitsFrequency makeFrequencyUnitXML(java.lang.String unit)

makeFrequencyXML

public static ome.units.quantity.Frequency makeFrequencyXML(double d,
                                                            java.lang.String unit)

makeFrequency

public static omero.model.Frequency makeFrequency(double d,
                                                  ome.units.unit.Unit<ome.units.quantity.Frequency> unit)

makeFrequency

public static omero.model.Frequency makeFrequency(double d,
                                                  omero.model.enums.UnitsFrequency unit)

convertFrequency

public static omero.model.Frequency convertFrequency(ome.units.quantity.Frequency value)

Convert a Bio-Formats Frequency to an OMERO Frequency. A null will be returned if the input is null.

convertFrequency

public static ome.units.quantity.Frequency convertFrequency(omero.model.Frequency t)

convertFrequency

public static omero.model.Frequency convertFrequency(omero.model.Frequency value,
                                                     ome.units.unit.Unit<ome.units.quantity.Frequency> ul)
                                              throws BigResult

Throws:

BigResult

convertFrequencyXML

public static omero.model.Frequency convertFrequencyXML(omero.model.Frequency value,
                                                        java.lang.String xml)
                                                 throws BigResult

Throws:

BigResult

xmlFrequencyEnumToOMERO

public static java.lang.String xmlFrequencyEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Frequency> xml)

xmlFrequencyEnumToOMERO

public static java.lang.String xmlFrequencyEnumToOMERO(java.lang.String xml)

makeLengthUnitXML

public static ome.xml.model.enums.UnitsLength makeLengthUnitXML(java.lang.String unit)

makeLengthXML

public static ome.units.quantity.Length makeLengthXML(double d,
                                                      java.lang.String unit)

makeLength

public static omero.model.Length makeLength(double d,
                                            ome.units.unit.Unit<ome.units.quantity.Length> unit)

makeLength

public static omero.model.Length makeLength(double d,
                                            omero.model.enums.UnitsLength unit)

convertLength

public static omero.model.Length convertLength(ome.units.quantity.Length value)

Convert a Bio-Formats Length to an OMERO Length. A null will be returned if the input is null.

convertLength

public static ome.units.quantity.Length convertLength(omero.model.Length t)

convertLength

public static omero.model.Length convertLength(omero.model.Length value,
                                               ome.units.unit.Unit<ome.units.quantity.Length> ul)
                                        throws BigResult

Throws:

BigResult

convertLengthXML

public static omero.model.Length convertLengthXML(omero.model.Length value,
                                                  java.lang.String xml)
                                           throws BigResult

Throws:

BigResult

xmlLengthEnumToOMERO

public static java.lang.String xmlLengthEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Length> xml)

xmlLengthEnumToOMERO

public static java.lang.String xmlLengthEnumToOMERO(java.lang.String xml)

makePowerUnitXML

public static ome.xml.model.enums.UnitsPower makePowerUnitXML(java.lang.String unit)

makePowerXML

public static ome.units.quantity.Power makePowerXML(double d,
                                                    java.lang.String unit)

makePower

public static omero.model.Power makePower(double d,
                                          ome.units.unit.Unit<ome.units.quantity.Power> unit)

makePower

public static omero.model.Power makePower(double d,
                                          omero.model.enums.UnitsPower unit)

convertPower

public static omero.model.Power convertPower(ome.units.quantity.Power value)

Convert a Bio-Formats Power to an OMERO Power. A null will be returned if the input is null.

convertPower

public static ome.units.quantity.Power convertPower(omero.model.Power t)

convertPower

public static omero.model.Power convertPower(omero.model.Power value,
                                             ome.units.unit.Unit<ome.units.quantity.Power> ul)
                                      throws BigResult

Throws:

BigResult

convertPowerXML

public static omero.model.Power convertPowerXML(omero.model.Power value,
                                                java.lang.String xml)
                                         throws BigResult

Throws:

BigResult

xmlPowerEnumToOMERO

public static java.lang.String xmlPowerEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Power> xml)

xmlPowerEnumToOMERO

public static java.lang.String xmlPowerEnumToOMERO(java.lang.String xml)

makePressureUnitXML

public static ome.xml.model.enums.UnitsPressure makePressureUnitXML(java.lang.String unit)

makePressureXML

public static ome.units.quantity.Pressure makePressureXML(double d,
                                                          java.lang.String unit)

makePressure

public static omero.model.Pressure makePressure(double d,
                                                ome.units.unit.Unit<ome.units.quantity.Pressure> unit)

makePressure

public static omero.model.Pressure makePressure(double d,
                                                omero.model.enums.UnitsPressure unit)

convertPressure

public static omero.model.Pressure convertPressure(ome.units.quantity.Pressure value)

Convert a Bio-Formats Pressure to an OMERO Pressure. A null will be returned if the input is null.

convertPressure

public static ome.units.quantity.Pressure convertPressure(omero.model.Pressure t)

convertPressure

public static omero.model.Pressure convertPressure(omero.model.Pressure value,
                                                   ome.units.unit.Unit<ome.units.quantity.Pressure> ul)
                                            throws BigResult

Throws:

BigResult

convertPressureXML

public static omero.model.Pressure convertPressureXML(omero.model.Pressure value,
                                                      java.lang.String xml)
                                               throws BigResult

Throws:

BigResult

xmlPressureEnumToOMERO

public static java.lang.String xmlPressureEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Pressure> xml)

xmlPressureEnumToOMERO

public static java.lang.String xmlPressureEnumToOMERO(java.lang.String xml)

makeTemperatureUnitXML

public static ome.xml.model.enums.UnitsTemperature makeTemperatureUnitXML(java.lang.String unit)

makeTemperatureXML

public static ome.units.quantity.Temperature makeTemperatureXML(double d,
                                                                java.lang.String unit)

makeTemperature

public static omero.model.Temperature makeTemperature(double d,
                                                      ome.units.unit.Unit<ome.units.quantity.Temperature> unit)

makeTemperature

public static omero.model.Temperature makeTemperature(double d,
                                                      omero.model.enums.UnitsTemperature unit)

convertTemperature

public static omero.model.Temperature convertTemperature(ome.units.quantity.Temperature value)

Convert a Bio-Formats Temperature to an OMERO Temperature. A null will be returned if the input is null.

convertTemperature

public static ome.units.quantity.Temperature convertTemperature(omero.model.Temperature t)

convertTemperature

public static omero.model.Temperature convertTemperature(omero.model.Temperature value,
                                                         ome.units.unit.Unit<ome.units.quantity.Temperature> ul)
                                                  throws BigResult

Throws:

BigResult

convertTemperatureXML

public static omero.model.Temperature convertTemperatureXML(omero.model.Temperature value,
                                                            java.lang.String xml)
                                                     throws BigResult

Throws:

BigResult

xmlTemperatureEnumToOMERO

public static java.lang.String xmlTemperatureEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Temperature> xml)

xmlTemperatureEnumToOMERO

public static java.lang.String xmlTemperatureEnumToOMERO(java.lang.String xml)

makeTimeUnitXML

public static ome.xml.model.enums.UnitsTime makeTimeUnitXML(java.lang.String unit)

makeTimeXML

public static ome.units.quantity.Time makeTimeXML(double d,
                                                  java.lang.String unit)

makeTime

public static omero.model.Time makeTime(double d,
                                        ome.units.unit.Unit<ome.units.quantity.Time> unit)

makeTime

public static omero.model.Time makeTime(double d,
                                        omero.model.enums.UnitsTime unit)

convertTime

public static omero.model.Time convertTime(ome.units.quantity.Time value)

Convert a Bio-Formats Time to an OMERO Time. A null will be returned if the input is null.

convertTime

public static ome.units.quantity.Time convertTime(omero.model.Time t)

convertTime

public static omero.model.Time convertTime(omero.model.Time value,
                                           ome.units.unit.Unit<ome.units.quantity.Time> ul)
                                    throws BigResult

Throws:

BigResult

convertTimeXML

public static omero.model.Time convertTimeXML(omero.model.Time value,
                                              java.lang.String xml)
                                       throws BigResult

Throws:

BigResult

xmlTimeEnumToOMERO

public static java.lang.String xmlTimeEnumToOMERO(ome.units.unit.Unit<ome.units.quantity.Time> xml)

xmlTimeEnumToOMERO

public static java.lang.String xmlTimeEnumToOMERO(java.lang.String xml)