public class PrairieMetadata.Sequence extends Object
<Sequence>
.Modifier and Type | Field and Description |
---|---|
private Integer |
cycle
cycle of this <Sequence> . |
private PrairieMetadata.Frame |
firstFrame
The first actual
<Frame> element for this <Sequence> . |
private HashMap<Integer,PrairieMetadata.Frame> |
frames
<Frame> elements beneath this <Sequence> , keyed on each
frame's index . |
private int |
indexMax
Maximum index value.
|
private int |
indexMin
Minimum index value.
|
private PrairieMetadata.ValueTable |
sequenceValues
Table of key/value pairs for this
<Sequence> . |
private boolean |
spectralMode
SpectralMode of this <Sequence> . |
private String |
type
type attribute of this <Sequence> . |
Constructor and Description |
---|
PrairieMetadata.Sequence(Element sequenceElement)
Creates a new sequence by parsing the given
<Sequence> element. |
Modifier and Type | Method and Description |
---|---|
int |
getCycle()
Gets the
cycle associated with this Sequence . |
PrairieMetadata.PFile |
getFile(int index,
int channel)
Gets the
Frame at the given (cycle , index ,
channel ). |
PrairieMetadata.Frame |
getFirstFrame()
Gets the first
Frame of the Sequence . |
PrairieMetadata.Frame |
getFrame(int index)
Gets the
Frame with the given index . |
int |
getIndexCount()
Gets the number of recorded indices at this
Sequence . |
int |
getIndexMax()
Gets the maximum index value.
|
int |
getIndexMin()
Gets the minimum index value.
|
String |
getType()
Gets the
type associated with this Sequence . |
PrairieMetadata.Value |
getValue(String key)
Gets the
value of the given key , beneath this
Sequence , inferring the value from the parent <PVScan>
section as needed. |
PrairieMetadata.ValueTable |
getValues()
Gets the table of
Frame key/value pairs. |
boolean |
isSpectralMode() |
boolean |
isTimeSeries()
Gets whether this
Sequence should be considered a time series. |
void |
parse(Element sequenceElement)
Parses metadata from the given
Sequence element. |
private final HashMap<Integer,PrairieMetadata.Frame> frames
<Frame>
elements beneath this <Sequence>
, keyed on each
frame's index
.private final PrairieMetadata.ValueTable sequenceValues
<Sequence>
.private PrairieMetadata.Frame firstFrame
<Frame>
element for this <Sequence>
.private int indexMin
private int indexMax
private String type
type
attribute of this <Sequence>
.private Integer cycle
cycle
of this <Sequence>
.private boolean spectralMode
SpectralMode
of this <Sequence>
.public PrairieMetadata.Sequence(Element sequenceElement)
<Sequence>
element.public void parse(Element sequenceElement)
Sequence
element.public String getType()
type
associated with this Sequence
.public boolean isTimeSeries()
Sequence
should be considered a time series.public int getCycle()
cycle
associated with this Sequence
.public boolean isSpectralMode()
public int getIndexMin()
index
attribute found, and hence will not necessarily equal 1
(though
in practice it usually does).public int getIndexMax()
index
attribute
found, and hence will not necessarily equal frames#size()
(though
in practice it usually does).public int getIndexCount()
Sequence
. This value
is equal to getIndexMax()
- getIndexMin()
+ 1.public PrairieMetadata.Frame getFirstFrame()
Frame
of the Sequence
.public PrairieMetadata.Frame getFrame(int index)
Frame
with the given index
.public PrairieMetadata.PFile getFile(int index, int channel)
Frame
at the given (cycle
, index
,
channel
).public PrairieMetadata.Value getValue(String key)
value
of the given key
, beneath this
Sequence
, inferring the value from the parent <PVScan>
section as needed.public PrairieMetadata.ValueTable getValues()
Frame
key/value pairs.Copyright © 2016 Open Microscopy Environment