omero.gateway.model

Class ObjectiveData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ObjectiveData

public class ObjectiveData
extends DataObject

Hosts an objective used to capture an image.

Since:

3.0-Beta4

Constructor Summary

Constructors

Constructor and Description
ObjectiveData(omero.model.Objective objective) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
double	getCalibratedMagnification() Returns the objective's calibrated magnification factor.
java.lang.String	getCorrection() Returns the correction value of the objective.
java.lang.String	getImmersion() Returns the immersion value of the objective.
double	getLensNA() Returns the objective's LensNA.
java.lang.String	getLotNumber() Returns the lot number of the detector.
java.lang.String	getManufacturer() Returns the manufacturer of the detector.
java.lang.String	getModel() Returns the model of the objective.
double	getNominalMagnification() Returns the objective's nominal magnification factor.
java.lang.String	getSerialNumber() Returns the serial number of the objective.
omero.model.Length	getWorkingDistance(omero.model.enums.UnitsLength unit) Returns the working distance.
java.lang.Object	hasIris() Returns a boolean flag if the value has been set, null otherwise.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectiveData

public ObjectiveData(omero.model.Objective objective)

Creates a new instance.

Parameters:

objective - The objective. Mustn't be null.

Method Detail

getWorkingDistance

public omero.model.Length getWorkingDistance(omero.model.enums.UnitsLength unit)
                                      throws ome.model.units.BigResult

Returns the working distance.

Parameters:

unit - The unit (may be null, in which case no conversion will be performed)

Returns:

See above.

Throws:

ome.model.units.BigResult - If an arithmetic under-/overflow occurred

getSerialNumber

public java.lang.String getSerialNumber()

Returns the serial number of the objective.

Returns:

See above.

getModel

public java.lang.String getModel()

Returns the model of the objective.

Returns:

See above.

hasIris

public java.lang.Object hasIris()

Returns a boolean flag if the value has been set, null otherwise.

Returns:

See above.

getCorrection

public java.lang.String getCorrection()

Returns the correction value of the objective.

Returns:

See above.

getCalibratedMagnification

public double getCalibratedMagnification()

Returns the objective's calibrated magnification factor.

Returns:

See above.

getNominalMagnification

public double getNominalMagnification()

Returns the objective's nominal magnification factor.

Returns:

See above.

getLensNA

public double getLensNA()

Returns the objective's LensNA.

Returns:

See above.

getImmersion

public java.lang.String getImmersion()

Returns the immersion value of the objective.

Returns:

See above.

getManufacturer

public java.lang.String getManufacturer()

Returns the manufacturer of the detector.

Returns:

See above.

getLotNumber

public java.lang.String getLotNumber()

Returns the lot number of the detector.

Returns:

See above.