loci.formats
Interface MetadataRetrieve

All Known Implementing Classes:
DummyMetadata

public interface MetadataRetrieve

TODO - MetadataRetrieve javadoc.

Source code:
Trac, SVN


Method Summary
 Float getAirPressure(Integer n)
          Gets the air pressure associated with the given image.
 Float getArcPower(Integer arc)
          Gets the power (in watts) of the given arc.
 String getArcType(Integer arc)
          Gets the type of the given arc.
 Boolean getBigEndian(Integer image)
          Gets the BigEndian attribute of the given pixels in the given image.
 Double getBlackLevel(Integer pixels, Integer channel)
          Gets the black level of the given channel in the given set of pixels.
 int getChannelCount(Integer n)
          Returns the number of channels for the given pixels element.
 String getChannelName(Integer pixels, Integer channel)
          Gets the name of the given channel in the given set of pixels.
 Float getChannelNDFilter(Integer pixels, Integer channel)
          Gets the ND filter value for the given channel in the given set of pixels.
 Float getCO2Percent(Integer n)
          Gets the CO2 percentage associated with the given image.
 String getColorMap(Integer image)
          Gets the color map associated with the given pixels.
 Object getContact(Integer n)
          Get the contact of the nth group.
 String getCreationDate(Integer n)
          Gets the nth image's creation date.
 String getDataDirectory(Integer n)
          Gets the data directory of the nth experimenter.
 String getDescription(Integer n)
          Gets the nth image's description.
 Float getDetectorGain(Integer detector)
          Gets the gain value of the given detector.
 String getDetectorManufacturer(Integer detector)
          Gets the manufacturer of the given detector.
 String getDetectorModel(Integer detector)
          Gets the model of the given detector.
 Float getDetectorOffset(Integer detector)
          Gets the offset of the given detector.
 String getDetectorSerial(Integer detector)
          Gets the serial number of the given detector.
 String getDetectorType(Integer detector)
          Gets the type of the given detector.
 Float getDetectorVoltage(Integer detector)
          Gets the voltage of the given detector.
 String getDichroicLotNumber(Integer dichroic)
          Gets the lot number of the given dichroic.
 String getDichroicManufacturer(Integer dichroic)
          Gets the manufacturer of the given dichroic.
 String getDichroicModel(Integer dichroic)
          Gets the model of the given dichroic.
 String getDimensionOrder(Integer image)
          Gets the DimensionOrder attribute of the given pixels in the given image.
 Object getDisplayOptions(Integer n)
          Get the display options of the nth ROI.
 int getDisplayROICount()
          Returns the number of DisplayROIs.
 String getEmail(Integer n)
          Gets the email address of the nth experimenter.
 String getEmissionLotNumber(Integer filter)
          Gets the lot number of the given emission filter.
 String getEmissionManufacturer(Integer filter)
          Gets the manufacturer of the given emission filter.
 String getEmissionModel(Integer filter)
          Gets the model of the given emission filter.
 String getEmissionType(Integer filter)
          Gets the type of the given emission filter.
 Integer getEmWave(Integer pixels, Integer channel)
          Gets the emission wavelength of the given channel in the given set of pixels.
 String getExcitationLotNumber(Integer filter)
          Gets the lot number of the given excitation filter.
 String getExcitationManufacturer(Integer filter)
          Gets the manufacturer of the given excitation filter.
 String getExcitationModel(Integer filter)
          Gets the model of the given excitation filter.
 String getExcitationType(Integer filter)
          Gets the type of the given excitation filter.
 int getExperimenterCount()
          Returns the number of experimenters.
 Float getExposureTime(Integer pixels, Integer z, Integer c, Integer t)
          Gets the exposure time of the plane with the given Z, C and T coordinates in the given set of pixels.
 Integer getExWave(Integer pixels, Integer channel)
          Gets the excitation wavelength of the given channel in the given set of pixels.
 Float getFilamentPower(Integer filament)
          Gets the power (in watts) of the given filament.
 String getFilamentType(Integer filament)
          Gets the type of the given filament.
 String getFilterSetLotNumber(Integer filterSet)
          Gets the manufacturer of the given filter set.
 String getFilterSetManufacturer(Integer filterSet)
          Gets the manufacturer of the given filter set.
 String getFilterSetModel(Integer filterSet)
          Gets the manufacturer of the given filter set.
 String getFirstName(Integer n)
          Gets the first name of the nth experimenter.
 Float getGamma(Integer pixels, Integer channel)
          Gets the gamma value of the given channel in the given set of pixels.
 Double getGlobalMax(Integer pixels, Integer channel)
          Gets the maximum pixel value within the given channel in the given set of pixels.
 Double getGlobalMin(Integer pixels, Integer channel)
          Gets the minimum pixel value within the given channel in the given set of pixels.
 Object getGroup(Integer n)
          Gets the group of the nth experimenter.
 int getGroupCount()
          Returns the number of groups.
 String getGroupName(Integer n)
          Get the name of the nth group.
 Float getHumidity(Integer n)
          Gets the humidity associated with the given image.
 int getImageCount()
          Returns the number of images.
 String getImageName(Integer n)
          Gets the nth image's name.
 String getInstitution(Integer n)
          Gets the institution of the nth experimenter.
 int getInstrumentCount()
          Returns the number of instruments.
 String getLaserMedium(Integer laser)
          Gets the medium of the given laser.
 String getLaserType(Integer laser)
          Gets the type of the given laser.
 Integer getLaserWavelength(Integer laser)
          Gets the wavelength of the given laser.
 String getLastName(Integer n)
          Gets the last name of the nth experimenter.
 Object getLeader(Integer n)
          Get the leader of the nth group.
 Float getLensNA(Integer objective)
          Gets the lens NA of the given objective.
 String getLightManufacturer(Integer light)
          Gets the manufacturer of the given light source.
 String getLightModel(Integer light)
          Gets the model of the given light source.
 String getLightSerial(Integer light)
          Gets the serial number of the given light source.
 String getManufacturer(Integer n)
          Get the manufacturer of the nth instrument.
 String getMode(Integer pixels, Integer channel)
          Gets the mode of the given channel in the given set of pixels.
 String getModel(Integer n)
          Get the model of the nth instrument.
 Float getObjectiveMagnification(Integer objective)
          Gets the magnification value of the given objective.
 String getObjectiveManufacturer(Integer objective)
          Gets the manufacturer of the given objective.
 String getObjectiveModel(Integer objective)
          Gets the model of the given objective.
 String getObjectiveSerial(Integer objective)
          Gets the serial number of the given objective.
 Boolean getOTFOpticalAxisAverage(Integer otf)
          Gets whether or not optical axis averaging is used for the given OTF.
 String getOTFPath(Integer otf)
          Gets the path to the given OTF.
 String getOTFPixelType(Integer otf)
          Gets the pixel type of the given OTF.
 Integer getOTFSizeX(Integer otf)
          Gets the width of the given OTF.
 Integer getOTFSizeY(Integer otf)
          Gets the height of the given OTF.
 String getPhotometricInterpretation(Integer pixels, Integer channel)
          Gets the photometric interpretation of the given channel in the given set of pixels.
 int getPixelsCount(Integer n)
          Returns the number of pixels elements for the given image.
 Float getPixelSizeC(Integer n)
          Gets the nth image's PixelSizeC attribute.
 Float getPixelSizeT(Integer n)
          Gets the nth image's PixelSizeT attribute.
 Float getPixelSizeX(Integer n)
          Gets the nth image's PixelSizeX attribute.
 Float getPixelSizeY(Integer n)
          Gets the nth image's PixelSizeY attribute.
 Float getPixelSizeZ(Integer n)
          Gets the nth image's PixelSizeZ attribute.
 String getPixelType(Integer image)
          Gets the PixelType attribute of the given pixels in the given image.
 Float getPower(Integer laser)
          Gets the power (in watts) of the given laser.
 String getPulse(Integer laser)
          Gets the pulse of the given laser.
 String getSerialNumber(Integer n)
          Get the serial number of the nth instrument.
 Integer getSizeC(Integer image)
          Gets the SizeC attribute of the given pixels in the given image.
 Integer getSizeT(Integer image)
          Gets the SizeT attribute of the given pixels in the given image.
 Integer getSizeX(Integer image)
          Gets the SizeX attribute of the given pixels in the given image.
 Integer getSizeY(Integer image)
          Gets the SizeY attribute of the given pixels in the given image.
 Integer getSizeZ(Integer image)
          Gets the SizeZ attribute of the given pixels in the given image.
 int getStageLabelCount()
          Returns the number of stage labels.
 String getStageName(Integer n)
          Gets the name of the nth stage label.
 Float getStageX(Integer n)
          Gets the X coordinate of the nth stage label.
 Float getStageY(Integer n)
          Gets the Y coordinate of the nth stage label.
 Float getStageZ(Integer n)
          Gets the Z coordinate of the nth stage label.
 Integer getT0(Integer n)
          Get the lower T bound of the nth ROI.
 Integer getT1(Integer n)
          Get the upper T bound of the nth ROI.
 Float getTemperature(Integer n)
          Gets the temperature associated with the given image.
 Float getTimestamp(Integer pixels, Integer z, Integer c, Integer t)
          Gets the timestamp of the plane with the given Z, C and T coordinates in the given set of pixels.
 Integer getTStart(Integer image)
          Gets the minimum T coordinate for which the display settings apply.
 Integer getTStop(Integer image)
          Gets the maximum T coordinate for which the display settings apply.
 String getType(Integer n)
          Get the type of the nth instrument.
 Double getWhiteLevel(Integer pixels, Integer channel)
          Gets the white level of the given channel in the given set of pixels.
 Integer getX0(Integer n)
          Get the lower X bound of the nth ROI.
 Integer getX1(Integer n)
          Get the upper X bound of the nth ROI.
 Integer getY0(Integer n)
          Get the lower Y bound of the nth ROI.
 Integer getY1(Integer n)
          Get the upper Y bound of the nth ROI.
 Integer getZ0(Integer n)
          Get the lower Z bound of the nth ROI.
 Integer getZ1(Integer n)
          Get the upper Z bound of the nth ROI.
 Float getZoom(Integer image)
          Gets the zoom value associated with the given pixels in the given image.
 Integer getZStart(Integer image)
          Gets the minimum Z coordinate for which the display settings apply.
 Integer getZStop(Integer image)
          Gets the maximum Z coordinate for which the display settings apply.
 Boolean isBlueChannelOn(Integer image)
          Gets whether or not the blue channel is activated.
 Boolean isDisplayRGB(Integer image)
          Gets whether or not the given pixels are displayed as an RGB image.
 Boolean isFrequencyDoubled(Integer laser)
          Gets whether or not the frequency is doubled for the given laser.
 Boolean isGreenChannelOn(Integer image)
          Gets whether or not the green channel is activated.
 Boolean isRedChannelOn(Integer image)
          Gets whether or not the red channel is activated.
 Boolean isTunable(Integer laser)
          Gets whether or not the given laser is tunable.
 

Method Detail

getImageCount

int getImageCount()
Returns the number of images.


getImageName

String getImageName(Integer n)
Gets the nth image's name.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getCreationDate

String getCreationDate(Integer n)
Gets the nth image's creation date.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getDescription

String getDescription(Integer n)
Gets the nth image's description.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getExperimenterCount

int getExperimenterCount()
Returns the number of experimenters.


getFirstName

String getFirstName(Integer n)
Gets the first name of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getLastName

String getLastName(Integer n)
Gets the last name of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getEmail

String getEmail(Integer n)
Gets the email address of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getInstitution

String getInstitution(Integer n)
Gets the institution of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getDataDirectory

String getDataDirectory(Integer n)
Gets the data directory of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getGroup

Object getGroup(Integer n)
Gets the group of the nth experimenter.

Parameters:
n - the index of the experimenter. If null the default index of 0 will be used.

getGroupCount

int getGroupCount()
Returns the number of groups.


getGroupName

String getGroupName(Integer n)
Get the name of the nth group.

Parameters:
n - the index of the group. If null the default index of 0 will be used.

getLeader

Object getLeader(Integer n)
Get the leader of the nth group.

Parameters:
n - the index of the group. If null the default index of 0 will be used.

getContact

Object getContact(Integer n)
Get the contact of the nth group.

Parameters:
n - the index of the group. If null the default index of 0 will be used.

getInstrumentCount

int getInstrumentCount()
Returns the number of instruments.


getManufacturer

String getManufacturer(Integer n)
Get the manufacturer of the nth instrument.

Parameters:
n - the index of the instrument. If null the default index of 0 will be used.

getModel

String getModel(Integer n)
Get the model of the nth instrument.

Parameters:
n - the index of the instrument. If null the default index of 0 will be used.

getSerialNumber

String getSerialNumber(Integer n)
Get the serial number of the nth instrument.

Parameters:
n - the index of the instrument. If null the default index of 0 will be used.

getType

String getType(Integer n)
Get the type of the nth instrument.

Parameters:
n - the index of the instrument. If null the default index of 0 will be used.

getPixelSizeX

Float getPixelSizeX(Integer n)
Gets the nth image's PixelSizeX attribute.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getPixelSizeY

Float getPixelSizeY(Integer n)
Gets the nth image's PixelSizeY attribute.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getPixelSizeZ

Float getPixelSizeZ(Integer n)
Gets the nth image's PixelSizeZ attribute.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getPixelSizeC

Float getPixelSizeC(Integer n)
Gets the nth image's PixelSizeC attribute.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getPixelSizeT

Float getPixelSizeT(Integer n)
Gets the nth image's PixelSizeT attribute.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getDisplayROICount

int getDisplayROICount()
Returns the number of DisplayROIs.


getX0

Integer getX0(Integer n)
Get the lower X bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getY0

Integer getY0(Integer n)
Get the lower Y bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getZ0

Integer getZ0(Integer n)
Get the lower Z bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getT0

Integer getT0(Integer n)
Get the lower T bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getX1

Integer getX1(Integer n)
Get the upper X bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getY1

Integer getY1(Integer n)
Get the upper Y bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getZ1

Integer getZ1(Integer n)
Get the upper Z bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getT1

Integer getT1(Integer n)
Get the upper T bound of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getDisplayOptions

Object getDisplayOptions(Integer n)
Get the display options of the nth ROI.

Parameters:
n - the index of the ROI. If null the default index of 0 will be used.

getPixelsCount

int getPixelsCount(Integer n)
Returns the number of pixels elements for the given image.


getSizeX

Integer getSizeX(Integer image)
Gets the SizeX attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getSizeY

Integer getSizeY(Integer image)
Gets the SizeY attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getSizeZ

Integer getSizeZ(Integer image)
Gets the SizeZ attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getSizeC

Integer getSizeC(Integer image)
Gets the SizeC attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getSizeT

Integer getSizeT(Integer image)
Gets the SizeT attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getPixelType

String getPixelType(Integer image)
Gets the PixelType attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getBigEndian

Boolean getBigEndian(Integer image)
Gets the BigEndian attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getDimensionOrder

String getDimensionOrder(Integer image)
Gets the DimensionOrder attribute of the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getStageLabelCount

int getStageLabelCount()
Returns the number of stage labels.


getStageName

String getStageName(Integer n)
Gets the name of the nth stage label.

Parameters:
n - the index of the stage label. If null the default index of 0 will be used.

getStageX

Float getStageX(Integer n)
Gets the X coordinate of the nth stage label.

Parameters:
n - the index of the stage label. If null the default index of 0 will be used.

getStageY

Float getStageY(Integer n)
Gets the Y coordinate of the nth stage label.

Parameters:
n - the index of the stage label. If null the default index of 0 will be used.

getStageZ

Float getStageZ(Integer n)
Gets the Z coordinate of the nth stage label.

Parameters:
n - the index of the stage label. If null the default index of 0 will be used.

getChannelCount

int getChannelCount(Integer n)
Returns the number of channels for the given pixels element.


getChannelName

String getChannelName(Integer pixels,
                      Integer channel)
Gets the name of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getChannelNDFilter

Float getChannelNDFilter(Integer pixels,
                         Integer channel)
Gets the ND filter value for the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getEmWave

Integer getEmWave(Integer pixels,
                  Integer channel)
Gets the emission wavelength of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getExWave

Integer getExWave(Integer pixels,
                  Integer channel)
Gets the excitation wavelength of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getPhotometricInterpretation

String getPhotometricInterpretation(Integer pixels,
                                    Integer channel)
Gets the photometric interpretation of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getMode

String getMode(Integer pixels,
               Integer channel)
Gets the mode of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getGlobalMin

Double getGlobalMin(Integer pixels,
                    Integer channel)
Gets the minimum pixel value within the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getGlobalMax

Double getGlobalMax(Integer pixels,
                    Integer channel)
Gets the maximum pixel value within the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getTimestamp

Float getTimestamp(Integer pixels,
                   Integer z,
                   Integer c,
                   Integer t)
Gets the timestamp of the plane with the given Z, C and T coordinates in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
z - the Z coordinate of the plane. If null the default index of 0 will be used.
c - the C coordinate of the plane. If null the default index of 0 will be used.
t - the T coordinate of the plane. If null the default index of 0 will be used.

getExposureTime

Float getExposureTime(Integer pixels,
                      Integer z,
                      Integer c,
                      Integer t)
Gets the exposure time of the plane with the given Z, C and T coordinates in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
z - the Z coordinate of the plane. If null the default index of 0 will be used.
c - the C coordinate of the plane. If null the default index of 0 will be used.
t - the T coordinate of the plane. If null the default index of 0 will be used.

getTemperature

Float getTemperature(Integer n)
Gets the temperature associated with the given image.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getAirPressure

Float getAirPressure(Integer n)
Gets the air pressure associated with the given image.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getHumidity

Float getHumidity(Integer n)
Gets the humidity associated with the given image.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getCO2Percent

Float getCO2Percent(Integer n)
Gets the CO2 percentage associated with the given image.

Parameters:
n - the index of the image. If null the default index of 0 will be used.

getBlackLevel

Double getBlackLevel(Integer pixels,
                     Integer channel)
Gets the black level of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getWhiteLevel

Double getWhiteLevel(Integer pixels,
                     Integer channel)
Gets the white level of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getGamma

Float getGamma(Integer pixels,
               Integer channel)
Gets the gamma value of the given channel in the given set of pixels.

Parameters:
pixels - the index of the pixels. If null the default index of 0 will be used.
channel - the index of the channel. If null the default index of 0 will be used.

getZoom

Float getZoom(Integer image)
Gets the zoom value associated with the given pixels in the given image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

isRedChannelOn

Boolean isRedChannelOn(Integer image)
Gets whether or not the red channel is activated.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

isGreenChannelOn

Boolean isGreenChannelOn(Integer image)
Gets whether or not the green channel is activated.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

isBlueChannelOn

Boolean isBlueChannelOn(Integer image)
Gets whether or not the blue channel is activated.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

isDisplayRGB

Boolean isDisplayRGB(Integer image)
Gets whether or not the given pixels are displayed as an RGB image.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getColorMap

String getColorMap(Integer image)
Gets the color map associated with the given pixels.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getZStart

Integer getZStart(Integer image)
Gets the minimum Z coordinate for which the display settings apply.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getZStop

Integer getZStop(Integer image)
Gets the maximum Z coordinate for which the display settings apply.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getTStart

Integer getTStart(Integer image)
Gets the minimum T coordinate for which the display settings apply.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getTStop

Integer getTStop(Integer image)
Gets the maximum T coordinate for which the display settings apply.

Parameters:
image - the index of the image. If null the default index of 0 will be used.

getLightManufacturer

String getLightManufacturer(Integer light)
Gets the manufacturer of the given light source.

Parameters:
light - the index of the light. If null the default index of 0 will be used.

getLightModel

String getLightModel(Integer light)
Gets the model of the given light source.

Parameters:
light - the index of the light. If null the default index of 0 will be used.

getLightSerial

String getLightSerial(Integer light)
Gets the serial number of the given light source.

Parameters:
light - the index of the light. If null the default index of 0 will be used.

getLaserType

String getLaserType(Integer laser)
Gets the type of the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

getLaserMedium

String getLaserMedium(Integer laser)
Gets the medium of the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

getLaserWavelength

Integer getLaserWavelength(Integer laser)
Gets the wavelength of the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

isFrequencyDoubled

Boolean isFrequencyDoubled(Integer laser)
Gets whether or not the frequency is doubled for the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

isTunable

Boolean isTunable(Integer laser)
Gets whether or not the given laser is tunable.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

getPulse

String getPulse(Integer laser)
Gets the pulse of the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

getPower

Float getPower(Integer laser)
Gets the power (in watts) of the given laser.

Parameters:
laser - the index of the laser. If null the default index of 0 will be used.

getFilamentType

String getFilamentType(Integer filament)
Gets the type of the given filament.

Parameters:
filament - the index of the filament. If null the default index of 0 will be used.

getFilamentPower

Float getFilamentPower(Integer filament)
Gets the power (in watts) of the given filament.

Parameters:
filament - the index of the filament. If null the default index of 0 will be used.

getArcType

String getArcType(Integer arc)
Gets the type of the given arc.

Parameters:
arc - the index of the arc. If null the default index of 0 will be used.

getArcPower

Float getArcPower(Integer arc)
Gets the power (in watts) of the given arc.

Parameters:
arc - the index of the arc. If null the default index of 0 will be used.

getDetectorManufacturer

String getDetectorManufacturer(Integer detector)
Gets the manufacturer of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorModel

String getDetectorModel(Integer detector)
Gets the model of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorSerial

String getDetectorSerial(Integer detector)
Gets the serial number of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorType

String getDetectorType(Integer detector)
Gets the type of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorGain

Float getDetectorGain(Integer detector)
Gets the gain value of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorVoltage

Float getDetectorVoltage(Integer detector)
Gets the voltage of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getDetectorOffset

Float getDetectorOffset(Integer detector)
Gets the offset of the given detector.

Parameters:
detector - the index of the detector. If null the default index of 0 will be used.

getObjectiveManufacturer

String getObjectiveManufacturer(Integer objective)
Gets the manufacturer of the given objective.

Parameters:
objective - the index of the objective. If null the default index of 0 will be used.

getObjectiveModel

String getObjectiveModel(Integer objective)
Gets the model of the given objective.

Parameters:
objective - the index of the objective. If null the default index of 0 will be used.

getObjectiveSerial

String getObjectiveSerial(Integer objective)
Gets the serial number of the given objective.

Parameters:
objective - the index of the objective. If null the default index of 0 will be used.

getLensNA

Float getLensNA(Integer objective)
Gets the lens NA of the given objective.

Parameters:
objective - the index of the objective. If null the default index of 0 will be used.

getObjectiveMagnification

Float getObjectiveMagnification(Integer objective)
Gets the magnification value of the given objective.

Parameters:
objective - the index of the objective. If null the default index of 0 will be used.

getExcitationManufacturer

String getExcitationManufacturer(Integer filter)
Gets the manufacturer of the given excitation filter.

Parameters:
filter - the index of the filter. If null the default index of 0 will be used.

getExcitationModel

String getExcitationModel(Integer filter)
Gets the model of the given excitation filter.

Parameters:
filter - the index of the filter. If null the default index of 0 will be used.

getExcitationLotNumber

String getExcitationLotNumber(Integer filter)
Gets the lot number of the given excitation filter.

Parameters:
filter - the index of the filter. If null the default index of 0 will be used.

getExcitationType

String getExcitationType(Integer filter)
Gets the type of the given excitation filter.

Parameters:
filter - the index of the filter. If null the default index of 0 will be used.

getDichroicManufacturer

String getDichroicManufacturer(Integer dichroic)
Gets the manufacturer of the given dichroic.

Parameters:
dichroic - the index of the dichroic. If null the default index of 0 will be used.

getDichroicModel

String getDichroicModel(Integer dichroic)
Gets the model of the given dichroic.

Parameters:
dichroic - the index of the dichroic. If null the default index of 0 will be used.

getDichroicLotNumber

String getDichroicLotNumber(Integer dichroic)
Gets the lot number of the given dichroic.

Parameters:
dichroic - the index of the dichroic. If null the default index of 0 will be used.

getEmissionManufacturer

String getEmissionManufacturer(Integer filter)
Gets the manufacturer of the given emission filter.

Parameters:
filter - the index of the emission filter. If null the default index of 0 will be used.

getEmissionModel

String getEmissionModel(Integer filter)
Gets the model of the given emission filter.

Parameters:
filter - the index of the emission filter. If null the default index of 0 will be used.

getEmissionLotNumber

String getEmissionLotNumber(Integer filter)
Gets the lot number of the given emission filter.

Parameters:
filter - the index of the emission filter. If null the default index of 0 will be used.

getEmissionType

String getEmissionType(Integer filter)
Gets the type of the given emission filter.

Parameters:
filter - the index of the emission filter. If null the default index of 0 will be used.

getFilterSetManufacturer

String getFilterSetManufacturer(Integer filterSet)
Gets the manufacturer of the given filter set.

Parameters:
filterSet - the index of the filter set. If null the default index of 0 will be used.

getFilterSetModel

String getFilterSetModel(Integer filterSet)
Gets the manufacturer of the given filter set.

Parameters:
filterSet - the index of the filter set. If null the default index of 0 will be used.

getFilterSetLotNumber

String getFilterSetLotNumber(Integer filterSet)
Gets the manufacturer of the given filter set.

Parameters:
filterSet - the index of the filter set. If null the default index of 0 will be used.

getOTFSizeX

Integer getOTFSizeX(Integer otf)
Gets the width of the given OTF.

Parameters:
otf - the index of the OTF. If null the default index of 0 will be used.

getOTFSizeY

Integer getOTFSizeY(Integer otf)
Gets the height of the given OTF.

Parameters:
otf - the index of the OTF. If null the default index of 0 will be used.

getOTFPixelType

String getOTFPixelType(Integer otf)
Gets the pixel type of the given OTF.

Parameters:
otf - the index of the OTF. If null the default index of 0 will be used.

getOTFPath

String getOTFPath(Integer otf)
Gets the path to the given OTF.

Parameters:
otf - the index of the OTF. If null the default index of 0 will be used.

getOTFOpticalAxisAverage

Boolean getOTFOpticalAxisAverage(Integer otf)
Gets whether or not optical axis averaging is used for the given OTF.

Parameters:
otf - the index of the OTF. If null the default index of 0 will be used.