public class PrairieMetadata.Frame extends Object
<Frame>
, beneath a <Sequence>
.Modifier and Type | Field and Description |
---|---|
private Double |
absoluteTime
absoluteTime attribute of this <Frame> . |
private HashMap<Integer,PrairieMetadata.PFile> |
files
<File> elements beneath this <Frame> , keyed on each
file's channel . |
private PrairieMetadata.PFile |
firstFile
The first actual
<File> element for this <Frame> . |
private PrairieMetadata.ValueTable |
frameValues
Table of key/value pairs for this
<Frame> . |
private Integer |
index
index of this <Frame> . |
private Double |
relativeTime
relativeTime attribute of this <Frame> . |
private PrairieMetadata.Sequence |
sequence
The
<Sequence> containing this <Frame> . |
Constructor and Description |
---|
PrairieMetadata.Frame(PrairieMetadata.Sequence sequence,
Element frameElement)
Creates a new frame by parsing the given
<Frame> element. |
Modifier and Type | Method and Description |
---|---|
double |
getAbsoluteTime()
Gets the
absoluteTime associated with this Frame . |
PrairieMetadata.PFile |
getFile(int channel)
Gets the
File with the given channel . |
PrairieMetadata.PFile |
getFirstFile()
Gets the first
File of the Sequence . |
Double |
getGain(int c)
Gets the
c th gain for this Frame . |
String |
getImagingDevice()
Gets the imaging device associated with this
Frame . |
String |
getImmersion()
Extracts the immersion from the objective lens string.
|
int |
getIndex()
Gets the
index associated with this Frame . |
Integer |
getLinesPerFrame()
Gets the lines per frame for this
Frame . |
Double |
getMagnification()
Extracts the magnification from the objective lens string.
|
Double |
getMicronsPerPixelX()
Gets the microns per pixel along X for this
Frame . |
Double |
getMicronsPerPixelY()
Gets the microns per pixel along Y for this
Frame . |
String |
getObjectiveLens()
Gets the objective lens string for this
Frame . |
Double |
getObjectiveLensNA()
Gets the numerical aperture of the lens for this
Frame . |
String |
getObjectiveManufacturer()
Extracts the objective manufacturer from the objective lens string.
|
Double |
getOffset(int c)
Gets the
c th offset for this Frame . |
Double |
getOpticalZoom()
Gets the optical zoom associated with this
Frame . |
Integer |
getPixelsPerLine()
Gets the pixels per line for this
Frame . |
Length |
getPositionX()
Gets the X stage position associated with this
Frame . |
Length |
getPositionY()
Gets the Y stage position associated with this
Frame . |
Length |
getPositionZ()
Gets the Z stage position associated with this
Frame . |
double |
getRelativeTime()
Gets the
relativeTime associated with this Frame . |
PrairieMetadata.Sequence |
getSequence()
Gets the
<Sequence> containing this <Frame> . |
PrairieMetadata.Value |
getValue(String key)
Gets the
value of the given key , beneath this
Frame , inferring the value from the parent <Sequence>
or grandparent <PVScan> section as needed. |
PrairieMetadata.ValueTable |
getValues()
Gets the table of
Frame key/value pairs. |
void |
parse(Element frameElement)
Parses metadata from the given
Frame element. |
private Length |
toLength(Double position,
boolean isInvert)
Convert a position number to a length in the microscope reference frame.
|
private PrairieMetadata.Sequence sequence
<Sequence>
containing this <Frame>
.private final HashMap<Integer,PrairieMetadata.PFile> files
<File>
elements beneath this <Frame>
, keyed on each
file's channel
.private final PrairieMetadata.ValueTable frameValues
<Frame>
.private PrairieMetadata.PFile firstFile
<File>
element for this <Frame>
.private Double relativeTime
relativeTime
attribute of this <Frame>
.private Double absoluteTime
absoluteTime
attribute of this <Frame>
.private Integer index
index
of this <Frame>
.public PrairieMetadata.Frame(PrairieMetadata.Sequence sequence, Element frameElement)
<Frame>
element.public PrairieMetadata.Sequence getSequence()
<Sequence>
containing this <Frame>
.public void parse(Element frameElement)
Frame
element.public double getRelativeTime()
relativeTime
associated with this Frame
.public double getAbsoluteTime()
absoluteTime
associated with this Frame
.public int getIndex()
index
associated with this Frame
.public PrairieMetadata.PFile getFirstFile()
File
of the Sequence
.public PrairieMetadata.PFile getFile(int channel)
File
with the given channel
.public String getObjectiveLens()
Frame
.public String getObjectiveManufacturer()
public Double getMagnification()
public String getImmersion()
public Double getObjectiveLensNA()
Frame
.public Integer getPixelsPerLine()
Frame
.public Integer getLinesPerFrame()
Frame
.private Length toLength(Double position, boolean isInvert)
position
- a position number, may be null
isInvert
- if the number's sign should be flippednull
public Length getPositionX()
Frame
.public Length getPositionY()
Frame
.public Length getPositionZ()
Frame
.public Double getOpticalZoom()
Frame
.public Double getMicronsPerPixelX()
Frame
.public Double getMicronsPerPixelY()
Frame
.public Double getOffset(int c)
c
th offset for this Frame
.c
- The 0-based(!) channel index for which to obtain the offset.public Double getGain(int c)
c
th gain for this Frame
.c
- The 0-based(!) channel index for which to obtain the gain.public String getImagingDevice()
Frame
.public PrairieMetadata.Value getValue(String key)
value
of the given key
, beneath this
Frame
, inferring the value from the parent <Sequence>
or grandparent <PVScan>
section as needed.public PrairieMetadata.ValueTable getValues()
Frame
key/value pairs.Copyright © 2016 Open Microscopy Environment