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






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


All Known Implementing Classes:
NXdetectorImpl




public interface NXdetector
extends NXobject
A detector, detector bank, or multidetector.
 
Symbols: 
 These symbols will be used below to coordinate datasets with the same shape.

 
np 
 number of scan points (only present in scanning measurements)
 
i 
 number of detector pixels in the first (X, slowest) direction
 
j 
 number of detector pixels in the second (Y, faster) direction
 
k 
 number of detector pixels in the third (Z, if necessary, fastest) direction
 
tof 
 number of bins in the time-of-flight histogram












Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ACQUISITION_MODE 


static java.lang.String
NX_ANGULAR_CALIBRATION 


static java.lang.String
NX_ANGULAR_CALIBRATION_APPLIED 


static java.lang.String
NX_AZIMUTHAL_ANGLE 


static java.lang.String
NX_BEAM_CENTER_X 


static java.lang.String
NX_BEAM_CENTER_Y 


static java.lang.String
NX_BIT_DEPTH_READOUT 


static java.lang.String
NX_CALIBRATION_DATE 


static java.lang.String
NX_COUNT_TIME 


static java.lang.String
NX_COUNTRATE_CORRECTION__APPLIED 


static java.lang.String
NX_CRATE 


static java.lang.String
NX_CRATE_ATTRIBUTE_LOCAL_NAME 


static java.lang.String
NX_DATA 


static java.lang.String
NX_DATA_ATTRIBUTE_CHECK_SUM 


static java.lang.String
NX_DATA_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_DATA_ERROR 


static java.lang.String
NX_DEAD_TIME 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_DETECTION_GAS_PATH 


static java.lang.String
NX_DETECTOR_NUMBER 


static java.lang.String
NX_DETECTOR_READOUT_TIME 


static java.lang.String
NX_DIAMETER 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_FLATFIELD 


static java.lang.String
NX_FLATFIELD_APPLIED 


static java.lang.String
NX_FLATFIELD_ERROR 


static java.lang.String
NX_FRAME_START_NUMBER 


static java.lang.String
NX_FRAME_TIME 


static java.lang.String
NX_GAIN_SETTING 


static java.lang.String
NX_GAS_PRESSURE 


static java.lang.String
NX_INPUT 


static java.lang.String
NX_INPUT_ATTRIBUTE_LOCAL_NAME 


static java.lang.String
NX_LAYOUT 


static java.lang.String
NX_LOCAL_NAME 


static java.lang.String
NX_NUMBER_OF_CYCLES 


static java.lang.String
NX_PIXEL_MASK 


static java.lang.String
NX_PIXEL_MASK_APPLIED 


static java.lang.String
NX_POLAR_ANGLE 


static java.lang.String
NX_RAW_TIME_OF_FLIGHT 


static java.lang.String
NX_RAW_TIME_OF_FLIGHT_ATTRIBUTE_FREQUENCY 


static java.lang.String
NX_SATURATION_VALUE 


static java.lang.String
NX_SENSOR_MATERIAL 


static java.lang.String
NX_SENSOR_THICKNESS 


static java.lang.String
NX_SEQUENCE_NUMBER 


static java.lang.String
NX_SERIAL_NUMBER 


static java.lang.String
NX_SLOT 


static java.lang.String
NX_SLOT_ATTRIBUTE_LOCAL_NAME 


static java.lang.String
NX_SOLID_ANGLE 


static java.lang.String
NX_THRESHOLD_ENERGY 


static java.lang.String
NX_TIME_OF_FLIGHT 


static java.lang.String
NX_TIME_OF_FLIGHT_ATTRIBUTE_AXIS 


static java.lang.String
NX_TIME_OF_FLIGHT_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_TIME_OF_FLIGHT_ATTRIBUTE_PRIMARY 


static java.lang.String
NX_TRIGGER_DEAD_TIME 


static java.lang.String
NX_TRIGGER_DELAY_TIME 


static java.lang.String
NX_TRIGGER_DELAY_TIME_SET 


static java.lang.String
NX_TRIGGER_INTERNAL_DELAY_TIME 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_X_PIXEL_OFFSET 


static java.lang.String
NX_X_PIXEL_OFFSET_ATTRIBUTE_AXIS 


static java.lang.String
NX_X_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_X_PIXEL_OFFSET_ATTRIBUTE_PRIMARY 


static java.lang.String
NX_X_PIXEL_SIZE 


static java.lang.String
NX_Y_PIXEL_OFFSET 


static java.lang.String
NX_Y_PIXEL_OFFSET_ATTRIBUTE_AXIS 


static java.lang.String
NX_Y_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_Y_PIXEL_OFFSET_ATTRIBUTE_PRIMARY 


static java.lang.String
NX_Y_PIXEL_SIZE 


static java.lang.String
NX_Z_PIXEL_OFFSET 


static java.lang.String
NX_Z_PIXEL_OFFSET_ATTRIBUTE_AXIS 


static java.lang.String
NX_Z_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_Z_PIXEL_OFFSET_ATTRIBUTE_PRIMARY 






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








Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods 

Modifier and Type
Method and Description


IDataset
getAcquisition_mode()
The acquisition mode of the detector.



java.lang.String
getAcquisition_modeScalar()
The acquisition mode of the detector.



java.util.Map<java.lang.String,NXcollection>
getAllCollection()
Get all NXcollection nodes:
 
 
 Use this group to provide other data related to this NXdetector group.
 



java.util.Map<java.lang.String,NXdetector_module>
getAllDetector_module()
Get all NXdetector_module nodes:
 
 
 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.



java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 Position and orientation of detector
 



IDataset
getAngular_calibration_applied()
True when the angular calibration has been applied in the
 electronics, false otherwise.



java.lang.Boolean
getAngular_calibration_appliedScalar()
True when the angular calibration has been applied in the
 electronics, false otherwise.



IDataset
getAngular_calibration()
Angular calibration data.



java.lang.Double
getAngular_calibrationScalar()
Angular calibration data.



IDataset
getAzimuthal_angle()
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.



java.lang.Double
getAzimuthal_angleScalar()
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.



IDataset
getBeam_center_x()
This is the x position where the direct beam would hit the detector.



java.lang.Double
getBeam_center_xScalar()
This is the x position where the direct beam would hit the detector.



IDataset
getBeam_center_y()
This is the y position where the direct beam would hit the detector.



java.lang.Double
getBeam_center_yScalar()
This is the y position where the direct beam would hit the detector.



IDataset
getBit_depth_readout()
How many bits the electronics reads per pixel.



java.lang.Long
getBit_depth_readoutScalar()
How many bits the electronics reads per pixel.



IDataset
getCalibration_date()
date of last calibration (geometry and/or efficiency) measurements



java.util.Date
getCalibration_dateScalar()
date of last calibration (geometry and/or efficiency) measurements



NXnote
getCalibration_method()
summary of conversion of array data to pixels (e.g.



NXcollection
getCollection()
Use this group to provide other data related to this NXdetector group.



NXcollection
getCollection(java.lang.String name)
Get a NXcollection node by name:
 
 
 Use this group to provide other data related to this NXdetector group.
 



IDataset
getCount_time()
Elapsed actual counting time



java.lang.Number
getCount_timeScalar()
Elapsed actual counting time



IDataset
getCountrate_correction__applied()
True when a count-rate correction has already been applied in the
 electronics, false otherwise.



java.lang.Boolean
getCountrate_correction__appliedScalar()
True when a count-rate correction has already been applied in the
 electronics, false otherwise.



IDataset
getCrate()
Crate number of detector



java.lang.String
getCrateAttributeLocal_name()
Equivalent local term



java.lang.Long
getCrateScalar()
Crate number of detector



IDataset
getData_error()
The best estimate of the uncertainty in the data value.



java.lang.Number
getData_errorScalar()
The best estimate of the uncertainty in the data value.



NXnote
getData_file() 


IDataset
getData()
Data values from the detector.



java.lang.Long
getDataAttributeCheck_sum()
Integral of data as check of data integrity



java.lang.String
getDataAttributeLong_name()
Title of measurement



java.lang.Number
getDataScalar()
Data values from the detector.



IDataset
getDead_time()
Detector dead time



java.lang.Double
getDead_timeScalar()
Detector dead time



IDataset
getDescription()
name/manufacturer/model/etc.



java.lang.String
getDescriptionScalar()
name/manufacturer/model/etc.



IDataset
getDetection_gas_path()
maximum drift space dimension



java.lang.Double
getDetection_gas_pathScalar()
maximum drift space dimension



NXdetector_module
getDetector_module()
For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.



NXdetector_module
getDetector_module(java.lang.String name)
Get a NXdetector_module node by name:
 
 
 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.



IDataset
getDetector_number()
Identifier for detector (pixels)
 Can be multidimensional, if needed



java.lang.Long
getDetector_numberScalar()
Identifier for detector (pixels)
 Can be multidimensional, if needed



IDataset
getDetector_readout_time()
Time it takes to read the detector (typically milliseconds).



java.lang.Double
getDetector_readout_timeScalar()
Time it takes to read the detector (typically milliseconds).



IDataset
getDiameter()
The diameter of a cylindrical detector



java.lang.Double
getDiameterScalar()
The diameter of a cylindrical detector



IDataset
getDistance()
This is the distance to the previous component in the
 instrument; most often the sample.



java.lang.Double
getDistanceScalar()
This is the distance to the previous component in the
 instrument; most often the sample.



NXdata
getEfficiency()
Spectral efficiency of detector with respect to e.g.



IDataset
getFlatfield_applied()
True when the flat field correction has been applied in the
 electronics, false otherwise.



java.lang.Boolean
getFlatfield_appliedScalar()
True when the flat field correction has been applied in the
 electronics, false otherwise.



IDataset
getFlatfield_error()
Errors of the flat field correction data.



java.lang.Double
getFlatfield_errorScalar()
Errors of the flat field correction data.



IDataset
getFlatfield()
Flat field correction data.



java.lang.Double
getFlatfieldScalar()
Flat field correction data.



IDataset
getFrame_start_number()
This is the start number of the first frame of a scan.



java.lang.Long
getFrame_start_numberScalar()
This is the start number of the first frame of a scan.



IDataset
getFrame_time()
This is time for each frame.



java.lang.Double
getFrame_timeScalar()
This is time for each frame.



IDataset
getGain_setting()
The gain setting of the detector.



java.lang.String
getGain_settingScalar()
The gain setting of the detector.



IDataset
getGas_pressure()
Detector gas pressure



java.lang.Double
getGas_pressureScalar()
Detector gas pressure



NXgeometry
getGeometry()
Position and orientation of detector



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 Position and orientation of detector
 



IDataset
getInput()
Input number of detector



java.lang.String
getInputAttributeLocal_name()
Equivalent local term



java.lang.Long
getInputScalar()
Input number of detector



IDataset
getLayout()
How the detector is represented



java.lang.String
getLayoutScalar()
How the detector is represented



IDataset
getLocal_name()
Local name for the detector



java.lang.String
getLocal_nameScalar()
Local name for the detector



IDataset
getNumber_of_cycles()
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics.



java.lang.Long
getNumber_of_cyclesScalar()
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics.



IDataset
getPixel_mask_applied()
True when the pixel mask correction has been applied in the
 electronics, false otherwise.



java.lang.Boolean
getPixel_mask_appliedScalar()
True when the pixel mask correction has been applied in the
 electronics, false otherwise.



IDataset
getPixel_mask()
The 32-bit pixel mask for the detector.



java.lang.Long
getPixel_maskScalar()
The 32-bit pixel mask for the detector.



IDataset
getPolar_angle()
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.



java.lang.Double
getPolar_angleScalar()
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.



IDataset
getRaw_time_of_flight()
In DAQ clock pulses



java.lang.Number
getRaw_time_of_flightAttributeFrequency()
Clock frequency in Hz



java.lang.Long
getRaw_time_of_flightScalar()
In DAQ clock pulses



IDataset
getSaturation_value()
The value at which the detector goes into saturation.



java.lang.Long
getSaturation_valueScalar()
The value at which the detector goes into saturation.



IDataset
getSensor_material()
At times, radiation is not directly sensed by the detector.



java.lang.String
getSensor_materialScalar()
At times, radiation is not directly sensed by the detector.



IDataset
getSensor_thickness()
At times, radiation is not directly sensed by the detector.



java.lang.Double
getSensor_thicknessScalar()
At times, radiation is not directly sensed by the detector.



IDataset
getSequence_number()
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.



java.lang.Long
getSequence_numberScalar()
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.



IDataset
getSerial_number()
Serial number for the detector



java.lang.String
getSerial_numberScalar()
Serial number for the detector



IDataset
getSlot()
Slot number of detector



java.lang.String
getSlotAttributeLocal_name()
Equivalent local term



java.lang.Long
getSlotScalar()
Slot number of detector



IDataset
getSolid_angle()
Solid angle subtended by the detector at the sample



java.lang.Double
getSolid_angleScalar()
Solid angle subtended by the detector at the sample



IDataset
getThreshold_energy()
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally.



java.lang.Double
getThreshold_energyScalar()
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally.



IDataset
getTime_of_flight()
Total time of flight



java.lang.Long
getTime_of_flightAttributeAxis()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.String
getTime_of_flightAttributeLong_name()
Total time of flight



java.lang.Long
getTime_of_flightAttributePrimary()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.Double
getTime_of_flightScalar()
Total time of flight



IDataset
getTrigger_dead_time()
Time during which no new trigger signal can be accepted.



java.lang.Double
getTrigger_dead_timeScalar()
Time during which no new trigger signal can be accepted.



IDataset
getTrigger_delay_time_set()
User-specified trigger delay.



java.lang.Double
getTrigger_delay_time_setScalar()
User-specified trigger delay.



IDataset
getTrigger_delay_time()
Time it takes to start exposure after a trigger signal has been received.



java.lang.Double
getTrigger_delay_timeScalar()
Time it takes to start exposure after a trigger signal has been received.



IDataset
getTrigger_internal_delay_time()
Time it takes to start exposure after a trigger signal has been received.



java.lang.Double
getTrigger_internal_delay_timeScalar()
Time it takes to start exposure after a trigger signal has been received.



IDataset
getType()
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...



java.lang.String
getTypeScalar()
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...



IDataset
getX_pixel_offset()
Offset from the detector center in x-direction.



java.lang.Long
getX_pixel_offsetAttributeAxis()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.String
getX_pixel_offsetAttributeLong_name()
x-axis offset from detector center



java.lang.Long
getX_pixel_offsetAttributePrimary()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.Double
getX_pixel_offsetScalar()
Offset from the detector center in x-direction.



IDataset
getX_pixel_size()
Size of each detector pixel.



java.lang.Double
getX_pixel_sizeScalar()
Size of each detector pixel.



IDataset
getY_pixel_offset()
Offset from the detector center in the y-direction.



java.lang.Long
getY_pixel_offsetAttributeAxis()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.String
getY_pixel_offsetAttributeLong_name()
y-axis offset from detector center



java.lang.Long
getY_pixel_offsetAttributePrimary()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.Double
getY_pixel_offsetScalar()
Offset from the detector center in the y-direction.



IDataset
getY_pixel_size()
Size of each detector pixel.



java.lang.Double
getY_pixel_sizeScalar()
Size of each detector pixel.



IDataset
getZ_pixel_offset()
Offset from the detector center in the z-direction.



java.lang.Long
getZ_pixel_offsetAttributeAxis()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.String
getZ_pixel_offsetAttributeLong_name()
y-axis offset from detector center



java.lang.Long
getZ_pixel_offsetAttributePrimary()
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




java.lang.Double
getZ_pixel_offsetScalar()
Offset from the detector center in the z-direction.



DataNode
setAcquisition_mode(IDataset acquisition_mode)
The acquisition mode of the detector.



DataNode
setAcquisition_modeScalar(java.lang.String acquisition_mode)
The acquisition mode of the detector.



void
setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Set multiple child nodes of a particular type.



void
setAllDetector_module(java.util.Map<java.lang.String,NXdetector_module> detector_module)
Set multiple child nodes of a particular type.



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



DataNode
setAngular_calibration_applied(IDataset angular_calibration_applied)
True when the angular calibration has been applied in the
 electronics, false otherwise.



DataNode
setAngular_calibration_appliedScalar(java.lang.Boolean angular_calibration_applied)
True when the angular calibration has been applied in the
 electronics, false otherwise.



DataNode
setAngular_calibration(IDataset angular_calibration)
Angular calibration data.



DataNode
setAngular_calibrationScalar(java.lang.Double angular_calibration)
Angular calibration data.



DataNode
setAzimuthal_angle(IDataset azimuthal_angle)
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.



DataNode
setAzimuthal_angleScalar(java.lang.Double azimuthal_angle)
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.



DataNode
setBeam_center_x(IDataset beam_center_x)
This is the x position where the direct beam would hit the detector.



DataNode
setBeam_center_xScalar(java.lang.Double beam_center_x)
This is the x position where the direct beam would hit the detector.



DataNode
setBeam_center_y(IDataset beam_center_y)
This is the y position where the direct beam would hit the detector.



DataNode
setBeam_center_yScalar(java.lang.Double beam_center_y)
This is the y position where the direct beam would hit the detector.



DataNode
setBit_depth_readout(IDataset bit_depth_readout)
How many bits the electronics reads per pixel.



DataNode
setBit_depth_readoutScalar(java.lang.Long bit_depth_readout)
How many bits the electronics reads per pixel.



DataNode
setCalibration_date(IDataset calibration_date)
date of last calibration (geometry and/or efficiency) measurements



DataNode
setCalibration_dateScalar(java.util.Date calibration_date)
date of last calibration (geometry and/or efficiency) measurements



void
setCalibration_method(NXnote calibration_method)
summary of conversion of array data to pixels (e.g.



void
setCollection(NXcollection collection)
Use this group to provide other data related to this NXdetector group.



void
setCollection(java.lang.String name,
             NXcollection collection)
Set a NXcollection node by name:
 
 
 Use this group to provide other data related to this NXdetector group.
 



DataNode
setCount_time(IDataset count_time)
Elapsed actual counting time



DataNode
setCount_timeScalar(java.lang.Number count_time)
Elapsed actual counting time



DataNode
setCountrate_correction__applied(IDataset countrate_correction__applied)
True when a count-rate correction has already been applied in the
 electronics, false otherwise.



DataNode
setCountrate_correction__appliedScalar(java.lang.Boolean countrate_correction__applied)
True when a count-rate correction has already been applied in the
 electronics, false otherwise.



DataNode
setCrate(IDataset crate)
Crate number of detector



void
setCrateAttributeLocal_name(java.lang.String local_name)
Equivalent local term



DataNode
setCrateScalar(java.lang.Long crate)
Crate number of detector



DataNode
setData_error(IDataset data_error)
The best estimate of the uncertainty in the data value.



DataNode
setData_errorScalar(java.lang.Number data_error)
The best estimate of the uncertainty in the data value.



void
setData_file(NXnote data_file) 


DataNode
setData(IDataset data)
Data values from the detector.



void
setDataAttributeCheck_sum(java.lang.Long check_sum)
Integral of data as check of data integrity



void
setDataAttributeLong_name(java.lang.String long_name)
Title of measurement



DataNode
setDataScalar(java.lang.Number data)
Data values from the detector.



DataNode
setDead_time(IDataset dead_time)
Detector dead time



DataNode
setDead_timeScalar(java.lang.Double dead_time)
Detector dead time



DataNode
setDescription(IDataset description)
name/manufacturer/model/etc.



DataNode
setDescriptionScalar(java.lang.String description)
name/manufacturer/model/etc.



DataNode
setDetection_gas_path(IDataset detection_gas_path)
maximum drift space dimension



DataNode
setDetection_gas_pathScalar(java.lang.Double detection_gas_path)
maximum drift space dimension



void
setDetector_module(NXdetector_module detector_module)
For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.



void
setDetector_module(java.lang.String name,
                  NXdetector_module detector_module)
Set a NXdetector_module node by name:
 
 
 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.



DataNode
setDetector_number(IDataset detector_number)
Identifier for detector (pixels)
 Can be multidimensional, if needed



DataNode
setDetector_numberScalar(java.lang.Long detector_number)
Identifier for detector (pixels)
 Can be multidimensional, if needed



DataNode
setDetector_readout_time(IDataset detector_readout_time)
Time it takes to read the detector (typically milliseconds).



DataNode
setDetector_readout_timeScalar(java.lang.Double detector_readout_time)
Time it takes to read the detector (typically milliseconds).



DataNode
setDiameter(IDataset diameter)
The diameter of a cylindrical detector



DataNode
setDiameterScalar(java.lang.Double diameter)
The diameter of a cylindrical detector



DataNode
setDistance(IDataset distance)
This is the distance to the previous component in the
 instrument; most often the sample.



DataNode
setDistanceScalar(java.lang.Double distance)
This is the distance to the previous component in the
 instrument; most often the sample.



void
setEfficiency(NXdata efficiency)
Spectral efficiency of detector with respect to e.g.



DataNode
setFlatfield_applied(IDataset flatfield_applied)
True when the flat field correction has been applied in the
 electronics, false otherwise.



DataNode
setFlatfield_appliedScalar(java.lang.Boolean flatfield_applied)
True when the flat field correction has been applied in the
 electronics, false otherwise.



DataNode
setFlatfield_error(IDataset flatfield_error)
Errors of the flat field correction data.



DataNode
setFlatfield_errorScalar(java.lang.Double flatfield_error)
Errors of the flat field correction data.



DataNode
setFlatfield(IDataset flatfield)
Flat field correction data.



DataNode
setFlatfieldScalar(java.lang.Double flatfield)
Flat field correction data.



DataNode
setFrame_start_number(IDataset frame_start_number)
This is the start number of the first frame of a scan.



DataNode
setFrame_start_numberScalar(java.lang.Long frame_start_number)
This is the start number of the first frame of a scan.



DataNode
setFrame_time(IDataset frame_time)
This is time for each frame.



DataNode
setFrame_timeScalar(java.lang.Double frame_time)
This is time for each frame.



DataNode
setGain_setting(IDataset gain_setting)
The gain setting of the detector.



DataNode
setGain_settingScalar(java.lang.String gain_setting)
The gain setting of the detector.



DataNode
setGas_pressure(IDataset gas_pressure)
Detector gas pressure



DataNode
setGas_pressureScalar(java.lang.Double gas_pressure)
Detector gas pressure



void
setGeometry(NXgeometry geometry)
Position and orientation of detector



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 Position and orientation of detector
 



DataNode
setInput(IDataset input)
Input number of detector



void
setInputAttributeLocal_name(java.lang.String local_name)
Equivalent local term



DataNode
setInputScalar(java.lang.Long input)
Input number of detector



DataNode
setLayout(IDataset layout)
How the detector is represented



DataNode
setLayoutScalar(java.lang.String layout)
How the detector is represented



DataNode
setLocal_name(IDataset local_name)
Local name for the detector



DataNode
setLocal_nameScalar(java.lang.String local_name)
Local name for the detector



DataNode
setNumber_of_cycles(IDataset number_of_cycles)
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics.



DataNode
setNumber_of_cyclesScalar(java.lang.Long number_of_cycles)
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics.



DataNode
setPixel_mask_applied(IDataset pixel_mask_applied)
True when the pixel mask correction has been applied in the
 electronics, false otherwise.



DataNode
setPixel_mask_appliedScalar(java.lang.Boolean pixel_mask_applied)
True when the pixel mask correction has been applied in the
 electronics, false otherwise.



DataNode
setPixel_mask(IDataset pixel_mask)
The 32-bit pixel mask for the detector.



DataNode
setPixel_maskScalar(java.lang.Long pixel_mask)
The 32-bit pixel mask for the detector.



DataNode
setPolar_angle(IDataset polar_angle)
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.



DataNode
setPolar_angleScalar(java.lang.Double polar_angle)
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.



DataNode
setRaw_time_of_flight(IDataset raw_time_of_flight)
In DAQ clock pulses



void
setRaw_time_of_flightAttributeFrequency(java.lang.Number frequency)
Clock frequency in Hz



DataNode
setRaw_time_of_flightScalar(java.lang.Long raw_time_of_flight)
In DAQ clock pulses



DataNode
setSaturation_value(IDataset saturation_value)
The value at which the detector goes into saturation.



DataNode
setSaturation_valueScalar(java.lang.Long saturation_value)
The value at which the detector goes into saturation.



DataNode
setSensor_material(IDataset sensor_material)
At times, radiation is not directly sensed by the detector.



DataNode
setSensor_materialScalar(java.lang.String sensor_material)
At times, radiation is not directly sensed by the detector.



DataNode
setSensor_thickness(IDataset sensor_thickness)
At times, radiation is not directly sensed by the detector.



DataNode
setSensor_thicknessScalar(java.lang.Double sensor_thickness)
At times, radiation is not directly sensed by the detector.



DataNode
setSequence_number(IDataset sequence_number)
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.



DataNode
setSequence_numberScalar(java.lang.Long sequence_number)
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.



DataNode
setSerial_number(IDataset serial_number)
Serial number for the detector



DataNode
setSerial_numberScalar(java.lang.String serial_number)
Serial number for the detector



DataNode
setSlot(IDataset slot)
Slot number of detector



void
setSlotAttributeLocal_name(java.lang.String local_name)
Equivalent local term



DataNode
setSlotScalar(java.lang.Long slot)
Slot number of detector



DataNode
setSolid_angle(IDataset solid_angle)
Solid angle subtended by the detector at the sample



DataNode
setSolid_angleScalar(java.lang.Double solid_angle)
Solid angle subtended by the detector at the sample



DataNode
setThreshold_energy(IDataset threshold_energy)
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally.



DataNode
setThreshold_energyScalar(java.lang.Double threshold_energy)
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally.



DataNode
setTime_of_flight(IDataset time_of_flight)
Total time of flight



void
setTime_of_flightAttributeAxis(java.lang.Long axis)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




void
setTime_of_flightAttributeLong_name(java.lang.String long_name)
Total time of flight



void
setTime_of_flightAttributePrimary(java.lang.Long primary)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




DataNode
setTime_of_flightScalar(java.lang.Double time_of_flight)
Total time of flight



DataNode
setTrigger_dead_time(IDataset trigger_dead_time)
Time during which no new trigger signal can be accepted.



DataNode
setTrigger_dead_timeScalar(java.lang.Double trigger_dead_time)
Time during which no new trigger signal can be accepted.



DataNode
setTrigger_delay_time_set(IDataset trigger_delay_time_set)
User-specified trigger delay.



DataNode
setTrigger_delay_time_setScalar(java.lang.Double trigger_delay_time_set)
User-specified trigger delay.



DataNode
setTrigger_delay_time(IDataset trigger_delay_time)
Time it takes to start exposure after a trigger signal has been received.



DataNode
setTrigger_delay_timeScalar(java.lang.Double trigger_delay_time)
Time it takes to start exposure after a trigger signal has been received.



DataNode
setTrigger_internal_delay_time(IDataset trigger_internal_delay_time)
Time it takes to start exposure after a trigger signal has been received.



DataNode
setTrigger_internal_delay_timeScalar(java.lang.Double trigger_internal_delay_time)
Time it takes to start exposure after a trigger signal has been received.



DataNode
setType(IDataset type)
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...



DataNode
setTypeScalar(java.lang.String type)
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...



DataNode
setX_pixel_offset(IDataset x_pixel_offset)
Offset from the detector center in x-direction.



void
setX_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




void
setX_pixel_offsetAttributeLong_name(java.lang.String long_name)
x-axis offset from detector center



void
setX_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




DataNode
setX_pixel_offsetScalar(java.lang.Double x_pixel_offset)
Offset from the detector center in x-direction.



DataNode
setX_pixel_size(IDataset x_pixel_size)
Size of each detector pixel.



DataNode
setX_pixel_sizeScalar(java.lang.Double x_pixel_size)
Size of each detector pixel.



DataNode
setY_pixel_offset(IDataset y_pixel_offset)
Offset from the detector center in the y-direction.



void
setY_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




void
setY_pixel_offsetAttributeLong_name(java.lang.String long_name)
y-axis offset from detector center



void
setY_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




DataNode
setY_pixel_offsetScalar(java.lang.Double y_pixel_offset)
Offset from the detector center in the y-direction.



DataNode
setY_pixel_size(IDataset y_pixel_size)
Size of each detector pixel.



DataNode
setY_pixel_sizeScalar(java.lang.Double y_pixel_size)
Size of each detector pixel.



DataNode
setZ_pixel_offset(IDataset z_pixel_offset)
Offset from the detector center in the z-direction.



void
setZ_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




void
setZ_pixel_offsetAttributeLong_name(java.lang.String long_name)
y-axis offset from detector center



void
setZ_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. 
see: https://github.com/nexusformat/definitions/issues/436




DataNode
setZ_pixel_offsetScalar(java.lang.Double z_pixel_offset)
Offset from the detector center in the z-direction.







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_TIME_OF_FLIGHT
static final java.lang.String NX_TIME_OF_FLIGHT

See Also:
Constant Field Values








NX_TIME_OF_FLIGHT_ATTRIBUTE_AXIS
static final java.lang.String NX_TIME_OF_FLIGHT_ATTRIBUTE_AXIS

See Also:
Constant Field Values








NX_TIME_OF_FLIGHT_ATTRIBUTE_PRIMARY
static final java.lang.String NX_TIME_OF_FLIGHT_ATTRIBUTE_PRIMARY

See Also:
Constant Field Values








NX_TIME_OF_FLIGHT_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_TIME_OF_FLIGHT_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_RAW_TIME_OF_FLIGHT
static final java.lang.String NX_RAW_TIME_OF_FLIGHT

See Also:
Constant Field Values








NX_RAW_TIME_OF_FLIGHT_ATTRIBUTE_FREQUENCY
static final java.lang.String NX_RAW_TIME_OF_FLIGHT_ATTRIBUTE_FREQUENCY

See Also:
Constant Field Values








NX_DETECTOR_NUMBER
static final java.lang.String NX_DETECTOR_NUMBER

See Also:
Constant Field Values








NX_DATA
static final java.lang.String NX_DATA

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_DATA_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_CHECK_SUM
static final java.lang.String NX_DATA_ATTRIBUTE_CHECK_SUM

See Also:
Constant Field Values








NX_DATA_ERROR
static final java.lang.String NX_DATA_ERROR

See Also:
Constant Field Values








NX_X_PIXEL_OFFSET
static final java.lang.String NX_X_PIXEL_OFFSET

See Also:
Constant Field Values








NX_X_PIXEL_OFFSET_ATTRIBUTE_AXIS
static final java.lang.String NX_X_PIXEL_OFFSET_ATTRIBUTE_AXIS

See Also:
Constant Field Values








NX_X_PIXEL_OFFSET_ATTRIBUTE_PRIMARY
static final java.lang.String NX_X_PIXEL_OFFSET_ATTRIBUTE_PRIMARY

See Also:
Constant Field Values








NX_X_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_X_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_Y_PIXEL_OFFSET
static final java.lang.String NX_Y_PIXEL_OFFSET

See Also:
Constant Field Values








NX_Y_PIXEL_OFFSET_ATTRIBUTE_AXIS
static final java.lang.String NX_Y_PIXEL_OFFSET_ATTRIBUTE_AXIS

See Also:
Constant Field Values








NX_Y_PIXEL_OFFSET_ATTRIBUTE_PRIMARY
static final java.lang.String NX_Y_PIXEL_OFFSET_ATTRIBUTE_PRIMARY

See Also:
Constant Field Values








NX_Y_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_Y_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_Z_PIXEL_OFFSET
static final java.lang.String NX_Z_PIXEL_OFFSET

See Also:
Constant Field Values








NX_Z_PIXEL_OFFSET_ATTRIBUTE_AXIS
static final java.lang.String NX_Z_PIXEL_OFFSET_ATTRIBUTE_AXIS

See Also:
Constant Field Values








NX_Z_PIXEL_OFFSET_ATTRIBUTE_PRIMARY
static final java.lang.String NX_Z_PIXEL_OFFSET_ATTRIBUTE_PRIMARY

See Also:
Constant Field Values








NX_Z_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_Z_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_POLAR_ANGLE
static final java.lang.String NX_POLAR_ANGLE

See Also:
Constant Field Values








NX_AZIMUTHAL_ANGLE
static final java.lang.String NX_AZIMUTHAL_ANGLE

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_SERIAL_NUMBER
static final java.lang.String NX_SERIAL_NUMBER

See Also:
Constant Field Values








NX_LOCAL_NAME
static final java.lang.String NX_LOCAL_NAME

See Also:
Constant Field Values








NX_SOLID_ANGLE
static final java.lang.String NX_SOLID_ANGLE

See Also:
Constant Field Values








NX_X_PIXEL_SIZE
static final java.lang.String NX_X_PIXEL_SIZE

See Also:
Constant Field Values








NX_Y_PIXEL_SIZE
static final java.lang.String NX_Y_PIXEL_SIZE

See Also:
Constant Field Values








NX_DEAD_TIME
static final java.lang.String NX_DEAD_TIME

See Also:
Constant Field Values








NX_GAS_PRESSURE
static final java.lang.String NX_GAS_PRESSURE

See Also:
Constant Field Values








NX_DETECTION_GAS_PATH
static final java.lang.String NX_DETECTION_GAS_PATH

See Also:
Constant Field Values








NX_CRATE
static final java.lang.String NX_CRATE

See Also:
Constant Field Values








NX_CRATE_ATTRIBUTE_LOCAL_NAME
static final java.lang.String NX_CRATE_ATTRIBUTE_LOCAL_NAME

See Also:
Constant Field Values








NX_SLOT
static final java.lang.String NX_SLOT

See Also:
Constant Field Values








NX_SLOT_ATTRIBUTE_LOCAL_NAME
static final java.lang.String NX_SLOT_ATTRIBUTE_LOCAL_NAME

See Also:
Constant Field Values








NX_INPUT
static final java.lang.String NX_INPUT

See Also:
Constant Field Values








NX_INPUT_ATTRIBUTE_LOCAL_NAME
static final java.lang.String NX_INPUT_ATTRIBUTE_LOCAL_NAME

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_CALIBRATION_DATE
static final java.lang.String NX_CALIBRATION_DATE

See Also:
Constant Field Values








NX_LAYOUT
static final java.lang.String NX_LAYOUT

See Also:
Constant Field Values








NX_COUNT_TIME
static final java.lang.String NX_COUNT_TIME

See Also:
Constant Field Values








NX_SEQUENCE_NUMBER
static final java.lang.String NX_SEQUENCE_NUMBER

See Also:
Constant Field Values








NX_BEAM_CENTER_X
static final java.lang.String NX_BEAM_CENTER_X

See Also:
Constant Field Values








NX_BEAM_CENTER_Y
static final java.lang.String NX_BEAM_CENTER_Y

See Also:
Constant Field Values








NX_FRAME_START_NUMBER
static final java.lang.String NX_FRAME_START_NUMBER

See Also:
Constant Field Values








NX_DIAMETER
static final java.lang.String NX_DIAMETER

See Also:
Constant Field Values








NX_ACQUISITION_MODE
static final java.lang.String NX_ACQUISITION_MODE

See Also:
Constant Field Values








NX_ANGULAR_CALIBRATION_APPLIED
static final java.lang.String NX_ANGULAR_CALIBRATION_APPLIED

See Also:
Constant Field Values








NX_ANGULAR_CALIBRATION
static final java.lang.String NX_ANGULAR_CALIBRATION

See Also:
Constant Field Values








NX_FLATFIELD_APPLIED
static final java.lang.String NX_FLATFIELD_APPLIED

See Also:
Constant Field Values








NX_FLATFIELD
static final java.lang.String NX_FLATFIELD

See Also:
Constant Field Values








NX_FLATFIELD_ERROR
static final java.lang.String NX_FLATFIELD_ERROR

See Also:
Constant Field Values








NX_PIXEL_MASK_APPLIED
static final java.lang.String NX_PIXEL_MASK_APPLIED

See Also:
Constant Field Values








NX_PIXEL_MASK
static final java.lang.String NX_PIXEL_MASK

See Also:
Constant Field Values








NX_COUNTRATE_CORRECTION__APPLIED
static final java.lang.String NX_COUNTRATE_CORRECTION__APPLIED

See Also:
Constant Field Values








NX_BIT_DEPTH_READOUT
static final java.lang.String NX_BIT_DEPTH_READOUT

See Also:
Constant Field Values








NX_DETECTOR_READOUT_TIME
static final java.lang.String NX_DETECTOR_READOUT_TIME

See Also:
Constant Field Values








NX_TRIGGER_DELAY_TIME
static final java.lang.String NX_TRIGGER_DELAY_TIME

See Also:
Constant Field Values








NX_TRIGGER_DELAY_TIME_SET
static final java.lang.String NX_TRIGGER_DELAY_TIME_SET

See Also:
Constant Field Values








NX_TRIGGER_INTERNAL_DELAY_TIME
static final java.lang.String NX_TRIGGER_INTERNAL_DELAY_TIME

See Also:
Constant Field Values








NX_TRIGGER_DEAD_TIME
static final java.lang.String NX_TRIGGER_DEAD_TIME

See Also:
Constant Field Values








NX_FRAME_TIME
static final java.lang.String NX_FRAME_TIME

See Also:
Constant Field Values








NX_GAIN_SETTING
static final java.lang.String NX_GAIN_SETTING

See Also:
Constant Field Values








NX_SATURATION_VALUE
static final java.lang.String NX_SATURATION_VALUE

See Also:
Constant Field Values








NX_NUMBER_OF_CYCLES
static final java.lang.String NX_NUMBER_OF_CYCLES

See Also:
Constant Field Values








NX_SENSOR_MATERIAL
static final java.lang.String NX_SENSOR_MATERIAL

See Also:
Constant Field Values








NX_SENSOR_THICKNESS
static final java.lang.String NX_SENSOR_THICKNESS

See Also:
Constant Field Values








NX_THRESHOLD_ENERGY
static final java.lang.String NX_THRESHOLD_ENERGY

See Also:
Constant Field Values










Method Detail





getTime_of_flight
IDataset getTime_of_flight()
Total time of flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: tof+1;
 

Returns:
the value.








setTime_of_flight
DataNode setTime_of_flight(IDataset time_of_flight)
Total time of flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: tof+1;
 

Parameters:
time_of_flight - the time_of_flight








getTime_of_flightScalar
java.lang.Double getTime_of_flightScalar()
Total time of flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: tof+1;
 

Returns:
the value.








setTime_of_flightScalar
DataNode setTime_of_flightScalar(java.lang.Double time_of_flight)
Total time of flight
 

 Type: NX_FLOAT
 Units: NX_TIME_OF_FLIGHT
 Dimensions: 1: tof+1;
 

Parameters:
time_of_flight - the time_of_flight








getTime_of_flightAttributeAxis
@Deprecated
java.lang.Long getTime_of_flightAttributeAxis()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
3 

 


Returns:
the value.








setTime_of_flightAttributeAxis
@Deprecated
void setTime_of_flightAttributeAxis(java.lang.Long axis)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
3 

 


Parameters:
axis - the axis








getTime_of_flightAttributePrimary
@Deprecated
java.lang.Long getTime_of_flightAttributePrimary()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Returns:
the value.








setTime_of_flightAttributePrimary
@Deprecated
void setTime_of_flightAttributePrimary(java.lang.Long primary)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Parameters:
primary - the primary








getTime_of_flightAttributeLong_name
java.lang.String getTime_of_flightAttributeLong_name()
Total time of flight

Returns:
the value.








setTime_of_flightAttributeLong_name
void setTime_of_flightAttributeLong_name(java.lang.String long_name)
Total time of flight

Parameters:
long_name - the long_name








getRaw_time_of_flight
IDataset getRaw_time_of_flight()
In DAQ clock pulses
 

 Type: NX_INT
 Units: NX_PULSES
 Dimensions: 1: tof+1;
 

Returns:
the value.








setRaw_time_of_flight
DataNode setRaw_time_of_flight(IDataset raw_time_of_flight)
In DAQ clock pulses
 

 Type: NX_INT
 Units: NX_PULSES
 Dimensions: 1: tof+1;
 

Parameters:
raw_time_of_flight - the raw_time_of_flight








getRaw_time_of_flightScalar
java.lang.Long getRaw_time_of_flightScalar()
In DAQ clock pulses
 

 Type: NX_INT
 Units: NX_PULSES
 Dimensions: 1: tof+1;
 

Returns:
the value.








setRaw_time_of_flightScalar
DataNode setRaw_time_of_flightScalar(java.lang.Long raw_time_of_flight)
In DAQ clock pulses
 

 Type: NX_INT
 Units: NX_PULSES
 Dimensions: 1: tof+1;
 

Parameters:
raw_time_of_flight - the raw_time_of_flight








getRaw_time_of_flightAttributeFrequency
java.lang.Number getRaw_time_of_flightAttributeFrequency()
Clock frequency in Hz

Returns:
the value.








setRaw_time_of_flightAttributeFrequency
void setRaw_time_of_flightAttributeFrequency(java.lang.Number frequency)
Clock frequency in Hz

Parameters:
frequency - the frequency








getDetector_number
IDataset getDetector_number()
Identifier for detector (pixels)
 Can be multidimensional, if needed
 

 Type: NX_INT
 

Returns:
the value.








setDetector_number
DataNode setDetector_number(IDataset detector_number)
Identifier for detector (pixels)
 Can be multidimensional, if needed
 

 Type: NX_INT
 

Parameters:
detector_number - the detector_number








getDetector_numberScalar
java.lang.Long getDetector_numberScalar()
Identifier for detector (pixels)
 Can be multidimensional, if needed
 

 Type: NX_INT
 

Returns:
the value.








setDetector_numberScalar
DataNode setDetector_numberScalar(java.lang.Long detector_number)
Identifier for detector (pixels)
 Can be multidimensional, if needed
 

 Type: NX_INT
 

Parameters:
detector_number - the detector_number








getData
IDataset getData()
Data values from the detector.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Returns:
the value.








setData
DataNode setData(IDataset data)
Data values from the detector.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Parameters:
data - the data








getDataScalar
java.lang.Number getDataScalar()
Data values from the detector.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Returns:
the value.








setDataScalar
DataNode setDataScalar(java.lang.Number data)
Data values from the detector.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Parameters:
data - the data








getDataAttributeLong_name
java.lang.String getDataAttributeLong_name()
Title of measurement

Returns:
the value.








setDataAttributeLong_name
void setDataAttributeLong_name(java.lang.String long_name)
Title of measurement

Parameters:
long_name - the long_name








getDataAttributeCheck_sum
java.lang.Long getDataAttributeCheck_sum()
Integral of data as check of data integrity

Returns:
the value.








setDataAttributeCheck_sum
void setDataAttributeCheck_sum(java.lang.Long check_sum)
Integral of data as check of data integrity

Parameters:
check_sum - the check_sum








getData_error
IDataset getData_error()
The best estimate of the uncertainty in the data value. Where
 possible, this should be the standard deviation, which has the same units
 as the data.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Returns:
the value.








setData_error
DataNode setData_error(IDataset data_error)
The best estimate of the uncertainty in the data value. Where
 possible, this should be the standard deviation, which has the same units
 as the data.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Parameters:
data_error - the data_error








getData_errorScalar
java.lang.Number getData_errorScalar()
The best estimate of the uncertainty in the data value. Where
 possible, this should be the standard deviation, which has the same units
 as the data.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Returns:
the value.








setData_errorScalar
DataNode setData_errorScalar(java.lang.Number data_error)
The best estimate of the uncertainty in the data value. Where
 possible, this should be the standard deviation, which has the same units
 as the data.
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: np; 2: i; 3: j; 4: tof;
 

Parameters:
data_error - the data_error








getX_pixel_offset
IDataset getX_pixel_offset()
Offset from the detector center in x-direction.
 Can be multidimensional when needed.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setX_pixel_offset
DataNode setX_pixel_offset(IDataset x_pixel_offset)
Offset from the detector center in x-direction.
 Can be multidimensional when needed.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x_pixel_offset - the x_pixel_offset








getX_pixel_offsetScalar
java.lang.Double getX_pixel_offsetScalar()
Offset from the detector center in x-direction.
 Can be multidimensional when needed.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setX_pixel_offsetScalar
DataNode setX_pixel_offsetScalar(java.lang.Double x_pixel_offset)
Offset from the detector center in x-direction.
 Can be multidimensional when needed.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x_pixel_offset - the x_pixel_offset








getX_pixel_offsetAttributeAxis
@Deprecated
java.lang.Long getX_pixel_offsetAttributeAxis()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Returns:
the value.








setX_pixel_offsetAttributeAxis
@Deprecated
void setX_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Parameters:
axis - the axis








getX_pixel_offsetAttributePrimary
@Deprecated
java.lang.Long getX_pixel_offsetAttributePrimary()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Returns:
the value.








setX_pixel_offsetAttributePrimary
@Deprecated
void setX_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Parameters:
primary - the primary








getX_pixel_offsetAttributeLong_name
java.lang.String getX_pixel_offsetAttributeLong_name()
x-axis offset from detector center

Returns:
the value.








setX_pixel_offsetAttributeLong_name
void setX_pixel_offsetAttributeLong_name(java.lang.String long_name)
x-axis offset from detector center

Parameters:
long_name - the long_name








getY_pixel_offset
IDataset getY_pixel_offset()
Offset from the detector center in the y-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setY_pixel_offset
DataNode setY_pixel_offset(IDataset y_pixel_offset)
Offset from the detector center in the y-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
y_pixel_offset - the y_pixel_offset








getY_pixel_offsetScalar
java.lang.Double getY_pixel_offsetScalar()
Offset from the detector center in the y-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setY_pixel_offsetScalar
DataNode setY_pixel_offsetScalar(java.lang.Double y_pixel_offset)
Offset from the detector center in the y-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
y_pixel_offset - the y_pixel_offset








getY_pixel_offsetAttributeAxis
@Deprecated
java.lang.Long getY_pixel_offsetAttributeAxis()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
2 

 


Returns:
the value.








setY_pixel_offsetAttributeAxis
@Deprecated
void setY_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
2 

 


Parameters:
axis - the axis








getY_pixel_offsetAttributePrimary
@Deprecated
java.lang.Long getY_pixel_offsetAttributePrimary()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Returns:
the value.








setY_pixel_offsetAttributePrimary
@Deprecated
void setY_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Parameters:
primary - the primary








getY_pixel_offsetAttributeLong_name
java.lang.String getY_pixel_offsetAttributeLong_name()
y-axis offset from detector center

Returns:
the value.








setY_pixel_offsetAttributeLong_name
void setY_pixel_offsetAttributeLong_name(java.lang.String long_name)
y-axis offset from detector center

Parameters:
long_name - the long_name








getZ_pixel_offset
IDataset getZ_pixel_offset()
Offset from the detector center in the z-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setZ_pixel_offset
DataNode setZ_pixel_offset(IDataset z_pixel_offset)
Offset from the detector center in the z-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
z_pixel_offset - the z_pixel_offset








getZ_pixel_offsetScalar
java.lang.Double getZ_pixel_offsetScalar()
Offset from the detector center in the z-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setZ_pixel_offsetScalar
DataNode setZ_pixel_offsetScalar(java.lang.Double z_pixel_offset)
Offset from the detector center in the z-direction.
 Can be multidimensional when different values are required for each pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
z_pixel_offset - the z_pixel_offset








getZ_pixel_offsetAttributeAxis
@Deprecated
java.lang.Long getZ_pixel_offsetAttributeAxis()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
3 

 


Returns:
the value.








setZ_pixel_offsetAttributeAxis
@Deprecated
void setZ_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
3 

 


Parameters:
axis - the axis








getZ_pixel_offsetAttributePrimary
@Deprecated
java.lang.Long getZ_pixel_offsetAttributePrimary()
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Returns:
the value.








setZ_pixel_offsetAttributePrimary
@Deprecated
void setZ_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated. see: https://github.com/nexusformat/definitions/issues/436

 
Enumeration:

 
1 

 


Parameters:
primary - the primary








getZ_pixel_offsetAttributeLong_name
java.lang.String getZ_pixel_offsetAttributeLong_name()
y-axis offset from detector center

Returns:
the value.








setZ_pixel_offsetAttributeLong_name
void setZ_pixel_offsetAttributeLong_name(java.lang.String long_name)
y-axis offset from detector center

Parameters:
long_name - the long_name








getDistance
IDataset getDistance()
This is the distance to the previous component in the
 instrument; most often the sample. The usage depends on the
 nature of the detector: Most often it is the distance of the
 detector assembly. But there are irregular detectors. In this
 case the distance must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
This is the distance to the previous component in the
 instrument; most often the sample. The usage depends on the
 nature of the detector: Most often it is the distance of the
 detector assembly. But there are irregular detectors. In this
 case the distance must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
This is the distance to the previous component in the
 instrument; most often the sample. The usage depends on the
 nature of the detector: Most often it is the distance of the
 detector assembly. But there are irregular detectors. In this
 case the distance must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
This is the distance to the previous component in the
 instrument; most often the sample. The usage depends on the
 nature of the detector: Most often it is the distance of the
 detector assembly. But there are irregular detectors. In this
 case the distance must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
distance - the distance








getPolar_angle
IDataset getPolar_angle()
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the polar_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the polar_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setPolar_angle
DataNode setPolar_angle(IDataset polar_angle)
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the polar_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the polar_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
polar_angle - the polar_angle








getPolar_angleScalar
java.lang.Double getPolar_angleScalar()
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the polar_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the polar_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setPolar_angleScalar
DataNode setPolar_angleScalar(java.lang.Double polar_angle)
This is the polar angle of the detector towards the previous
 component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the polar_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the polar_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
polar_angle - the polar_angle








getAzimuthal_angle
IDataset getAzimuthal_angle()
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the azimuthal_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the azimuthal_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setAzimuthal_angle
DataNode setAzimuthal_angle(IDataset azimuthal_angle)
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the azimuthal_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the azimuthal_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
azimuthal_angle - the azimuthal_angle








getAzimuthal_angleScalar
java.lang.Double getAzimuthal_angleScalar()
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the azimuthal_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the azimuthal_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setAzimuthal_angleScalar
DataNode setAzimuthal_angleScalar(java.lang.Double azimuthal_angle)
This is the azimuthal angle angle of the detector towards
 the previous component in the instrument; most often the sample.
 The usage depends on the
 nature of the detector.
 Most often it is the azimuthal_angle of the detector assembly.
 But there are irregular detectors.
 In this
 case, the azimuthal_angle must be specified for each detector pixel.
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
azimuthal_angle - the azimuthal_angle








getDescription
IDataset getDescription()
name/manufacturer/model/etc. information

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
name/manufacturer/model/etc. information

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
name/manufacturer/model/etc. information

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
name/manufacturer/model/etc. information

Parameters:
description - the description








getSerial_number
IDataset getSerial_number()
Serial number for the detector

Returns:
the value.








setSerial_number
DataNode setSerial_number(IDataset serial_number)
Serial number for the detector

Parameters:
serial_number - the serial_number








getSerial_numberScalar
java.lang.String getSerial_numberScalar()
Serial number for the detector

Returns:
the value.








setSerial_numberScalar
DataNode setSerial_numberScalar(java.lang.String serial_number)
Serial number for the detector

Parameters:
serial_number - the serial_number








getLocal_name
IDataset getLocal_name()
Local name for the detector

Returns:
the value.








setLocal_name
DataNode setLocal_name(IDataset local_name)
Local name for the detector

Parameters:
local_name - the local_name








getLocal_nameScalar
java.lang.String getLocal_nameScalar()
Local name for the detector

Returns:
the value.








setLocal_nameScalar
DataNode setLocal_nameScalar(java.lang.String local_name)
Local name for the detector

Parameters:
local_name - the local_name








getGeometry
NXgeometry getGeometry()
Position and orientation of detector

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
Position and orientation of detector

Parameters:
geometry - the geometry








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

 

 Position and orientation of detector
 

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:
 

 

 Position and orientation of detector
 

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:
 

 

 Position and orientation of detector
 

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.
 

 

 Position and orientation of detector
 

Parameters:
geometry - the child nodes to add








getSolid_angle
IDataset getSolid_angle()
Solid angle subtended by the detector at the sample
 

 Type: NX_FLOAT
 Units: NX_SOLID_ANGLE
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setSolid_angle
DataNode setSolid_angle(IDataset solid_angle)
Solid angle subtended by the detector at the sample
 

 Type: NX_FLOAT
 Units: NX_SOLID_ANGLE
 Dimensions: 1: i; 2: j;
 

Parameters:
solid_angle - the solid_angle








getSolid_angleScalar
java.lang.Double getSolid_angleScalar()
Solid angle subtended by the detector at the sample
 

 Type: NX_FLOAT
 Units: NX_SOLID_ANGLE
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setSolid_angleScalar
DataNode setSolid_angleScalar(java.lang.Double solid_angle)
Solid angle subtended by the detector at the sample
 

 Type: NX_FLOAT
 Units: NX_SOLID_ANGLE
 Dimensions: 1: i; 2: j;
 

Parameters:
solid_angle - the solid_angle








getX_pixel_size
IDataset getX_pixel_size()
Size of each detector pixel. If it is scalar all pixels are the same size.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setX_pixel_size
DataNode setX_pixel_size(IDataset x_pixel_size)
Size of each detector pixel. If it is scalar all pixels are the same size.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Parameters:
x_pixel_size - the x_pixel_size








getX_pixel_sizeScalar
java.lang.Double getX_pixel_sizeScalar()
Size of each detector pixel. If it is scalar all pixels are the same size.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setX_pixel_sizeScalar
DataNode setX_pixel_sizeScalar(java.lang.Double x_pixel_size)
Size of each detector pixel. If it is scalar all pixels are the same size.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Parameters:
x_pixel_size - the x_pixel_size








getY_pixel_size
IDataset getY_pixel_size()
Size of each detector pixel. If it is scalar all pixels are the same size
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setY_pixel_size
DataNode setY_pixel_size(IDataset y_pixel_size)
Size of each detector pixel. If it is scalar all pixels are the same size
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Parameters:
y_pixel_size - the y_pixel_size








getY_pixel_sizeScalar
java.lang.Double getY_pixel_sizeScalar()
Size of each detector pixel. If it is scalar all pixels are the same size
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setY_pixel_sizeScalar
DataNode setY_pixel_sizeScalar(java.lang.Double y_pixel_size)
Size of each detector pixel. If it is scalar all pixels are the same size
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: i; 2: j;
 

Parameters:
y_pixel_size - the y_pixel_size








getDead_time
IDataset getDead_time()
Detector dead time
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setDead_time
DataNode setDead_time(IDataset dead_time)
Detector dead time
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
dead_time - the dead_time








getDead_timeScalar
java.lang.Double getDead_timeScalar()
Detector dead time
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: np; 2: i; 3: j;
 

Returns:
the value.








setDead_timeScalar
DataNode setDead_timeScalar(java.lang.Double dead_time)
Detector dead time
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: np; 2: i; 3: j;
 

Parameters:
dead_time - the dead_time








getGas_pressure
IDataset getGas_pressure()
Detector gas pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setGas_pressure
DataNode setGas_pressure(IDataset gas_pressure)
Detector gas pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: i; 2: j;
 

Parameters:
gas_pressure - the gas_pressure








getGas_pressureScalar
java.lang.Double getGas_pressureScalar()
Detector gas pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setGas_pressureScalar
DataNode setGas_pressureScalar(java.lang.Double gas_pressure)
Detector gas pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: i; 2: j;
 

Parameters:
gas_pressure - the gas_pressure








getDetection_gas_path
IDataset getDetection_gas_path()
maximum drift space dimension
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDetection_gas_path
DataNode setDetection_gas_path(IDataset detection_gas_path)
maximum drift space dimension
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
detection_gas_path - the detection_gas_path








getDetection_gas_pathScalar
java.lang.Double getDetection_gas_pathScalar()
maximum drift space dimension
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDetection_gas_pathScalar
DataNode setDetection_gas_pathScalar(java.lang.Double detection_gas_path)
maximum drift space dimension
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
detection_gas_path - the detection_gas_path








getCrate
IDataset getCrate()
Crate number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setCrate
DataNode setCrate(IDataset crate)
Crate number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
crate - the crate








getCrateScalar
java.lang.Long getCrateScalar()
Crate number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setCrateScalar
DataNode setCrateScalar(java.lang.Long crate)
Crate number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
crate - the crate








getCrateAttributeLocal_name
java.lang.String getCrateAttributeLocal_name()
Equivalent local term

Returns:
the value.








setCrateAttributeLocal_name
void setCrateAttributeLocal_name(java.lang.String local_name)
Equivalent local term

Parameters:
local_name - the local_name








getSlot
IDataset getSlot()
Slot number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setSlot
DataNode setSlot(IDataset slot)
Slot number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
slot - the slot








getSlotScalar
java.lang.Long getSlotScalar()
Slot number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setSlotScalar
DataNode setSlotScalar(java.lang.Long slot)
Slot number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
slot - the slot








getSlotAttributeLocal_name
java.lang.String getSlotAttributeLocal_name()
Equivalent local term

Returns:
the value.








setSlotAttributeLocal_name
void setSlotAttributeLocal_name(java.lang.String local_name)
Equivalent local term

Parameters:
local_name - the local_name








getInput
IDataset getInput()
Input number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setInput
DataNode setInput(IDataset input)
Input number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
input - the input








getInputScalar
java.lang.Long getInputScalar()
Input number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setInputScalar
DataNode setInputScalar(java.lang.Long input)
Input number of detector
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
input - the input








getInputAttributeLocal_name
java.lang.String getInputAttributeLocal_name()
Equivalent local term

Returns:
the value.








setInputAttributeLocal_name
void setInputAttributeLocal_name(java.lang.String local_name)
Equivalent local term

Parameters:
local_name - the local_name








getType
IDataset getType()
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...

Returns:
the value.








setType
DataNode setType(IDataset type)
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...

Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...

Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
 fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
 CMOS, ...

Parameters:
type - the type








getEfficiency
NXdata getEfficiency()
Spectral efficiency of detector with respect to e.g. wavelength

Returns:
the value.








setEfficiency
void setEfficiency(NXdata efficiency)
Spectral efficiency of detector with respect to e.g. wavelength

Parameters:
efficiency - the efficiency








getCalibration_date
IDataset getCalibration_date()
date of last calibration (geometry and/or efficiency) measurements
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setCalibration_date
DataNode setCalibration_date(IDataset calibration_date)
date of last calibration (geometry and/or efficiency) measurements
 

 Type: NX_DATE_TIME
 

Parameters:
calibration_date - the calibration_date








getCalibration_dateScalar
java.util.Date getCalibration_dateScalar()
date of last calibration (geometry and/or efficiency) measurements
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setCalibration_dateScalar
DataNode setCalibration_dateScalar(java.util.Date calibration_date)
date of last calibration (geometry and/or efficiency) measurements
 

 Type: NX_DATE_TIME
 

Parameters:
calibration_date - the calibration_date








getCalibration_method
NXnote getCalibration_method()
summary of conversion of array data to pixels (e.g. polynomial
 approximations) and location of details of the calibrations

Returns:
the value.








setCalibration_method
void setCalibration_method(NXnote calibration_method)
summary of conversion of array data to pixels (e.g. polynomial
 approximations) and location of details of the calibrations

Parameters:
calibration_method - the calibration_method








getLayout
IDataset getLayout()
How the detector is represented
 

 
Enumeration:

 
point 
 
linear 
 
area 

 


Returns:
the value.








setLayout
DataNode setLayout(IDataset layout)
How the detector is represented
 

 
Enumeration:

 
point 
 
linear 
 
area 

 


Parameters:
layout - the layout








getLayoutScalar
java.lang.String getLayoutScalar()
How the detector is represented
 

 
Enumeration:

 
point 
 
linear 
 
area 

 


Returns:
the value.








setLayoutScalar
DataNode setLayoutScalar(java.lang.String layout)
How the detector is represented
 

 
Enumeration:

 
point 
 
linear 
 
area 

 


Parameters:
layout - the layout








getCount_time
IDataset getCount_time()
Elapsed actual counting time
 

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

Returns:
the value.








setCount_time
DataNode setCount_time(IDataset count_time)
Elapsed actual counting time
 

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

Parameters:
count_time - the count_time








getCount_timeScalar
java.lang.Number getCount_timeScalar()
Elapsed actual counting time
 

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

Returns:
the value.








setCount_timeScalar
DataNode setCount_timeScalar(java.lang.Number count_time)
Elapsed actual counting time
 

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

Parameters:
count_time - the count_time








getData_file
NXnote getData_file()

Returns:
the value.








setData_file
void setData_file(NXnote data_file)

Parameters:
data_file - the data_file








getCollection
NXcollection getCollection()
Use this group to provide other data related to this NXdetector group.

Returns:
the value.








setCollection
void setCollection(NXcollection collection)
Use this group to provide other data related to this NXdetector group.

Parameters:
collection - the collection








getCollection
NXcollection getCollection(java.lang.String name)
Get a NXcollection node by name:
 

 

 Use this group to provide other data related to this NXdetector group.
 

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








setCollection
void setCollection(java.lang.String name,
                   NXcollection collection)
Set a NXcollection node by name:
 

 

 Use this group to provide other data related to this NXdetector group.
 

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








getAllCollection
java.util.Map<java.lang.String,NXcollection> getAllCollection()
Get all NXcollection nodes:
 

 

 Use this group to provide other data related to this NXdetector group.
 

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








setAllCollection
void setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Set multiple child nodes of a particular type.
 

 

 Use this group to provide other data related to this NXdetector group.
 

Parameters:
collection - the child nodes to add








getSequence_number
IDataset getSequence_number()
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.
 

 Type: NX_INT
 Dimensions: 1: nBrightFrames;
 

Returns:
the value.








setSequence_number
DataNode setSequence_number(IDataset sequence_number)
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.
 

 Type: NX_INT
 Dimensions: 1: nBrightFrames;
 

Parameters:
sequence_number - the sequence_number








getSequence_numberScalar
java.lang.Long getSequence_numberScalar()
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.
 

 Type: NX_INT
 Dimensions: 1: nBrightFrames;
 

Returns:
the value.








setSequence_numberScalar
DataNode setSequence_numberScalar(java.lang.Long sequence_number)
In order to properly sort the order of the images taken in (for
 example) a tomography experiment, a sequence number is stored with each
 image.
 

 Type: NX_INT
 Dimensions: 1: nBrightFrames;
 

Parameters:
sequence_number - the sequence_number








getBeam_center_x
IDataset getBeam_center_x()
This is the x position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeam_center_x
DataNode setBeam_center_x(IDataset beam_center_x)
This is the x position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beam_center_x - the beam_center_x








getBeam_center_xScalar
java.lang.Double getBeam_center_xScalar()
This is the x position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeam_center_xScalar
DataNode setBeam_center_xScalar(java.lang.Double beam_center_x)
This is the x position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beam_center_x - the beam_center_x








getBeam_center_y
IDataset getBeam_center_y()
This is the y position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeam_center_y
DataNode setBeam_center_y(IDataset beam_center_y)
This is the y position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beam_center_y - the beam_center_y








getBeam_center_yScalar
java.lang.Double getBeam_center_yScalar()
This is the y position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeam_center_yScalar
DataNode setBeam_center_yScalar(java.lang.Double beam_center_y)
This is the y position where the direct beam would hit the detector.
 This is a length and can be outside of the actual
 detector. The length can be in physical units or pixels
 as documented by the units attribute.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beam_center_y - the beam_center_y








getFrame_start_number
IDataset getFrame_start_number()
This is the start number of the first frame of a scan. In PX one
 often scans a couple of frames on a give sample, then does something else,
 then returns to the same sample and scans some more frames. Each time with
 a new data file. This number helps concatenating such measurements.
 

 Type: NX_INT
 

Returns:
the value.








setFrame_start_number
DataNode setFrame_start_number(IDataset frame_start_number)
This is the start number of the first frame of a scan. In PX one
 often scans a couple of frames on a give sample, then does something else,
 then returns to the same sample and scans some more frames. Each time with
 a new data file. This number helps concatenating such measurements.
 

 Type: NX_INT
 

Parameters:
frame_start_number - the frame_start_number








getFrame_start_numberScalar
java.lang.Long getFrame_start_numberScalar()
This is the start number of the first frame of a scan. In PX one
 often scans a couple of frames on a give sample, then does something else,
 then returns to the same sample and scans some more frames. Each time with
 a new data file. This number helps concatenating such measurements.
 

 Type: NX_INT
 

Returns:
the value.








setFrame_start_numberScalar
DataNode setFrame_start_numberScalar(java.lang.Long frame_start_number)
This is the start number of the first frame of a scan. In PX one
 often scans a couple of frames on a give sample, then does something else,
 then returns to the same sample and scans some more frames. Each time with
 a new data file. This number helps concatenating such measurements.
 

 Type: NX_INT
 

Parameters:
frame_start_number - the frame_start_number








getDiameter
IDataset getDiameter()
The diameter of a cylindrical detector
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDiameter
DataNode setDiameter(IDataset diameter)
The diameter of a cylindrical detector
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
diameter - the diameter








getDiameterScalar
java.lang.Double getDiameterScalar()
The diameter of a cylindrical detector
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDiameterScalar
DataNode setDiameterScalar(java.lang.Double diameter)
The diameter of a cylindrical detector
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
diameter - the diameter








getAcquisition_mode
IDataset getAcquisition_mode()
The acquisition mode of the detector.
 

 Type: NX_CHAR
 
Enumeration:

 
gated 
 
triggered 
 
summed 
 
event 
 
histogrammed 
 
decimated 

 


Returns:
the value.








setAcquisition_mode
DataNode setAcquisition_mode(IDataset acquisition_mode)
The acquisition mode of the detector.
 

 Type: NX_CHAR
 
Enumeration:

 
gated 
 
triggered 
 
summed 
 
event 
 
histogrammed 
 
decimated 

 


Parameters:
acquisition_mode - the acquisition_mode








getAcquisition_modeScalar
java.lang.String getAcquisition_modeScalar()
The acquisition mode of the detector.
 

 Type: NX_CHAR
 
Enumeration:

 
gated 
 
triggered 
 
summed 
 
event 
 
histogrammed 
 
decimated 

 


Returns:
the value.








setAcquisition_modeScalar
DataNode setAcquisition_modeScalar(java.lang.String acquisition_mode)
The acquisition mode of the detector.
 

 Type: NX_CHAR
 
Enumeration:

 
gated 
 
triggered 
 
summed 
 
event 
 
histogrammed 
 
decimated 

 


Parameters:
acquisition_mode - the acquisition_mode








getAngular_calibration_applied
IDataset getAngular_calibration_applied()
True when the angular calibration has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setAngular_calibration_applied
DataNode setAngular_calibration_applied(IDataset angular_calibration_applied)
True when the angular calibration has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
angular_calibration_applied - the angular_calibration_applied








getAngular_calibration_appliedScalar
java.lang.Boolean getAngular_calibration_appliedScalar()
True when the angular calibration has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setAngular_calibration_appliedScalar
DataNode setAngular_calibration_appliedScalar(java.lang.Boolean angular_calibration_applied)
True when the angular calibration has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
angular_calibration_applied - the angular_calibration_applied








getAngular_calibration
IDataset getAngular_calibration()
Angular calibration data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setAngular_calibration
DataNode setAngular_calibration(IDataset angular_calibration)
Angular calibration data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
angular_calibration - the angular_calibration








getAngular_calibrationScalar
java.lang.Double getAngular_calibrationScalar()
Angular calibration data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setAngular_calibrationScalar
DataNode setAngular_calibrationScalar(java.lang.Double angular_calibration)
Angular calibration data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
angular_calibration - the angular_calibration








getFlatfield_applied
IDataset getFlatfield_applied()
True when the flat field correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setFlatfield_applied
DataNode setFlatfield_applied(IDataset flatfield_applied)
True when the flat field correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
flatfield_applied - the flatfield_applied








getFlatfield_appliedScalar
java.lang.Boolean getFlatfield_appliedScalar()
True when the flat field correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setFlatfield_appliedScalar
DataNode setFlatfield_appliedScalar(java.lang.Boolean flatfield_applied)
True when the flat field correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
flatfield_applied - the flatfield_applied








getFlatfield
IDataset getFlatfield()
Flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setFlatfield
DataNode setFlatfield(IDataset flatfield)
Flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
flatfield - the flatfield








getFlatfieldScalar
java.lang.Double getFlatfieldScalar()
Flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setFlatfieldScalar
DataNode setFlatfieldScalar(java.lang.Double flatfield)
Flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
flatfield - the flatfield








getFlatfield_error
IDataset getFlatfield_error()
Errors of the flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setFlatfield_error
DataNode setFlatfield_error(IDataset flatfield_error)
Errors of the flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
flatfield_error - the flatfield_error








getFlatfield_errorScalar
java.lang.Double getFlatfield_errorScalar()
Errors of the flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setFlatfield_errorScalar
DataNode setFlatfield_errorScalar(java.lang.Double flatfield_error)
Errors of the flat field correction data.
 

 Type: NX_FLOAT
 Dimensions: 1: i; 2: j;
 

Parameters:
flatfield_error - the flatfield_error








getPixel_mask_applied
IDataset getPixel_mask_applied()
True when the pixel mask correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setPixel_mask_applied
DataNode setPixel_mask_applied(IDataset pixel_mask_applied)
True when the pixel mask correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
pixel_mask_applied - the pixel_mask_applied








getPixel_mask_appliedScalar
java.lang.Boolean getPixel_mask_appliedScalar()
True when the pixel mask correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setPixel_mask_appliedScalar
DataNode setPixel_mask_appliedScalar(java.lang.Boolean pixel_mask_applied)
True when the pixel mask correction has been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
pixel_mask_applied - the pixel_mask_applied








getPixel_mask
IDataset getPixel_mask()
The 32-bit pixel mask for the detector.
 Contains a bit field for each pixel to signal dead,
 blind or high or otherwise unwanted or undesirable pixels.
 They have the following meaning:
 .. can't make a table here, a bullet list will have to do for now
 * bit 0: gap (pixel with no sensor)
 * bit 1: dead
 * bit 2: under responding
 * bit 3: over responding
 * bit 4: noisy
 * bit 5: -undefined-
 * bit 6: pixel is part of a cluster of problematic pixels (bit set in addition to others)
 * bit 7: -undefined-
 * bit 8: user defined mask (e.g. around beamstop)
 * bits 9-30: -undefined-
 * bit 31: virtual pixel (corner pixel with interpolated value)
 The normal data analysis software would not take pixels into
 account when a bit in (mask & 0x00FF) is set.
 Tag bit in the upper two bytes would indicate special pixel
 properties that normally would not be a sole reason to
 reject the intensity value (unless lower bits are also set).
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setPixel_mask
DataNode setPixel_mask(IDataset pixel_mask)
The 32-bit pixel mask for the detector.
 Contains a bit field for each pixel to signal dead,
 blind or high or otherwise unwanted or undesirable pixels.
 They have the following meaning:
 .. can't make a table here, a bullet list will have to do for now
 * bit 0: gap (pixel with no sensor)
 * bit 1: dead
 * bit 2: under responding
 * bit 3: over responding
 * bit 4: noisy
 * bit 5: -undefined-
 * bit 6: pixel is part of a cluster of problematic pixels (bit set in addition to others)
 * bit 7: -undefined-
 * bit 8: user defined mask (e.g. around beamstop)
 * bits 9-30: -undefined-
 * bit 31: virtual pixel (corner pixel with interpolated value)
 The normal data analysis software would not take pixels into
 account when a bit in (mask & 0x00FF) is set.
 Tag bit in the upper two bytes would indicate special pixel
 properties that normally would not be a sole reason to
 reject the intensity value (unless lower bits are also set).
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
pixel_mask - the pixel_mask








getPixel_maskScalar
java.lang.Long getPixel_maskScalar()
The 32-bit pixel mask for the detector.
 Contains a bit field for each pixel to signal dead,
 blind or high or otherwise unwanted or undesirable pixels.
 They have the following meaning:
 .. can't make a table here, a bullet list will have to do for now
 * bit 0: gap (pixel with no sensor)
 * bit 1: dead
 * bit 2: under responding
 * bit 3: over responding
 * bit 4: noisy
 * bit 5: -undefined-
 * bit 6: pixel is part of a cluster of problematic pixels (bit set in addition to others)
 * bit 7: -undefined-
 * bit 8: user defined mask (e.g. around beamstop)
 * bits 9-30: -undefined-
 * bit 31: virtual pixel (corner pixel with interpolated value)
 The normal data analysis software would not take pixels into
 account when a bit in (mask & 0x00FF) is set.
 Tag bit in the upper two bytes would indicate special pixel
 properties that normally would not be a sole reason to
 reject the intensity value (unless lower bits are also set).
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Returns:
the value.








setPixel_maskScalar
DataNode setPixel_maskScalar(java.lang.Long pixel_mask)
The 32-bit pixel mask for the detector.
 Contains a bit field for each pixel to signal dead,
 blind or high or otherwise unwanted or undesirable pixels.
 They have the following meaning:
 .. can't make a table here, a bullet list will have to do for now
 * bit 0: gap (pixel with no sensor)
 * bit 1: dead
 * bit 2: under responding
 * bit 3: over responding
 * bit 4: noisy
 * bit 5: -undefined-
 * bit 6: pixel is part of a cluster of problematic pixels (bit set in addition to others)
 * bit 7: -undefined-
 * bit 8: user defined mask (e.g. around beamstop)
 * bits 9-30: -undefined-
 * bit 31: virtual pixel (corner pixel with interpolated value)
 The normal data analysis software would not take pixels into
 account when a bit in (mask & 0x00FF) is set.
 Tag bit in the upper two bytes would indicate special pixel
 properties that normally would not be a sole reason to
 reject the intensity value (unless lower bits are also set).
 

 Type: NX_INT
 Dimensions: 1: i; 2: j;
 

Parameters:
pixel_mask - the pixel_mask








getCountrate_correction__applied
IDataset getCountrate_correction__applied()
True when a count-rate correction has already been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCountrate_correction__applied
DataNode setCountrate_correction__applied(IDataset countrate_correction__applied)
True when a count-rate correction has already been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
countrate_correction__applied - the countrate_correction__applied








getCountrate_correction__appliedScalar
java.lang.Boolean getCountrate_correction__appliedScalar()
True when a count-rate correction has already been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCountrate_correction__appliedScalar
DataNode setCountrate_correction__appliedScalar(java.lang.Boolean countrate_correction__applied)
True when a count-rate correction has already been applied in the
 electronics, false otherwise.
 

 Type: NX_BOOLEAN
 

Parameters:
countrate_correction__applied - the countrate_correction__applied








getBit_depth_readout
IDataset getBit_depth_readout()
How many bits the electronics reads per pixel.
 With CCD's and single photon counting detectors,
 this must not align with traditional integer sizes.
 This can be 4, 8, 12, 14, 16, ...
 

 Type: NX_INT
 

Returns:
the value.








setBit_depth_readout
DataNode setBit_depth_readout(IDataset bit_depth_readout)
How many bits the electronics reads per pixel.
 With CCD's and single photon counting detectors,
 this must not align with traditional integer sizes.
 This can be 4, 8, 12, 14, 16, ...
 

 Type: NX_INT
 

Parameters:
bit_depth_readout - the bit_depth_readout








getBit_depth_readoutScalar
java.lang.Long getBit_depth_readoutScalar()
How many bits the electronics reads per pixel.
 With CCD's and single photon counting detectors,
 this must not align with traditional integer sizes.
 This can be 4, 8, 12, 14, 16, ...
 

 Type: NX_INT
 

Returns:
the value.








setBit_depth_readoutScalar
DataNode setBit_depth_readoutScalar(java.lang.Long bit_depth_readout)
How many bits the electronics reads per pixel.
 With CCD's and single photon counting detectors,
 this must not align with traditional integer sizes.
 This can be 4, 8, 12, 14, 16, ...
 

 Type: NX_INT
 

Parameters:
bit_depth_readout - the bit_depth_readout








getDetector_readout_time
IDataset getDetector_readout_time()
Time it takes to read the detector (typically milliseconds).
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setDetector_readout_time
DataNode setDetector_readout_time(IDataset detector_readout_time)
Time it takes to read the detector (typically milliseconds).
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
detector_readout_time - the detector_readout_time








getDetector_readout_timeScalar
java.lang.Double getDetector_readout_timeScalar()
Time it takes to read the detector (typically milliseconds).
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setDetector_readout_timeScalar
DataNode setDetector_readout_timeScalar(java.lang.Double detector_readout_time)
Time it takes to read the detector (typically milliseconds).
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
detector_readout_time - the detector_readout_time








getTrigger_delay_time
IDataset getTrigger_delay_time()
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector firmware after receiving the trigger signal
 to when the detector starts to acquire the exposure, including any user set delay..
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_delay_time
DataNode setTrigger_delay_time(IDataset trigger_delay_time)
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector firmware after receiving the trigger signal
 to when the detector starts to acquire the exposure, including any user set delay..
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_delay_time - the trigger_delay_time








getTrigger_delay_timeScalar
java.lang.Double getTrigger_delay_timeScalar()
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector firmware after receiving the trigger signal
 to when the detector starts to acquire the exposure, including any user set delay..
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_delay_timeScalar
DataNode setTrigger_delay_timeScalar(java.lang.Double trigger_delay_time)
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector firmware after receiving the trigger signal
 to when the detector starts to acquire the exposure, including any user set delay..
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_delay_time - the trigger_delay_time








getTrigger_delay_time_set
IDataset getTrigger_delay_time_set()
User-specified trigger delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_delay_time_set
DataNode setTrigger_delay_time_set(IDataset trigger_delay_time_set)
User-specified trigger delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_delay_time_set - the trigger_delay_time_set








getTrigger_delay_time_setScalar
java.lang.Double getTrigger_delay_time_setScalar()
User-specified trigger delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_delay_time_setScalar
DataNode setTrigger_delay_time_setScalar(java.lang.Double trigger_delay_time_set)
User-specified trigger delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_delay_time_set - the trigger_delay_time_set








getTrigger_internal_delay_time
IDataset getTrigger_internal_delay_time()
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector hardware after receiving the
 trigger signal to when the detector starts to acquire the exposure.
 It forms the lower boundary of the trigger_delay_time when the user
 does not request an additional delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_internal_delay_time
DataNode setTrigger_internal_delay_time(IDataset trigger_internal_delay_time)
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector hardware after receiving the
 trigger signal to when the detector starts to acquire the exposure.
 It forms the lower boundary of the trigger_delay_time when the user
 does not request an additional delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_internal_delay_time - the trigger_internal_delay_time








getTrigger_internal_delay_timeScalar
java.lang.Double getTrigger_internal_delay_timeScalar()
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector hardware after receiving the
 trigger signal to when the detector starts to acquire the exposure.
 It forms the lower boundary of the trigger_delay_time when the user
 does not request an additional delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_internal_delay_timeScalar
DataNode setTrigger_internal_delay_timeScalar(java.lang.Double trigger_internal_delay_time)
Time it takes to start exposure after a trigger signal has been received.
 This is the reaction time of the detector hardware after receiving the
 trigger signal to when the detector starts to acquire the exposure.
 It forms the lower boundary of the trigger_delay_time when the user
 does not request an additional delay.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_internal_delay_time - the trigger_internal_delay_time








getTrigger_dead_time
IDataset getTrigger_dead_time()
Time during which no new trigger signal can be accepted.
 Typically this is the
 trigger_delay_time + exposure_time + readout_time.
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_dead_time
DataNode setTrigger_dead_time(IDataset trigger_dead_time)
Time during which no new trigger signal can be accepted.
 Typically this is the
 trigger_delay_time + exposure_time + readout_time.
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_dead_time - the trigger_dead_time








getTrigger_dead_timeScalar
java.lang.Double getTrigger_dead_timeScalar()
Time during which no new trigger signal can be accepted.
 Typically this is the
 trigger_delay_time + exposure_time + readout_time.
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setTrigger_dead_timeScalar
DataNode setTrigger_dead_timeScalar(java.lang.Double trigger_dead_time)
Time during which no new trigger signal can be accepted.
 Typically this is the
 trigger_delay_time + exposure_time + readout_time.
 This is important to know for time resolved experiments.
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
trigger_dead_time - the trigger_dead_time








getFrame_time
IDataset getFrame_time()
This is time for each frame. This is exposure_time + readout time.
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: NP;
 

Returns:
the value.








setFrame_time
DataNode setFrame_time(IDataset frame_time)
This is time for each frame. This is exposure_time + readout time.
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: NP;
 

Parameters:
frame_time - the frame_time








getFrame_timeScalar
java.lang.Double getFrame_timeScalar()
This is time for each frame. This is exposure_time + readout time.
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: NP;
 

Returns:
the value.








setFrame_timeScalar
DataNode setFrame_timeScalar(java.lang.Double frame_time)
This is time for each frame. This is exposure_time + readout time.
 

 Type: NX_FLOAT
 Units: NX_TIME
 Dimensions: 1: NP;
 

Parameters:
frame_time - the frame_time








getGain_setting
IDataset getGain_setting()
The gain setting of the detector. This influences background etc.
 

 Type: NX_CHAR
 
Enumeration:

 
high 
 
standard 
 
fast 
 
auto 

 


Returns:
the value.








setGain_setting
DataNode setGain_setting(IDataset gain_setting)
The gain setting of the detector. This influences background etc.
 

 Type: NX_CHAR
 
Enumeration:

 
high 
 
standard 
 
fast 
 
auto 

 


Parameters:
gain_setting - the gain_setting








getGain_settingScalar
java.lang.String getGain_settingScalar()
The gain setting of the detector. This influences background etc.
 

 Type: NX_CHAR
 
Enumeration:

 
high 
 
standard 
 
fast 
 
auto 

 


Returns:
the value.








setGain_settingScalar
DataNode setGain_settingScalar(java.lang.String gain_setting)
The gain setting of the detector. This influences background etc.
 

 Type: NX_CHAR
 
Enumeration:

 
high 
 
standard 
 
fast 
 
auto 

 


Parameters:
gain_setting - the gain_setting








getSaturation_value
IDataset getSaturation_value()
The value at which the detector goes into saturation.
 Especially common to CCD detectors, the data
 is known to be invalid above this value.
 

 Type: NX_INT
 

Returns:
the value.








setSaturation_value
DataNode setSaturation_value(IDataset saturation_value)
The value at which the detector goes into saturation.
 Especially common to CCD detectors, the data
 is known to be invalid above this value.
 

 Type: NX_INT
 

Parameters:
saturation_value - the saturation_value








getSaturation_valueScalar
java.lang.Long getSaturation_valueScalar()
The value at which the detector goes into saturation.
 Especially common to CCD detectors, the data
 is known to be invalid above this value.
 

 Type: NX_INT
 

Returns:
the value.








setSaturation_valueScalar
DataNode setSaturation_valueScalar(java.lang.Long saturation_value)
The value at which the detector goes into saturation.
 Especially common to CCD detectors, the data
 is known to be invalid above this value.
 

 Type: NX_INT
 

Parameters:
saturation_value - the saturation_value








getNumber_of_cycles
IDataset getNumber_of_cycles()
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics. This reduces background etc.
 This is the number of short exposures used to sum
 images for an image.
 

 Type: NX_INT
 

Returns:
the value.








setNumber_of_cycles
DataNode setNumber_of_cycles(IDataset number_of_cycles)
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics. This reduces background etc.
 This is the number of short exposures used to sum
 images for an image.
 

 Type: NX_INT
 

Parameters:
number_of_cycles - the number_of_cycles








getNumber_of_cyclesScalar
java.lang.Long getNumber_of_cyclesScalar()
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics. This reduces background etc.
 This is the number of short exposures used to sum
 images for an image.
 

 Type: NX_INT
 

Returns:
the value.








setNumber_of_cyclesScalar
DataNode setNumber_of_cyclesScalar(java.lang.Long number_of_cycles)
CCD images are sometimes constructed by summing
 together multiple short exposures in the
 electronics. This reduces background etc.
 This is the number of short exposures used to sum
 images for an image.
 

 Type: NX_INT
 

Parameters:
number_of_cycles - the number_of_cycles








getSensor_material
IDataset getSensor_material()
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the name of this converter material.
 

 Type: NX_CHAR
 

Returns:
the value.








setSensor_material
DataNode setSensor_material(IDataset sensor_material)
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the name of this converter material.
 

 Type: NX_CHAR
 

Parameters:
sensor_material - the sensor_material








getSensor_materialScalar
java.lang.String getSensor_materialScalar()
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the name of this converter material.
 

 Type: NX_CHAR
 

Returns:
the value.








setSensor_materialScalar
DataNode setSensor_materialScalar(java.lang.String sensor_material)
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the name of this converter material.
 

 Type: NX_CHAR
 

Parameters:
sensor_material - the sensor_material








getSensor_thickness
IDataset getSensor_thickness()
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the thickness of this converter material.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSensor_thickness
DataNode setSensor_thickness(IDataset sensor_thickness)
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the thickness of this converter material.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sensor_thickness - the sensor_thickness








getSensor_thicknessScalar
java.lang.Double getSensor_thicknessScalar()
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the thickness of this converter material.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSensor_thicknessScalar
DataNode setSensor_thicknessScalar(java.lang.Double sensor_thickness)
At times, radiation is not directly sensed by the detector.
 Rather, the detector might sense the output from some
 converter like a scintillator.
 This is the thickness of this converter material.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sensor_thickness - the sensor_thickness








getThreshold_energy
IDataset getThreshold_energy()
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally. This is the energy setting for this.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setThreshold_energy
DataNode setThreshold_energy(IDataset threshold_energy)
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally. This is the energy setting for this.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
threshold_energy - the threshold_energy








getThreshold_energyScalar
java.lang.Double getThreshold_energyScalar()
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally. This is the energy setting for this.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setThreshold_energyScalar
DataNode setThreshold_energyScalar(java.lang.Double threshold_energy)
Single photon counter detectors can be adjusted
 for a certain energy range in which they
 work optimally. This is the energy setting for this.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
threshold_energy - the threshold_energy








getDetector_module
NXdetector_module getDetector_module()
For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.

Returns:
the value.








setDetector_module
void setDetector_module(NXdetector_module detector_module)
For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.

Parameters:
detector_module - the detector_module








getDetector_module
NXdetector_module getDetector_module(java.lang.String name)
Get a NXdetector_module node by name:
 

 

 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.
 

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








setDetector_module
void setDetector_module(java.lang.String name,
                        NXdetector_module detector_module)
Set a NXdetector_module node by name:
 

 

 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.
 

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








getAllDetector_module
java.util.Map<java.lang.String,NXdetector_module> getAllDetector_module()
Get all NXdetector_module nodes:
 

 

 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.
 

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








setAllDetector_module
void setAllDetector_module(java.util.Map<java.lang.String,NXdetector_module> detector_module)
Set multiple child nodes of a particular type.
 

 

 For use in special cases where the data in NXdetector
 is represented in several parts, each with a separate geometry.
 Use one or more instances of the NXdetector_module
 group to declare regions of interest or some other
 subdivision of a detector.
 

Parameters:
detector_module - the child nodes to add














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