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



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXmonitorImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXmonitor, NXobject




public class NXmonitorImpl
extends NXobjectImpl
implements NXmonitor
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.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXmonitor
NX_COUNT_TIME, NX_DATA, NX_DISTANCE, NX_EFFICIENCY, NX_END_TIME, NX_INTEGRAL, NX_MODE, NX_NOMINAL, NX_PRESET, NX_RANGE, NX_SAMPLED_FRACTION, NX_START_TIME, NX_TIME_OF_FLIGHT, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXmonitorImpl() 


NXmonitorImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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).



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



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



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



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





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





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXmonitorImpl
public NXmonitorImpl()







NXmonitorImpl
public NXmonitorImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getMode
public IDataset getMode()
Description copied from interface: NXmonitor
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Specified by:
getMode in interface NXmonitor
Returns:
the value.








getModeScalar
public java.lang.String getModeScalar()
Description copied from interface: NXmonitor
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Specified by:
getModeScalar in interface NXmonitor
Returns:
the value.








setMode
public DataNode setMode(IDataset mode)
Description copied from interface: NXmonitor
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Specified by:
setMode in interface NXmonitor
Parameters:
mode - the mode








setModeScalar
public DataNode setModeScalar(java.lang.String mode)
Description copied from interface: NXmonitor
Count to a preset value based on either clock time (timer)
 or received monitor counts (monitor).
 

 
Enumeration:

 
monitor 
 
timer 

 


Specified by:
setModeScalar in interface NXmonitor
Parameters:
mode - the mode








getStart_time
public IDataset getStart_time()
Description copied from interface: NXmonitor
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getStart_time in interface NXmonitor
Returns:
the value.








getStart_timeScalar
public java.util.Date getStart_timeScalar()
Description copied from interface: NXmonitor
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getStart_timeScalar in interface NXmonitor
Returns:
the value.








setStart_time
public DataNode setStart_time(IDataset start_time)
Description copied from interface: NXmonitor
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setStart_time in interface NXmonitor
Parameters:
start_time - the start_time








setStart_timeScalar
public DataNode setStart_timeScalar(java.util.Date start_time)
Description copied from interface: NXmonitor
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setStart_timeScalar in interface NXmonitor
Parameters:
start_time - the start_time








getEnd_time
public IDataset getEnd_time()
Description copied from interface: NXmonitor
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getEnd_time in interface NXmonitor
Returns:
the value.








getEnd_timeScalar
public java.util.Date getEnd_timeScalar()
Description copied from interface: NXmonitor
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getEnd_timeScalar in interface NXmonitor
Returns:
the value.








setEnd_time
public DataNode setEnd_time(IDataset end_time)
Description copied from interface: NXmonitor
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setEnd_time in interface NXmonitor
Parameters:
end_time - the end_time








setEnd_timeScalar
public DataNode setEnd_timeScalar(java.util.Date end_time)
Description copied from interface: NXmonitor
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setEnd_timeScalar in interface NXmonitor
Parameters:
end_time - the end_time








getPreset
public IDataset getPreset()
Description copied from interface: NXmonitor
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getPreset in interface NXmonitor
Returns:
the value.








getPresetScalar
public java.lang.Number getPresetScalar()
Description copied from interface: NXmonitor
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getPresetScalar in interface NXmonitor
Returns:
the value.








setPreset
public DataNode setPreset(IDataset preset)
Description copied from interface: NXmonitor
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setPreset in interface NXmonitor
Parameters:
preset - the preset








setPresetScalar
public DataNode setPresetScalar(java.lang.Number preset)
Description copied from interface: NXmonitor
preset value for time or monitor
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setPresetScalar in interface NXmonitor
Parameters:
preset - the preset








getDistance
public IDataset getDistance()
Description copied from interface: NXmonitor
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance in interface NXmonitor
Returns:
the value.








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXmonitor
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistanceScalar in interface NXmonitor
Returns:
the value.








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXmonitor
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance in interface NXmonitor
Parameters:
distance - the distance








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXmonitor
Distance of monitor from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistanceScalar in interface NXmonitor
Parameters:
distance - the distance








getRange
public IDataset getRange()
Description copied from interface: NXmonitor
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

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

Specified by:
getRange in interface NXmonitor
Returns:
the value.








getRangeScalar
public java.lang.Double getRangeScalar()
Description copied from interface: NXmonitor
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

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

Specified by:
getRangeScalar in interface NXmonitor
Returns:
the value.








setRange
public DataNode setRange(IDataset range)
Description copied from interface: NXmonitor
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

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

Specified by:
setRange in interface NXmonitor
Parameters:
range - the range








setRangeScalar
public DataNode setRangeScalar(java.lang.Double range)
Description copied from interface: NXmonitor
Range (X-axis, Time-of-flight, etc.) over which the integral was calculated
 

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

Specified by:
setRangeScalar in interface NXmonitor
Parameters:
range - the range








getNominal
public IDataset getNominal()
Description copied from interface: NXmonitor
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getNominal in interface NXmonitor
Returns:
the value.








getNominalScalar
public java.lang.Number getNominalScalar()
Description copied from interface: NXmonitor
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getNominalScalar in interface NXmonitor
Returns:
the value.








setNominal
public DataNode setNominal(IDataset nominal)
Description copied from interface: NXmonitor
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setNominal in interface NXmonitor
Parameters:
nominal - the nominal








setNominalScalar
public DataNode setNominalScalar(java.lang.Number nominal)
Description copied from interface: NXmonitor
Nominal reading to be used for normalisation purposes.
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setNominalScalar in interface NXmonitor
Parameters:
nominal - the nominal








getIntegral
public IDataset getIntegral()
Description copied from interface: NXmonitor
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getIntegral in interface NXmonitor
Returns:
the value.








getIntegralScalar
public java.lang.Number getIntegralScalar()
Description copied from interface: NXmonitor
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
getIntegralScalar in interface NXmonitor
Returns:
the value.








setIntegral
public DataNode setIntegral(IDataset integral)
Description copied from interface: NXmonitor
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setIntegral in interface NXmonitor
Parameters:
integral - the integral








setIntegralScalar
public DataNode setIntegralScalar(java.lang.Number integral)
Description copied from interface: NXmonitor
Total integral monitor counts
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Specified by:
setIntegralScalar in interface NXmonitor
Parameters:
integral - the integral








getIntegral_log
public NXlog getIntegral_log()
Description copied from interface: NXmonitor
Time variation of monitor counts

Specified by:
getIntegral_log in interface NXmonitor
Returns:
the value.








setIntegral_log
public void setIntegral_log(NXlog integral_log)
Description copied from interface: NXmonitor
Time variation of monitor counts

Specified by:
setIntegral_log in interface NXmonitor
Parameters:
integral_log - the integral_log








getType
public IDataset getType()
Description copied from interface: NXmonitor

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Specified by:
getType in interface NXmonitor
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXmonitor

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Specified by:
getTypeScalar in interface NXmonitor
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXmonitor

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Specified by:
setType in interface NXmonitor
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXmonitor

 
Enumeration:

 
Fission Chamber 
 
Scintillator 

 


Specified by:
setTypeScalar in interface NXmonitor
Parameters:
type - the type








getTime_of_flight
public IDataset getTime_of_flight()
Description copied from interface: NXmonitor
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Specified by:
getTime_of_flight in interface NXmonitor
Returns:
the value.








getTime_of_flightScalar
public java.lang.Double getTime_of_flightScalar()
Description copied from interface: NXmonitor
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Specified by:
getTime_of_flightScalar in interface NXmonitor
Returns:
the value.








setTime_of_flight
public DataNode setTime_of_flight(IDataset time_of_flight)
Description copied from interface: NXmonitor
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Specified by:
setTime_of_flight in interface NXmonitor
Parameters:
time_of_flight - the time_of_flight








setTime_of_flightScalar
public DataNode setTime_of_flightScalar(java.lang.Double time_of_flight)
Description copied from interface: NXmonitor
Time-of-flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: ;
 

Specified by:
setTime_of_flightScalar in interface NXmonitor
Parameters:
time_of_flight - the time_of_flight








getEfficiency
public IDataset getEfficiency()
Description copied from interface: NXmonitor
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Specified by:
getEfficiency in interface NXmonitor
Returns:
the value.








getEfficiencyScalar
public java.lang.Number getEfficiencyScalar()
Description copied from interface: NXmonitor
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Specified by:
getEfficiencyScalar in interface NXmonitor
Returns:
the value.








setEfficiency
public DataNode setEfficiency(IDataset efficiency)
Description copied from interface: NXmonitor
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Specified by:
setEfficiency in interface NXmonitor
Parameters:
efficiency - the efficiency








setEfficiencyScalar
public DataNode setEfficiencyScalar(java.lang.Number efficiency)
Description copied from interface: NXmonitor
Monitor efficiency
 

 Type: NX_NUMBER
 Units: NX_DIMENSIONLESS
 Dimensions: 1: ;
 

Specified by:
setEfficiencyScalar in interface NXmonitor
Parameters:
efficiency - the efficiency








getData
public IDataset getData()
Description copied from interface: NXmonitor
Monitor data
 

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

Specified by:
getData in interface NXmonitor
Returns:
the value.








getDataScalar
public java.lang.Number getDataScalar()
Description copied from interface: NXmonitor
Monitor data
 

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

Specified by:
getDataScalar in interface NXmonitor
Returns:
the value.








setData
public DataNode setData(IDataset data)
Description copied from interface: NXmonitor
Monitor data
 

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

Specified by:
setData in interface NXmonitor
Parameters:
data - the data








setDataScalar
public DataNode setDataScalar(java.lang.Number data)
Description copied from interface: NXmonitor
Monitor data
 

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

Specified by:
setDataScalar in interface NXmonitor
Parameters:
data - the data








getSampled_fraction
public IDataset getSampled_fraction()
Description copied from interface: NXmonitor
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Specified by:
getSampled_fraction in interface NXmonitor
Returns:
the value.








getSampled_fractionScalar
public java.lang.Double getSampled_fractionScalar()
Description copied from interface: NXmonitor
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Specified by:
getSampled_fractionScalar in interface NXmonitor
Returns:
the value.








setSampled_fraction
public DataNode setSampled_fraction(IDataset sampled_fraction)
Description copied from interface: NXmonitor
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Specified by:
setSampled_fraction in interface NXmonitor
Parameters:
sampled_fraction - the sampled_fraction








setSampled_fractionScalar
public DataNode setSampled_fractionScalar(java.lang.Double sampled_fraction)
Description copied from interface: NXmonitor
Proportion of incident beam sampled by the monitor (0
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 


Specified by:
setSampled_fractionScalar in interface NXmonitor
Parameters:
sampled_fraction - the sampled_fraction








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXmonitor
Geometry of the monitor

Specified by:
getGeometry in interface NXmonitor
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXmonitor
Geometry of the monitor

Specified by:
setGeometry in interface NXmonitor
Parameters:
geometry - the geometry








getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXmonitor
Get a NXgeometry node by name:
 

 

 Geometry of the monitor
 

Specified by:
getGeometry in interface NXmonitor
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
public void setGeometry(java.lang.String name,
                        NXgeometry geometry)
Description copied from interface: NXmonitor
Set a NXgeometry node by name:
 

 

 Geometry of the monitor
 

Specified by:
setGeometry in interface NXmonitor
Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
public java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Description copied from interface: NXmonitor
Get all NXgeometry nodes:
 

 

 Geometry of the monitor
 

Specified by:
getAllGeometry in interface NXmonitor
Returns:
a map from node names to the NXgeometry for that node.








setAllGeometry
public void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Description copied from interface: NXmonitor
Set multiple child nodes of a particular type.
 

 

 Geometry of the monitor
 

Specified by:
setAllGeometry in interface NXmonitor
Parameters:
geometry - the child nodes to add








getCount_time
public IDataset getCount_time()
Description copied from interface: NXmonitor
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
 

Specified by:
getCount_time in interface NXmonitor
Returns:
the value.








getCount_timeScalar
public java.lang.Double getCount_timeScalar()
Description copied from interface: NXmonitor
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
 

Specified by:
getCount_timeScalar in interface NXmonitor
Returns:
the value.








setCount_time
public DataNode setCount_time(IDataset count_time)
Description copied from interface: NXmonitor
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
 

Specified by:
setCount_time in interface NXmonitor
Parameters:
count_time - the count_time








setCount_timeScalar
public DataNode setCount_timeScalar(java.lang.Double count_time)
Description copied from interface: NXmonitor
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
 

Specified by:
setCount_timeScalar in interface NXmonitor
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