• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXevent_data.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXevent_data.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus
Interface NXevent_data






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXevent_dataImpl




public interface NXevent_data
extends NXobject
NXevent_data is a special group for storing data from neutron
 detectors in event mode. In this mode, the detector electronics
 emits a stream of detectorID, timestamp pairs. With detectorID
 describing the detector element in which the neutron was detected
 and timestamp the timestamp at which the neutron event was
 detected. In NeXus detectorID maps to event_id, event_time_offset
 to the timestamp.
 As this kind of data is common at pulsed neutron
 sources, the timestamp is almost always relative to the start of a
 neutron pulse. Thus the pulse timestamp is recorded too together
 with an index in the event_id, event_time_offset pair at which data for
 that pulse starts. At reactor source the same pulsed data effect
 may be achieved through the use of choppers or in stroboscopic
 measurement setups.
 In order to make random access to timestamped data
 faster there is an optional array pair of
 cue_timestamp_zero and cue_index. The cue_timestamp_zero will
 contain courser timestamps then in the time array, say
 every five minutes. The cue_index will then contain the
 index into the event_id,event_time_offset pair of arrays for that
 courser cue_timestamp_zero.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_CUE_INDEX 


static java.lang.String
NX_CUE_TIMESTAMP_ZERO 


static java.lang.String
NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START 


static java.lang.String
NX_EVENT_ID 


static java.lang.String
NX_EVENT_INDEX 


static java.lang.String
NX_EVENT_TIME_OFFSET 


static java.lang.String
NX_EVENT_TIME_ZERO 


static java.lang.String
NX_EVENT_TIME_ZERO_ATTRIBUTE_OFFSET 


static java.lang.String
NX_PULSE_HEIGHT 






Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


IDataset
getCue_index()
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.



java.lang.Long
getCue_indexScalar()
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.



IDataset
getCue_timestamp_zero()
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.



java.util.Date
getCue_timestamp_zeroAttributeStart() 


java.util.Date
getCue_timestamp_zeroScalar()
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.



IDataset
getEvent_id()
There will be extra information in the NXdetector to convert
 event_id to detector_number.



java.lang.Long
getEvent_idScalar()
There will be extra information in the NXdetector to convert
 event_id to detector_number.



IDataset
getEvent_index()
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.



java.lang.Long
getEvent_indexScalar()
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.



IDataset
getEvent_time_offset()
A list of timestamps for each event as it comes in.



java.lang.Number
getEvent_time_offsetScalar()
A list of timestamps for each event as it comes in.



IDataset
getEvent_time_zero()
The time that each pulse started with respect to the offset



java.util.Date
getEvent_time_zeroAttributeOffset()
ISO8601



java.lang.Number
getEvent_time_zeroScalar()
The time that each pulse started with respect to the offset



IDataset
getPulse_height()
If voltages from the ends of the detector are read out this
 is where they go.



java.lang.Double
getPulse_heightScalar()
If voltages from the ends of the detector are read out this
 is where they go.



DataNode
setCue_index(IDataset cue_index)
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.



DataNode
setCue_indexScalar(java.lang.Long cue_index)
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.



DataNode
setCue_timestamp_zero(IDataset cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.



void
setCue_timestamp_zeroAttributeStart(java.util.Date start) 


DataNode
setCue_timestamp_zeroScalar(java.util.Date cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.



DataNode
setEvent_id(IDataset event_id)
There will be extra information in the NXdetector to convert
 event_id to detector_number.



DataNode
setEvent_idScalar(java.lang.Long event_id)
There will be extra information in the NXdetector to convert
 event_id to detector_number.



DataNode
setEvent_index(IDataset event_index)
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.



DataNode
setEvent_indexScalar(java.lang.Long event_index)
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.



DataNode
setEvent_time_offset(IDataset event_time_offset)
A list of timestamps for each event as it comes in.



DataNode
setEvent_time_offsetScalar(java.lang.Number event_time_offset)
A list of timestamps for each event as it comes in.



DataNode
setEvent_time_zero(IDataset event_time_zero)
The time that each pulse started with respect to the offset



void
setEvent_time_zeroAttributeOffset(java.util.Date offset)
ISO8601



DataNode
setEvent_time_zeroScalar(java.lang.Number event_time_zero)
The time that each pulse started with respect to the offset



DataNode
setPulse_height(IDataset pulse_height)
If voltages from the ends of the detector are read out this
 is where they go.



DataNode
setPulse_heightScalar(java.lang.Double pulse_height)
If voltages from the ends of the detector are read out this
 is where they go.







Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





NX_EVENT_TIME_OFFSET
static final java.lang.String NX_EVENT_TIME_OFFSET

See Also:
Constant Field Values








NX_EVENT_ID
static final java.lang.String NX_EVENT_ID

See Also:
Constant Field Values








NX_EVENT_TIME_ZERO
static final java.lang.String NX_EVENT_TIME_ZERO

See Also:
Constant Field Values








NX_EVENT_TIME_ZERO_ATTRIBUTE_OFFSET
static final java.lang.String NX_EVENT_TIME_ZERO_ATTRIBUTE_OFFSET

See Also:
Constant Field Values








NX_EVENT_INDEX
static final java.lang.String NX_EVENT_INDEX

See Also:
Constant Field Values








NX_PULSE_HEIGHT
static final java.lang.String NX_PULSE_HEIGHT

See Also:
Constant Field Values








NX_CUE_TIMESTAMP_ZERO
static final java.lang.String NX_CUE_TIMESTAMP_ZERO

See Also:
Constant Field Values








NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START
static final java.lang.String NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START

See Also:
Constant Field Values








NX_CUE_INDEX
static final java.lang.String NX_CUE_INDEX

See Also:
Constant Field Values










Method Detail





getEvent_time_offset
IDataset getEvent_time_offset()
A list of timestamps for each event as it comes in.
 

 Type: NX_NUMBER
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: i;
 

Returns:
the value.








setEvent_time_offset
DataNode setEvent_time_offset(IDataset event_time_offset)
A list of timestamps for each event as it comes in.
 

 Type: NX_NUMBER
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: i;
 

Parameters:
event_time_offset - the event_time_offset








getEvent_time_offsetScalar
java.lang.Number getEvent_time_offsetScalar()
A list of timestamps for each event as it comes in.
 

 Type: NX_NUMBER
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: i;
 

Returns:
the value.








setEvent_time_offsetScalar
DataNode setEvent_time_offsetScalar(java.lang.Number event_time_offset)
A list of timestamps for each event as it comes in.
 

 Type: NX_NUMBER
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: i;
 

Parameters:
event_time_offset - the event_time_offset








getEvent_id
IDataset getEvent_id()
There will be extra information in the NXdetector to convert
 event_id to detector_number.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i;
 

Returns:
the value.








setEvent_id
DataNode setEvent_id(IDataset event_id)
There will be extra information in the NXdetector to convert
 event_id to detector_number.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i;
 

Parameters:
event_id - the event_id








getEvent_idScalar
java.lang.Long getEvent_idScalar()
There will be extra information in the NXdetector to convert
 event_id to detector_number.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i;
 

Returns:
the value.








setEvent_idScalar
DataNode setEvent_idScalar(java.lang.Long event_id)
There will be extra information in the NXdetector to convert
 event_id to detector_number.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i;
 

Parameters:
event_id - the event_id








getEvent_time_zero
IDataset getEvent_time_zero()
The time that each pulse started with respect to the offset
 

 Type: NX_NUMBER
 Units: NX_TIME
 Dimensions: 1: j;
 

Returns:
the value.








setEvent_time_zero
DataNode setEvent_time_zero(IDataset event_time_zero)
The time that each pulse started with respect to the offset
 

 Type: NX_NUMBER
 Units: NX_TIME
 Dimensions: 1: j;
 

Parameters:
event_time_zero - the event_time_zero








getEvent_time_zeroScalar
java.lang.Number getEvent_time_zeroScalar()
The time that each pulse started with respect to the offset
 

 Type: NX_NUMBER
 Units: NX_TIME
 Dimensions: 1: j;
 

Returns:
the value.








setEvent_time_zeroScalar
DataNode setEvent_time_zeroScalar(java.lang.Number event_time_zero)
The time that each pulse started with respect to the offset
 

 Type: NX_NUMBER
 Units: NX_TIME
 Dimensions: 1: j;
 

Parameters:
event_time_zero - the event_time_zero








getEvent_time_zeroAttributeOffset
java.util.Date getEvent_time_zeroAttributeOffset()
ISO8601

Returns:
the value.








setEvent_time_zeroAttributeOffset
void setEvent_time_zeroAttributeOffset(java.util.Date offset)
ISO8601

Parameters:
offset - the offset








getEvent_index
IDataset getEvent_index()
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: j;
 

Returns:
the value.








setEvent_index
DataNode setEvent_index(IDataset event_index)
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: j;
 

Parameters:
event_index - the event_index








getEvent_indexScalar
java.lang.Long getEvent_indexScalar()
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: j;
 

Returns:
the value.








setEvent_indexScalar
DataNode setEvent_indexScalar(java.lang.Long event_index)
The index into the event_time_offset, event_id pair for
 the pulse occurring at the matching entry in event_time_zero.
 

 Type: NX_INT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: j;
 

Parameters:
event_index - the event_index








getPulse_height
IDataset getPulse_height()
If voltages from the ends of the detector are read out this
 is where they go. This list is for all events with information
 to attach to a particular pulse height. The information to
 attach to a particular pulse is located in events_per_pulse.
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i; 2: k;
 

Returns:
the value.








setPulse_height
DataNode setPulse_height(IDataset pulse_height)
If voltages from the ends of the detector are read out this
 is where they go. This list is for all events with information
 to attach to a particular pulse height. The information to
 attach to a particular pulse is located in events_per_pulse.
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i; 2: k;
 

Parameters:
pulse_height - the pulse_height








getPulse_heightScalar
java.lang.Double getPulse_heightScalar()
If voltages from the ends of the detector are read out this
 is where they go. This list is for all events with information
 to attach to a particular pulse height. The information to
 attach to a particular pulse is located in events_per_pulse.
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i; 2: k;
 

Returns:
the value.








setPulse_heightScalar
DataNode setPulse_heightScalar(java.lang.Double pulse_height)
If voltages from the ends of the detector are read out this
 is where they go. This list is for all events with information
 to attach to a particular pulse height. The information to
 attach to a particular pulse is located in events_per_pulse.
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 Dimensions: 1: i; 2: k;
 

Parameters:
pulse_height - the pulse_height








getCue_timestamp_zero
IDataset getCue_timestamp_zero()
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.
 

 Type: NX_DATE_TIME
 Units: NX_TIME
 

Returns:
the value.








setCue_timestamp_zero
DataNode setCue_timestamp_zero(IDataset cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.
 

 Type: NX_DATE_TIME
 Units: NX_TIME
 

Parameters:
cue_timestamp_zero - the cue_timestamp_zero








getCue_timestamp_zeroScalar
java.util.Date getCue_timestamp_zeroScalar()
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.
 

 Type: NX_DATE_TIME
 Units: NX_TIME
 

Returns:
the value.








setCue_timestamp_zeroScalar
DataNode setCue_timestamp_zeroScalar(java.util.Date cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 event_id, event_time_offset pair.
 

 Type: NX_DATE_TIME
 Units: NX_TIME
 

Parameters:
cue_timestamp_zero - the cue_timestamp_zero








getCue_timestamp_zeroAttributeStart
java.util.Date getCue_timestamp_zeroAttributeStart()

Returns:
the value.








setCue_timestamp_zeroAttributeStart
void setCue_timestamp_zeroAttributeStart(java.util.Date start)

Parameters:
start - the start








getCue_index
IDataset getCue_index()
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Returns:
the value.








setCue_index
DataNode setCue_index(IDataset cue_index)
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Parameters:
cue_index - the cue_index








getCue_indexScalar
java.lang.Long getCue_indexScalar()
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Returns:
the value.








setCue_indexScalar
DataNode setCue_indexScalar(java.lang.Long cue_index)
Index into the event_id, event_time_offset pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Parameters:
cue_index - the cue_index














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method