• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXmonitor.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.NXmonitor.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 NXmonitor






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


All Known Implementing Classes:
NXmonitorImpl




public interface NXmonitor
extends NXobject
A monitor of incident beam data.
 It is similar to the :ref:`NXdata` groups containing
 monitor data and its associated dimension scale, e.g. time_of_flight or
 wavelength in pulsed neutron instruments. However, it may also include
 integrals, or scalar monitor counts, which are often used in both in both
 pulsed and steady-state instrumentation.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_COUNT_TIME 


static java.lang.String
NX_DATA 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_EFFICIENCY 


static java.lang.String
NX_END_TIME 


static java.lang.String
NX_INTEGRAL 


static java.lang.String
NX_MODE 


static java.lang.String
NX_NOMINAL 


static java.lang.String
NX_PRESET 


static java.lang.String
NX_RANGE 


static java.lang.String
NX_SAMPLED_FRACTION 


static java.lang.String
NX_START_TIME 


static java.lang.String
NX_TIME_OF_FLIGHT 


static java.lang.String
NX_TYPE 






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


java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 Geometry of the monitor
 



IDataset
getCount_time()
Elapsed actual counting time, can be an array of size ``np``
 when scanning.



java.lang.Double
getCount_timeScalar()
Elapsed actual counting time, can be an array of size ``np``
 when scanning.



IDataset
getData()
Monitor data



java.lang.Number
getDataScalar()
Monitor data



IDataset
getDistance()
Distance of monitor from sample



java.lang.Double
getDistanceScalar()
Distance of monitor from sample



IDataset
getEfficiency()
Monitor efficiency



java.lang.Number
getEfficiencyScalar()
Monitor efficiency



IDataset
getEnd_time()
Ending time of measurement



java.util.Date
getEnd_timeScalar()
Ending time of measurement



NXgeometry
getGeometry()
Geometry of the monitor



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 Geometry of the monitor
 



NXlog
getIntegral_log()
Time variation of monitor counts



IDataset
getIntegral()
Total integral monitor counts



java.lang.Number
getIntegralScalar()
Total integral monitor counts



IDataset
getMode()
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).



java.lang.String
getModeScalar()
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).



IDataset
getNominal()
Nominal reading to be used for normalisation purposes.



java.lang.Number
getNominalScalar()
Nominal reading to be used for normalisation purposes.



IDataset
getPreset()
preset value for time or monitor



java.lang.Number
getPresetScalar()
preset value for time or monitor



IDataset
getRange()
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated



java.lang.Double
getRangeScalar()
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated



IDataset
getSampled_fraction()
Proportion of incident beam sampled by the monitor (0



java.lang.Double
getSampled_fractionScalar()
Proportion of incident beam sampled by the monitor (0



IDataset
getStart_time()
Starting time of measurement



java.util.Date
getStart_timeScalar()
Starting time of measurement



IDataset
getTime_of_flight()
Time-of-flight



java.lang.Double
getTime_of_flightScalar()
Time-of-flight



IDataset
getType()


java.lang.String
getTypeScalar()


void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



DataNode
setCount_time(IDataset count_time)
Elapsed actual counting time, can be an array of size ``np``
 when scanning.



DataNode
setCount_timeScalar(java.lang.Double count_time)
Elapsed actual counting time, can be an array of size ``np``
 when scanning.



DataNode
setData(IDataset data)
Monitor data



DataNode
setDataScalar(java.lang.Number data)
Monitor data



DataNode
setDistance(IDataset distance)
Distance of monitor from sample



DataNode
setDistanceScalar(java.lang.Double distance)
Distance of monitor from sample



DataNode
setEfficiency(IDataset efficiency)
Monitor efficiency



DataNode
setEfficiencyScalar(java.lang.Number efficiency)
Monitor efficiency



DataNode
setEnd_time(IDataset end_time)
Ending time of measurement



DataNode
setEnd_timeScalar(java.util.Date end_time)
Ending time of measurement



void
setGeometry(NXgeometry geometry)
Geometry of the monitor



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 Geometry of the monitor
 



void
setIntegral_log(NXlog integral_log)
Time variation of monitor counts



DataNode
setIntegral(IDataset integral)
Total integral monitor counts



DataNode
setIntegralScalar(java.lang.Number integral)
Total integral monitor counts



DataNode
setMode(IDataset mode)
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).



DataNode
setModeScalar(java.lang.String mode)
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).



DataNode
setNominal(IDataset nominal)
Nominal reading to be used for normalisation purposes.



DataNode
setNominalScalar(java.lang.Number nominal)
Nominal reading to be used for normalisation purposes.



DataNode
setPreset(IDataset preset)
preset value for time or monitor



DataNode
setPresetScalar(java.lang.Number preset)
preset value for time or monitor



DataNode
setRange(IDataset range)
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated



DataNode
setRangeScalar(java.lang.Double range)
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated



DataNode
setSampled_fraction(IDataset sampled_fraction)
Proportion of incident beam sampled by the monitor (0



DataNode
setSampled_fractionScalar(java.lang.Double sampled_fraction)
Proportion of incident beam sampled by the monitor (0



DataNode
setStart_time(IDataset start_time)
Starting time of measurement



DataNode
setStart_timeScalar(java.util.Date start_time)
Starting time of measurement



DataNode
setTime_of_flight(IDataset time_of_flight)
Time-of-flight



DataNode
setTime_of_flightScalar(java.lang.Double time_of_flight)
Time-of-flight



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)






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_MODE
static final java.lang.String NX_MODE

See Also:
Constant Field Values








NX_START_TIME
static final java.lang.String NX_START_TIME

See Also:
Constant Field Values








NX_END_TIME
static final java.lang.String NX_END_TIME

See Also:
Constant Field Values








NX_PRESET
static final java.lang.String NX_PRESET

See Also:
Constant Field Values








NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_RANGE
static final java.lang.String NX_RANGE

See Also:
Constant Field Values








NX_NOMINAL
static final java.lang.String NX_NOMINAL

See Also:
Constant Field Values








NX_INTEGRAL
static final java.lang.String NX_INTEGRAL

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_TIME_OF_FLIGHT
static final java.lang.String NX_TIME_OF_FLIGHT

See Also:
Constant Field Values








NX_EFFICIENCY
static final java.lang.String NX_EFFICIENCY

See Also:
Constant Field Values








NX_DATA
static final java.lang.String NX_DATA

See Also:
Constant Field Values








NX_SAMPLED_FRACTION
static final java.lang.String NX_SAMPLED_FRACTION

See Also:
Constant Field Values








NX_COUNT_TIME
static final java.lang.String NX_COUNT_TIME

See Also:
Constant Field Values










Method Detail





getMode
IDataset getMode()
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Returns:
the value.








setMode
DataNode setMode(IDataset mode)
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Parameters:
mode - the mode








getModeScalar
java.lang.String getModeScalar()
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Returns:
the value.








setModeScalar
DataNode setModeScalar(java.lang.String mode)
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Parameters:
mode - the mode








getStart_time
IDataset getStart_time()
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setStart_time
DataNode setStart_time(IDataset start_time)
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Parameters:
start_time - the start_time








getStart_timeScalar
java.util.Date getStart_timeScalar()
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setStart_timeScalar
DataNode setStart_timeScalar(java.util.Date start_time)
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Parameters:
start_time - the start_time








getEnd_time
IDataset getEnd_time()
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setEnd_time
DataNode setEnd_time(IDataset end_time)
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Parameters:
end_time - the end_time








getEnd_timeScalar
java.util.Date getEnd_timeScalar()
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setEnd_timeScalar
DataNode setEnd_timeScalar(java.util.Date end_time)
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Parameters:
end_time - the end_time








getPreset
IDataset getPreset()
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setPreset
DataNode setPreset(IDataset preset)
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
preset - the preset








getPresetScalar
java.lang.Number getPresetScalar()
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setPresetScalar
DataNode setPresetScalar(java.lang.Number preset)
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
preset - the preset








getDistance
IDataset getDistance()
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getRange
IDataset getRange()
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2;
 

Returns:
the value.








setRange
DataNode setRange(IDataset range)
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2;
 

Parameters:
range - the range








getRangeScalar
java.lang.Double getRangeScalar()
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2;
 

Returns:
the value.








setRangeScalar
DataNode setRangeScalar(java.lang.Double range)
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2;
 

Parameters:
range - the range








getNominal
IDataset getNominal()
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setNominal
DataNode setNominal(IDataset nominal)
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
nominal - the nominal








getNominalScalar
java.lang.Number getNominalScalar()
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setNominalScalar
DataNode setNominalScalar(java.lang.Number nominal)
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
nominal - the nominal








getIntegral
IDataset getIntegral()
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setIntegral
DataNode setIntegral(IDataset integral)
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
integral - the integral








getIntegralScalar
java.lang.Number getIntegralScalar()
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setIntegralScalar
DataNode setIntegralScalar(java.lang.Number integral)
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
integral - the integral








getIntegral_log
NXlog getIntegral_log()
Time variation of monitor counts

Returns:
the value.








setIntegral_log
void setIntegral_log(NXlog integral_log)
Time variation of monitor counts

Parameters:
integral_log - the integral_log








getType
IDataset getType()

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Returns:
the value.








setType
DataNode setType(IDataset type)

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Parameters:
type - the type








getTime_of_flight
IDataset getTime_of_flight()
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Returns:
the value.








setTime_of_flight
DataNode setTime_of_flight(IDataset time_of_flight)
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Parameters:
time_of_flight - the time_of_flight








getTime_of_flightScalar
java.lang.Double getTime_of_flightScalar()
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Returns:
the value.








setTime_of_flightScalar
DataNode setTime_of_flightScalar(java.lang.Double time_of_flight)
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Parameters:
time_of_flight - the time_of_flight








getEfficiency
IDataset getEfficiency()
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Returns:
the value.








setEfficiency
DataNode setEfficiency(IDataset efficiency)
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Parameters:
efficiency - the efficiency








getEfficiencyScalar
java.lang.Number getEfficiencyScalar()
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Returns:
the value.








setEfficiencyScalar
DataNode setEfficiencyScalar(java.lang.Number efficiency)
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Parameters:
efficiency - the efficiency








getData
IDataset getData()
Monitor data
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 0: n;
 

Returns:
the value.








setData
DataNode setData(IDataset data)
Monitor data
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 0: n;
 

Parameters:
data - the data








getDataScalar
java.lang.Number getDataScalar()
Monitor data
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 0: n;
 

Returns:
the value.








setDataScalar
DataNode setDataScalar(java.lang.Number data)
Monitor data
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 0: n;
 

Parameters:
data - the data








getSampled_fraction
IDataset getSampled_fraction()
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Returns:
the value.








setSampled_fraction
DataNode setSampled_fraction(IDataset sampled_fraction)
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Parameters:
sampled_fraction - the sampled_fraction








getSampled_fractionScalar
java.lang.Double getSampled_fractionScalar()
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Returns:
the value.








setSampled_fractionScalar
DataNode setSampled_fractionScalar(java.lang.Double sampled_fraction)
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Parameters:
sampled_fraction - the sampled_fraction








getGeometry
NXgeometry getGeometry()
Geometry of the monitor

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
Geometry of the monitor

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 

 

 Geometry of the monitor
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 Geometry of the monitor
 

Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 Geometry of the monitor
 

Returns:
a map from node names to the NXgeometry for that node.








setAllGeometry
void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
 

 

 Geometry of the monitor
 

Parameters:
geometry - the child nodes to add








getCount_time
IDataset getCount_time()
Elapsed actual counting time, can be an array of size ``np``
 when scanning. This is not the difference of the calendar time
 but the time the instrument was really counting, without
 pauses or times lost due beam unavailability
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setCount_time
DataNode setCount_time(IDataset count_time)
Elapsed actual counting time, can be an array of size ``np``
 when scanning. This is not the difference of the calendar time
 but the time the instrument was really counting, without
 pauses or times lost due beam unavailability
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
count_time - the count_time








getCount_timeScalar
java.lang.Double getCount_timeScalar()
Elapsed actual counting time, can be an array of size ``np``
 when scanning. This is not the difference of the calendar time
 but the time the instrument was really counting, without
 pauses or times lost due beam unavailability
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setCount_timeScalar
DataNode setCount_timeScalar(java.lang.Double count_time)
Elapsed actual counting time, can be an array of size ``np``
 when scanning. This is not the difference of the calendar time
 but the time the instrument was really counting, without
 pauses or times lost due beam unavailability
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
count_time - the count_time














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