generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXdetectorImpl.html Maven / Gradle / Ivy
NXdetectorImpl (h5jan API)
org.eclipse.dawnsci.nexus.impl
Class NXdetectorImpl
- java.lang.Object
-
- org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
-
- org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
-
- org.eclipse.dawnsci.nexus.impl.NXobjectImpl
-
- org.eclipse.dawnsci.nexus.impl.NXdetectorImpl
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXdetector, NXobject
public class NXdetectorImpl
extends NXobjectImpl
implements NXdetector
A detector, detector bank, or multidetector.
- See Also:
- Serialized Form
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES
-
Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS
-
Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT
-
Fields inherited from interface org.eclipse.dawnsci.nexus.NXdetector
NX_ACQUISITION_MODE, NX_ANGULAR_CALIBRATION, NX_ANGULAR_CALIBRATION_APPLIED, NX_AZIMUTHAL_ANGLE, NX_BEAM_CENTER_X, NX_BEAM_CENTER_Y, NX_BIT_DEPTH_READOUT, NX_CALIBRATION_DATE, NX_COUNT_TIME, NX_COUNTRATE_CORRECTION__APPLIED, NX_CRATE, NX_CRATE_ATTRIBUTE_LOCAL_NAME, NX_DATA, NX_DATA_ATTRIBUTE_CHECK_SUM, NX_DATA_ATTRIBUTE_LONG_NAME, NX_DATA_ERROR, NX_DEAD_TIME, NX_DESCRIPTION, NX_DETECTION_GAS_PATH, NX_DETECTOR_NUMBER, NX_DETECTOR_READOUT_TIME, NX_DIAMETER, NX_DISTANCE, NX_FLATFIELD, NX_FLATFIELD_APPLIED, NX_FLATFIELD_ERROR, NX_FRAME_START_NUMBER, NX_FRAME_TIME, NX_GAIN_SETTING, NX_GAS_PRESSURE, NX_INPUT, NX_INPUT_ATTRIBUTE_LOCAL_NAME, NX_LAYOUT, NX_LOCAL_NAME, NX_NUMBER_OF_CYCLES, NX_PIXEL_MASK, NX_PIXEL_MASK_APPLIED, NX_POLAR_ANGLE, NX_RAW_TIME_OF_FLIGHT, NX_RAW_TIME_OF_FLIGHT_ATTRIBUTE_FREQUENCY, NX_SATURATION_VALUE, NX_SENSOR_MATERIAL, NX_SENSOR_THICKNESS, NX_SEQUENCE_NUMBER, NX_SERIAL_NUMBER, NX_SLOT, NX_SLOT_ATTRIBUTE_LOCAL_NAME, NX_SOLID_ANGLE, NX_THRESHOLD_ENERGY, NX_TIME_OF_FLIGHT, NX_TIME_OF_FLIGHT_ATTRIBUTE_AXIS, NX_TIME_OF_FLIGHT_ATTRIBUTE_LONG_NAME, NX_TIME_OF_FLIGHT_ATTRIBUTE_PRIMARY, NX_TRIGGER_DEAD_TIME, NX_TRIGGER_DELAY_TIME, NX_TRIGGER_DELAY_TIME_SET, NX_TRIGGER_INTERNAL_DELAY_TIME, NX_TYPE, NX_X_PIXEL_OFFSET, NX_X_PIXEL_OFFSET_ATTRIBUTE_AXIS, NX_X_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME, NX_X_PIXEL_OFFSET_ATTRIBUTE_PRIMARY, NX_X_PIXEL_SIZE, NX_Y_PIXEL_OFFSET, NX_Y_PIXEL_OFFSET_ATTRIBUTE_AXIS, NX_Y_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME, NX_Y_PIXEL_OFFSET_ATTRIBUTE_PRIMARY, NX_Y_PIXEL_SIZE, NX_Z_PIXEL_OFFSET, NX_Z_PIXEL_OFFSET_ATTRIBUTE_AXIS, NX_Z_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME, NX_Z_PIXEL_OFFSET_ATTRIBUTE_PRIMARY
-
Constructor Summary
Constructors
Constructor and Description
NXdetectorImpl()
NXdetectorImpl(long oid)
-
Method Summary
All Methods Instance Methods Concrete 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
NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass
for this base class, e.g.
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.
java.lang.Class<? extends NXobject>
getNXclass()
Java Class
object of the interface for this base class, e.g.
java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass
constants for the permitted child group types
of this base class.
IDataset
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.
java.lang.String
getTime_of_flightAttributeLong_name()
Total time of flight
java.lang.Long
getTime_of_flightAttributePrimary()
Deprecated.
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.
java.lang.String
getX_pixel_offsetAttributeLong_name()
x-axis offset from detector center
java.lang.Long
getX_pixel_offsetAttributePrimary()
Deprecated.
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.
java.lang.String
getY_pixel_offsetAttributeLong_name()
y-axis offset from detector center
java.lang.Long
getY_pixel_offsetAttributePrimary()
Deprecated.
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.
java.lang.String
getZ_pixel_offsetAttributeLong_name()
y-axis offset from detector center
java.lang.Long
getZ_pixel_offsetAttributePrimary()
Deprecated.
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.
void
setTime_of_flightAttributeLong_name(java.lang.String long_name)
Total time of flight
void
setTime_of_flightAttributePrimary(java.lang.Long primary)
Deprecated.
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.
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.
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.
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.
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.
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.
DataNode
setZ_pixel_offsetScalar(java.lang.Double z_pixel_offset)
Offset from the detector center in the z-direction.
-
Methods inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString
-
Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString
-
Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode
-
-
Field Detail
-
PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES
-
Constructor Detail
-
NXdetectorImpl
public NXdetectorImpl()
-
NXdetectorImpl
public NXdetectorImpl(long oid)
-
Method Detail
-
getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class
object of the interface for this base class, e.g. NXsample
.class.
- Specified by:
getNXclass
in interface NXobject
- Returns:
- name of Nexus class
-
getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass
for this base class, e.g. NexusBaseClass.NX_SAMPLE
.
- Specified by:
getNexusBaseClass
in interface NXobject
- Returns:
NexusBaseClass
enum constant for this class
-
getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass
constants for the permitted child group types
of this base class.
- Specified by:
getPermittedChildGroupClasses
in interface NXobject
- Returns:
NexusBaseClass
constants for permitted child groups
-
getTime_of_flight
public IDataset getTime_of_flight()
Description copied from interface: NXdetector
Total time of flight
Type: NX_FLOAT
Units: NX_TIME_OF_FLIGHT
Dimensions: 1: tof+1;
- Specified by:
getTime_of_flight
in interface NXdetector
- Returns:
- the value.
-
getTime_of_flightScalar
public java.lang.Double getTime_of_flightScalar()
Description copied from interface: NXdetector
Total time of flight
Type: NX_FLOAT
Units: NX_TIME_OF_FLIGHT
Dimensions: 1: tof+1;
- Specified by:
getTime_of_flightScalar
in interface NXdetector
- Returns:
- the value.
-
setTime_of_flight
public DataNode setTime_of_flight(IDataset time_of_flight)
Description copied from interface: NXdetector
Total time of flight
Type: NX_FLOAT
Units: NX_TIME_OF_FLIGHT
Dimensions: 1: tof+1;
- Specified by:
setTime_of_flight
in interface NXdetector
- Parameters:
time_of_flight
- the time_of_flight
-
setTime_of_flightScalar
public DataNode setTime_of_flightScalar(java.lang.Double time_of_flight)
Description copied from interface: NXdetector
Total time of flight
Type: NX_FLOAT
Units: NX_TIME_OF_FLIGHT
Dimensions: 1: tof+1;
- Specified by:
setTime_of_flightScalar
in interface NXdetector
- Parameters:
time_of_flight
- the time_of_flight
-
getTime_of_flightAttributeAxis
@Deprecated
public java.lang.Long getTime_of_flightAttributeAxis()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 3
- Specified by:
getTime_of_flightAttributeAxis
in interface NXdetector
- Returns:
- the value.
-
setTime_of_flightAttributeAxis
@Deprecated
public void setTime_of_flightAttributeAxis(java.lang.Long axis)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 3
- Specified by:
setTime_of_flightAttributeAxis
in interface NXdetector
- Parameters:
axis
- the axis
-
getTime_of_flightAttributePrimary
@Deprecated
public java.lang.Long getTime_of_flightAttributePrimary()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
getTime_of_flightAttributePrimary
in interface NXdetector
- Returns:
- the value.
-
setTime_of_flightAttributePrimary
@Deprecated
public void setTime_of_flightAttributePrimary(java.lang.Long primary)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
setTime_of_flightAttributePrimary
in interface NXdetector
- Parameters:
primary
- the primary
-
getTime_of_flightAttributeLong_name
public java.lang.String getTime_of_flightAttributeLong_name()
Description copied from interface: NXdetector
Total time of flight
- Specified by:
getTime_of_flightAttributeLong_name
in interface NXdetector
- Returns:
- the value.
-
setTime_of_flightAttributeLong_name
public void setTime_of_flightAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdetector
Total time of flight
- Specified by:
setTime_of_flightAttributeLong_name
in interface NXdetector
- Parameters:
long_name
- the long_name
-
getRaw_time_of_flight
public IDataset getRaw_time_of_flight()
Description copied from interface: NXdetector
In DAQ clock pulses
Type: NX_INT
Units: NX_PULSES
Dimensions: 1: tof+1;
- Specified by:
getRaw_time_of_flight
in interface NXdetector
- Returns:
- the value.
-
getRaw_time_of_flightScalar
public java.lang.Long getRaw_time_of_flightScalar()
Description copied from interface: NXdetector
In DAQ clock pulses
Type: NX_INT
Units: NX_PULSES
Dimensions: 1: tof+1;
- Specified by:
getRaw_time_of_flightScalar
in interface NXdetector
- Returns:
- the value.
-
setRaw_time_of_flight
public DataNode setRaw_time_of_flight(IDataset raw_time_of_flight)
Description copied from interface: NXdetector
In DAQ clock pulses
Type: NX_INT
Units: NX_PULSES
Dimensions: 1: tof+1;
- Specified by:
setRaw_time_of_flight
in interface NXdetector
- Parameters:
raw_time_of_flight
- the raw_time_of_flight
-
setRaw_time_of_flightScalar
public DataNode setRaw_time_of_flightScalar(java.lang.Long raw_time_of_flight)
Description copied from interface: NXdetector
In DAQ clock pulses
Type: NX_INT
Units: NX_PULSES
Dimensions: 1: tof+1;
- Specified by:
setRaw_time_of_flightScalar
in interface NXdetector
- Parameters:
raw_time_of_flight
- the raw_time_of_flight
-
getRaw_time_of_flightAttributeFrequency
public java.lang.Number getRaw_time_of_flightAttributeFrequency()
Description copied from interface: NXdetector
Clock frequency in Hz
- Specified by:
getRaw_time_of_flightAttributeFrequency
in interface NXdetector
- Returns:
- the value.
-
setRaw_time_of_flightAttributeFrequency
public void setRaw_time_of_flightAttributeFrequency(java.lang.Number frequency)
Description copied from interface: NXdetector
Clock frequency in Hz
- Specified by:
setRaw_time_of_flightAttributeFrequency
in interface NXdetector
- Parameters:
frequency
- the frequency
-
getDetector_number
public IDataset getDetector_number()
Description copied from interface: NXdetector
Identifier for detector (pixels)
Can be multidimensional, if needed
Type: NX_INT
- Specified by:
getDetector_number
in interface NXdetector
- Returns:
- the value.
-
getDetector_numberScalar
public java.lang.Long getDetector_numberScalar()
Description copied from interface: NXdetector
Identifier for detector (pixels)
Can be multidimensional, if needed
Type: NX_INT
- Specified by:
getDetector_numberScalar
in interface NXdetector
- Returns:
- the value.
-
setDetector_number
public DataNode setDetector_number(IDataset detector_number)
Description copied from interface: NXdetector
Identifier for detector (pixels)
Can be multidimensional, if needed
Type: NX_INT
- Specified by:
setDetector_number
in interface NXdetector
- Parameters:
detector_number
- the detector_number
-
setDetector_numberScalar
public DataNode setDetector_numberScalar(java.lang.Long detector_number)
Description copied from interface: NXdetector
Identifier for detector (pixels)
Can be multidimensional, if needed
Type: NX_INT
- Specified by:
setDetector_numberScalar
in interface NXdetector
- Parameters:
detector_number
- the detector_number
-
getData
public IDataset getData()
Description copied from interface: NXdetector
Data values from the detector.
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: np; 2: i; 3: j; 4: tof;
- Specified by:
getData
in interface NXdetector
- Returns:
- the value.
-
getDataScalar
public java.lang.Number getDataScalar()
Description copied from interface: NXdetector
Data values from the detector.
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: np; 2: i; 3: j; 4: tof;
- Specified by:
getDataScalar
in interface NXdetector
- Returns:
- the value.
-
setData
public DataNode setData(IDataset data)
Description copied from interface: NXdetector
Data values from the detector.
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: np; 2: i; 3: j; 4: tof;
- Specified by:
setData
in interface NXdetector
- Parameters:
data
- the data
-
setDataScalar
public DataNode setDataScalar(java.lang.Number data)
Description copied from interface: NXdetector
Data values from the detector.
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: np; 2: i; 3: j; 4: tof;
- Specified by:
setDataScalar
in interface NXdetector
- Parameters:
data
- the data
-
getDataAttributeLong_name
public java.lang.String getDataAttributeLong_name()
Description copied from interface: NXdetector
Title of measurement
- Specified by:
getDataAttributeLong_name
in interface NXdetector
- Returns:
- the value.
-
setDataAttributeLong_name
public void setDataAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdetector
Title of measurement
- Specified by:
setDataAttributeLong_name
in interface NXdetector
- Parameters:
long_name
- the long_name
-
getDataAttributeCheck_sum
public java.lang.Long getDataAttributeCheck_sum()
Description copied from interface: NXdetector
Integral of data as check of data integrity
- Specified by:
getDataAttributeCheck_sum
in interface NXdetector
- Returns:
- the value.
-
setDataAttributeCheck_sum
public void setDataAttributeCheck_sum(java.lang.Long check_sum)
Description copied from interface: NXdetector
Integral of data as check of data integrity
- Specified by:
setDataAttributeCheck_sum
in interface NXdetector
- Parameters:
check_sum
- the check_sum
-
getData_error
public IDataset getData_error()
Description copied from interface: NXdetector
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;
- Specified by:
getData_error
in interface NXdetector
- Returns:
- the value.
-
getData_errorScalar
public java.lang.Number getData_errorScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getData_errorScalar
in interface NXdetector
- Returns:
- the value.
-
setData_error
public DataNode setData_error(IDataset data_error)
Description copied from interface: NXdetector
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;
- Specified by:
setData_error
in interface NXdetector
- Parameters:
data_error
- the data_error
-
setData_errorScalar
public DataNode setData_errorScalar(java.lang.Number data_error)
Description copied from interface: NXdetector
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;
- Specified by:
setData_errorScalar
in interface NXdetector
- Parameters:
data_error
- the data_error
-
getX_pixel_offset
public IDataset getX_pixel_offset()
Description copied from interface: NXdetector
Offset from the detector center in x-direction.
Can be multidimensional when needed.
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getX_pixel_offset
in interface NXdetector
- Returns:
- the value.
-
getX_pixel_offsetScalar
public java.lang.Double getX_pixel_offsetScalar()
Description copied from interface: NXdetector
Offset from the detector center in x-direction.
Can be multidimensional when needed.
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getX_pixel_offsetScalar
in interface NXdetector
- Returns:
- the value.
-
setX_pixel_offset
public DataNode setX_pixel_offset(IDataset x_pixel_offset)
Description copied from interface: NXdetector
Offset from the detector center in x-direction.
Can be multidimensional when needed.
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setX_pixel_offset
in interface NXdetector
- Parameters:
x_pixel_offset
- the x_pixel_offset
-
setX_pixel_offsetScalar
public DataNode setX_pixel_offsetScalar(java.lang.Double x_pixel_offset)
Description copied from interface: NXdetector
Offset from the detector center in x-direction.
Can be multidimensional when needed.
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setX_pixel_offsetScalar
in interface NXdetector
- Parameters:
x_pixel_offset
- the x_pixel_offset
-
getX_pixel_offsetAttributeAxis
@Deprecated
public java.lang.Long getX_pixel_offsetAttributeAxis()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
getX_pixel_offsetAttributeAxis
in interface NXdetector
- Returns:
- the value.
-
setX_pixel_offsetAttributeAxis
@Deprecated
public void setX_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
setX_pixel_offsetAttributeAxis
in interface NXdetector
- Parameters:
axis
- the axis
-
getX_pixel_offsetAttributePrimary
@Deprecated
public java.lang.Long getX_pixel_offsetAttributePrimary()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
getX_pixel_offsetAttributePrimary
in interface NXdetector
- Returns:
- the value.
-
setX_pixel_offsetAttributePrimary
@Deprecated
public void setX_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
setX_pixel_offsetAttributePrimary
in interface NXdetector
- Parameters:
primary
- the primary
-
getX_pixel_offsetAttributeLong_name
public java.lang.String getX_pixel_offsetAttributeLong_name()
Description copied from interface: NXdetector
x-axis offset from detector center
- Specified by:
getX_pixel_offsetAttributeLong_name
in interface NXdetector
- Returns:
- the value.
-
setX_pixel_offsetAttributeLong_name
public void setX_pixel_offsetAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdetector
x-axis offset from detector center
- Specified by:
setX_pixel_offsetAttributeLong_name
in interface NXdetector
- Parameters:
long_name
- the long_name
-
getY_pixel_offset
public IDataset getY_pixel_offset()
Description copied from interface: NXdetector
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
- Specified by:
getY_pixel_offset
in interface NXdetector
- Returns:
- the value.
-
getY_pixel_offsetScalar
public java.lang.Double getY_pixel_offsetScalar()
Description copied from interface: NXdetector
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
- Specified by:
getY_pixel_offsetScalar
in interface NXdetector
- Returns:
- the value.
-
setY_pixel_offset
public DataNode setY_pixel_offset(IDataset y_pixel_offset)
Description copied from interface: NXdetector
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
- Specified by:
setY_pixel_offset
in interface NXdetector
- Parameters:
y_pixel_offset
- the y_pixel_offset
-
setY_pixel_offsetScalar
public DataNode setY_pixel_offsetScalar(java.lang.Double y_pixel_offset)
Description copied from interface: NXdetector
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
- Specified by:
setY_pixel_offsetScalar
in interface NXdetector
- Parameters:
y_pixel_offset
- the y_pixel_offset
-
getY_pixel_offsetAttributeAxis
@Deprecated
public java.lang.Long getY_pixel_offsetAttributeAxis()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 2
- Specified by:
getY_pixel_offsetAttributeAxis
in interface NXdetector
- Returns:
- the value.
-
setY_pixel_offsetAttributeAxis
@Deprecated
public void setY_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 2
- Specified by:
setY_pixel_offsetAttributeAxis
in interface NXdetector
- Parameters:
axis
- the axis
-
getY_pixel_offsetAttributePrimary
@Deprecated
public java.lang.Long getY_pixel_offsetAttributePrimary()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
getY_pixel_offsetAttributePrimary
in interface NXdetector
- Returns:
- the value.
-
setY_pixel_offsetAttributePrimary
@Deprecated
public void setY_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
setY_pixel_offsetAttributePrimary
in interface NXdetector
- Parameters:
primary
- the primary
-
getY_pixel_offsetAttributeLong_name
public java.lang.String getY_pixel_offsetAttributeLong_name()
Description copied from interface: NXdetector
y-axis offset from detector center
- Specified by:
getY_pixel_offsetAttributeLong_name
in interface NXdetector
- Returns:
- the value.
-
setY_pixel_offsetAttributeLong_name
public void setY_pixel_offsetAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdetector
y-axis offset from detector center
- Specified by:
setY_pixel_offsetAttributeLong_name
in interface NXdetector
- Parameters:
long_name
- the long_name
-
getZ_pixel_offset
public IDataset getZ_pixel_offset()
Description copied from interface: NXdetector
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
- Specified by:
getZ_pixel_offset
in interface NXdetector
- Returns:
- the value.
-
getZ_pixel_offsetScalar
public java.lang.Double getZ_pixel_offsetScalar()
Description copied from interface: NXdetector
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
- Specified by:
getZ_pixel_offsetScalar
in interface NXdetector
- Returns:
- the value.
-
setZ_pixel_offset
public DataNode setZ_pixel_offset(IDataset z_pixel_offset)
Description copied from interface: NXdetector
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
- Specified by:
setZ_pixel_offset
in interface NXdetector
- Parameters:
z_pixel_offset
- the z_pixel_offset
-
setZ_pixel_offsetScalar
public DataNode setZ_pixel_offsetScalar(java.lang.Double z_pixel_offset)
Description copied from interface: NXdetector
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
- Specified by:
setZ_pixel_offsetScalar
in interface NXdetector
- Parameters:
z_pixel_offset
- the z_pixel_offset
-
getZ_pixel_offsetAttributeAxis
@Deprecated
public java.lang.Long getZ_pixel_offsetAttributeAxis()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 3
- Specified by:
getZ_pixel_offsetAttributeAxis
in interface NXdetector
- Returns:
- the value.
-
setZ_pixel_offsetAttributeAxis
@Deprecated
public void setZ_pixel_offsetAttributeAxis(java.lang.Long axis)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 3
- Specified by:
setZ_pixel_offsetAttributeAxis
in interface NXdetector
- Parameters:
axis
- the axis
-
getZ_pixel_offsetAttributePrimary
@Deprecated
public java.lang.Long getZ_pixel_offsetAttributePrimary()
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
getZ_pixel_offsetAttributePrimary
in interface NXdetector
- Returns:
- the value.
-
setZ_pixel_offsetAttributePrimary
@Deprecated
public void setZ_pixel_offsetAttributePrimary(java.lang.Long primary)
Deprecated.
Description copied from interface: NXdetector
Enumeration:
- 1
- Specified by:
setZ_pixel_offsetAttributePrimary
in interface NXdetector
- Parameters:
primary
- the primary
-
getZ_pixel_offsetAttributeLong_name
public java.lang.String getZ_pixel_offsetAttributeLong_name()
Description copied from interface: NXdetector
y-axis offset from detector center
- Specified by:
getZ_pixel_offsetAttributeLong_name
in interface NXdetector
- Returns:
- the value.
-
setZ_pixel_offsetAttributeLong_name
public void setZ_pixel_offsetAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdetector
y-axis offset from detector center
- Specified by:
setZ_pixel_offsetAttributeLong_name
in interface NXdetector
- Parameters:
long_name
- the long_name
-
getDistance
public IDataset getDistance()
Description copied from interface: NXdetector
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;
- Specified by:
getDistance
in interface NXdetector
- Returns:
- the value.
-
getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getDistanceScalar
in interface NXdetector
- Returns:
- the value.
-
setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXdetector
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;
- Specified by:
setDistance
in interface NXdetector
- Parameters:
distance
- the distance
-
setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXdetector
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;
- Specified by:
setDistanceScalar
in interface NXdetector
- Parameters:
distance
- the distance
-
getPolar_angle
public IDataset getPolar_angle()
Description copied from interface: NXdetector
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;
- Specified by:
getPolar_angle
in interface NXdetector
- Returns:
- the value.
-
getPolar_angleScalar
public java.lang.Double getPolar_angleScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getPolar_angleScalar
in interface NXdetector
- Returns:
- the value.
-
setPolar_angle
public DataNode setPolar_angle(IDataset polar_angle)
Description copied from interface: NXdetector
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;
- Specified by:
setPolar_angle
in interface NXdetector
- Parameters:
polar_angle
- the polar_angle
-
setPolar_angleScalar
public DataNode setPolar_angleScalar(java.lang.Double polar_angle)
Description copied from interface: NXdetector
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;
- Specified by:
setPolar_angleScalar
in interface NXdetector
- Parameters:
polar_angle
- the polar_angle
-
getAzimuthal_angle
public IDataset getAzimuthal_angle()
Description copied from interface: NXdetector
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;
- Specified by:
getAzimuthal_angle
in interface NXdetector
- Returns:
- the value.
-
getAzimuthal_angleScalar
public java.lang.Double getAzimuthal_angleScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getAzimuthal_angleScalar
in interface NXdetector
- Returns:
- the value.
-
setAzimuthal_angle
public DataNode setAzimuthal_angle(IDataset azimuthal_angle)
Description copied from interface: NXdetector
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;
- Specified by:
setAzimuthal_angle
in interface NXdetector
- Parameters:
azimuthal_angle
- the azimuthal_angle
-
setAzimuthal_angleScalar
public DataNode setAzimuthal_angleScalar(java.lang.Double azimuthal_angle)
Description copied from interface: NXdetector
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;
- Specified by:
setAzimuthal_angleScalar
in interface NXdetector
- Parameters:
azimuthal_angle
- the azimuthal_angle
-
getDescription
public IDataset getDescription()
Description copied from interface: NXdetector
name/manufacturer/model/etc. information
- Specified by:
getDescription
in interface NXdetector
- Returns:
- the value.
-
getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXdetector
name/manufacturer/model/etc. information
- Specified by:
getDescriptionScalar
in interface NXdetector
- Returns:
- the value.
-
setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXdetector
name/manufacturer/model/etc. information
- Specified by:
setDescription
in interface NXdetector
- Parameters:
description
- the description
-
setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXdetector
name/manufacturer/model/etc. information
- Specified by:
setDescriptionScalar
in interface NXdetector
- Parameters:
description
- the description
-
getSerial_number
public IDataset getSerial_number()
Description copied from interface: NXdetector
Serial number for the detector
- Specified by:
getSerial_number
in interface NXdetector
- Returns:
- the value.
-
getSerial_numberScalar
public java.lang.String getSerial_numberScalar()
Description copied from interface: NXdetector
Serial number for the detector
- Specified by:
getSerial_numberScalar
in interface NXdetector
- Returns:
- the value.
-
setSerial_number
public DataNode setSerial_number(IDataset serial_number)
Description copied from interface: NXdetector
Serial number for the detector
- Specified by:
setSerial_number
in interface NXdetector
- Parameters:
serial_number
- the serial_number
-
setSerial_numberScalar
public DataNode setSerial_numberScalar(java.lang.String serial_number)
Description copied from interface: NXdetector
Serial number for the detector
- Specified by:
setSerial_numberScalar
in interface NXdetector
- Parameters:
serial_number
- the serial_number
-
getLocal_name
public IDataset getLocal_name()
Description copied from interface: NXdetector
Local name for the detector
- Specified by:
getLocal_name
in interface NXdetector
- Returns:
- the value.
-
getLocal_nameScalar
public java.lang.String getLocal_nameScalar()
Description copied from interface: NXdetector
Local name for the detector
- Specified by:
getLocal_nameScalar
in interface NXdetector
- Returns:
- the value.
-
setLocal_name
public DataNode setLocal_name(IDataset local_name)
Description copied from interface: NXdetector
Local name for the detector
- Specified by:
setLocal_name
in interface NXdetector
- Parameters:
local_name
- the local_name
-
setLocal_nameScalar
public DataNode setLocal_nameScalar(java.lang.String local_name)
Description copied from interface: NXdetector
Local name for the detector
- Specified by:
setLocal_nameScalar
in interface NXdetector
- Parameters:
local_name
- the local_name
-
getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXdetector
Position and orientation of detector
- Specified by:
getGeometry
in interface NXdetector
- Returns:
- the value.
-
setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXdetector
Position and orientation of detector
- Specified by:
setGeometry
in interface NXdetector
- Parameters:
geometry
- the geometry
-
getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXdetector
Get a NXgeometry node by name:
-
Position and orientation of detector
- Specified by:
getGeometry
in interface NXdetector
- Parameters:
name
- the name of the node.
- Returns:
- a map from node names to the NXgeometry for that node.
-
setGeometry
public void setGeometry(java.lang.String name,
NXgeometry geometry)
Description copied from interface: NXdetector
Set a NXgeometry node by name:
-
Position and orientation of detector
- Specified by:
setGeometry
in interface NXdetector
- Parameters:
name
- the name of the node
geometry
- the value to set
-
getAllGeometry
public java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Description copied from interface: NXdetector
Get all NXgeometry nodes:
-
Position and orientation of detector
- Specified by:
getAllGeometry
in interface NXdetector
- Returns:
- a map from node names to the NXgeometry for that node.
-
setAllGeometry
public void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Description copied from interface: NXdetector
Set multiple child nodes of a particular type.
-
Position and orientation of detector
- Specified by:
setAllGeometry
in interface NXdetector
- Parameters:
geometry
- the child nodes to add
-
getSolid_angle
public IDataset getSolid_angle()
Description copied from interface: NXdetector
Solid angle subtended by the detector at the sample
Type: NX_FLOAT
Units: NX_SOLID_ANGLE
Dimensions: 1: i; 2: j;
- Specified by:
getSolid_angle
in interface NXdetector
- Returns:
- the value.
-
getSolid_angleScalar
public java.lang.Double getSolid_angleScalar()
Description copied from interface: NXdetector
Solid angle subtended by the detector at the sample
Type: NX_FLOAT
Units: NX_SOLID_ANGLE
Dimensions: 1: i; 2: j;
- Specified by:
getSolid_angleScalar
in interface NXdetector
- Returns:
- the value.
-
setSolid_angle
public DataNode setSolid_angle(IDataset solid_angle)
Description copied from interface: NXdetector
Solid angle subtended by the detector at the sample
Type: NX_FLOAT
Units: NX_SOLID_ANGLE
Dimensions: 1: i; 2: j;
- Specified by:
setSolid_angle
in interface NXdetector
- Parameters:
solid_angle
- the solid_angle
-
setSolid_angleScalar
public DataNode setSolid_angleScalar(java.lang.Double solid_angle)
Description copied from interface: NXdetector
Solid angle subtended by the detector at the sample
Type: NX_FLOAT
Units: NX_SOLID_ANGLE
Dimensions: 1: i; 2: j;
- Specified by:
setSolid_angleScalar
in interface NXdetector
- Parameters:
solid_angle
- the solid_angle
-
getX_pixel_size
public IDataset getX_pixel_size()
Description copied from interface: NXdetector
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;
- Specified by:
getX_pixel_size
in interface NXdetector
- Returns:
- the value.
-
getX_pixel_sizeScalar
public java.lang.Double getX_pixel_sizeScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getX_pixel_sizeScalar
in interface NXdetector
- Returns:
- the value.
-
setX_pixel_size
public DataNode setX_pixel_size(IDataset x_pixel_size)
Description copied from interface: NXdetector
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;
- Specified by:
setX_pixel_size
in interface NXdetector
- Parameters:
x_pixel_size
- the x_pixel_size
-
setX_pixel_sizeScalar
public DataNode setX_pixel_sizeScalar(java.lang.Double x_pixel_size)
Description copied from interface: NXdetector
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;
- Specified by:
setX_pixel_sizeScalar
in interface NXdetector
- Parameters:
x_pixel_size
- the x_pixel_size
-
getY_pixel_size
public IDataset getY_pixel_size()
Description copied from interface: NXdetector
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;
- Specified by:
getY_pixel_size
in interface NXdetector
- Returns:
- the value.
-
getY_pixel_sizeScalar
public java.lang.Double getY_pixel_sizeScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getY_pixel_sizeScalar
in interface NXdetector
- Returns:
- the value.
-
setY_pixel_size
public DataNode setY_pixel_size(IDataset y_pixel_size)
Description copied from interface: NXdetector
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;
- Specified by:
setY_pixel_size
in interface NXdetector
- Parameters:
y_pixel_size
- the y_pixel_size
-
setY_pixel_sizeScalar
public DataNode setY_pixel_sizeScalar(java.lang.Double y_pixel_size)
Description copied from interface: NXdetector
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;
- Specified by:
setY_pixel_sizeScalar
in interface NXdetector
- Parameters:
y_pixel_size
- the y_pixel_size
-
getDead_time
public IDataset getDead_time()
Description copied from interface: NXdetector
Detector dead time
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: np; 2: i; 3: j;
- Specified by:
getDead_time
in interface NXdetector
- Returns:
- the value.
-
getDead_timeScalar
public java.lang.Double getDead_timeScalar()
Description copied from interface: NXdetector
Detector dead time
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: np; 2: i; 3: j;
- Specified by:
getDead_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setDead_time
public DataNode setDead_time(IDataset dead_time)
Description copied from interface: NXdetector
Detector dead time
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: np; 2: i; 3: j;
- Specified by:
setDead_time
in interface NXdetector
- Parameters:
dead_time
- the dead_time
-
setDead_timeScalar
public DataNode setDead_timeScalar(java.lang.Double dead_time)
Description copied from interface: NXdetector
Detector dead time
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: np; 2: i; 3: j;
- Specified by:
setDead_timeScalar
in interface NXdetector
- Parameters:
dead_time
- the dead_time
-
getGas_pressure
public IDataset getGas_pressure()
Description copied from interface: NXdetector
Detector gas pressure
Type: NX_FLOAT
Units: NX_PRESSURE
Dimensions: 1: i; 2: j;
- Specified by:
getGas_pressure
in interface NXdetector
- Returns:
- the value.
-
getGas_pressureScalar
public java.lang.Double getGas_pressureScalar()
Description copied from interface: NXdetector
Detector gas pressure
Type: NX_FLOAT
Units: NX_PRESSURE
Dimensions: 1: i; 2: j;
- Specified by:
getGas_pressureScalar
in interface NXdetector
- Returns:
- the value.
-
setGas_pressure
public DataNode setGas_pressure(IDataset gas_pressure)
Description copied from interface: NXdetector
Detector gas pressure
Type: NX_FLOAT
Units: NX_PRESSURE
Dimensions: 1: i; 2: j;
- Specified by:
setGas_pressure
in interface NXdetector
- Parameters:
gas_pressure
- the gas_pressure
-
setGas_pressureScalar
public DataNode setGas_pressureScalar(java.lang.Double gas_pressure)
Description copied from interface: NXdetector
Detector gas pressure
Type: NX_FLOAT
Units: NX_PRESSURE
Dimensions: 1: i; 2: j;
- Specified by:
setGas_pressureScalar
in interface NXdetector
- Parameters:
gas_pressure
- the gas_pressure
-
getDetection_gas_path
public IDataset getDetection_gas_path()
Description copied from interface: NXdetector
maximum drift space dimension
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getDetection_gas_path
in interface NXdetector
- Returns:
- the value.
-
getDetection_gas_pathScalar
public java.lang.Double getDetection_gas_pathScalar()
Description copied from interface: NXdetector
maximum drift space dimension
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getDetection_gas_pathScalar
in interface NXdetector
- Returns:
- the value.
-
setDetection_gas_path
public DataNode setDetection_gas_path(IDataset detection_gas_path)
Description copied from interface: NXdetector
maximum drift space dimension
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setDetection_gas_path
in interface NXdetector
- Parameters:
detection_gas_path
- the detection_gas_path
-
setDetection_gas_pathScalar
public DataNode setDetection_gas_pathScalar(java.lang.Double detection_gas_path)
Description copied from interface: NXdetector
maximum drift space dimension
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setDetection_gas_pathScalar
in interface NXdetector
- Parameters:
detection_gas_path
- the detection_gas_path
-
getCrate
public IDataset getCrate()
Description copied from interface: NXdetector
Crate number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getCrate
in interface NXdetector
- Returns:
- the value.
-
getCrateScalar
public java.lang.Long getCrateScalar()
Description copied from interface: NXdetector
Crate number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getCrateScalar
in interface NXdetector
- Returns:
- the value.
-
setCrate
public DataNode setCrate(IDataset crate)
Description copied from interface: NXdetector
Crate number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setCrate
in interface NXdetector
- Parameters:
crate
- the crate
-
setCrateScalar
public DataNode setCrateScalar(java.lang.Long crate)
Description copied from interface: NXdetector
Crate number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setCrateScalar
in interface NXdetector
- Parameters:
crate
- the crate
-
getCrateAttributeLocal_name
public java.lang.String getCrateAttributeLocal_name()
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
getCrateAttributeLocal_name
in interface NXdetector
- Returns:
- the value.
-
setCrateAttributeLocal_name
public void setCrateAttributeLocal_name(java.lang.String local_name)
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
setCrateAttributeLocal_name
in interface NXdetector
- Parameters:
local_name
- the local_name
-
getSlot
public IDataset getSlot()
Description copied from interface: NXdetector
Slot number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getSlot
in interface NXdetector
- Returns:
- the value.
-
getSlotScalar
public java.lang.Long getSlotScalar()
Description copied from interface: NXdetector
Slot number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getSlotScalar
in interface NXdetector
- Returns:
- the value.
-
setSlot
public DataNode setSlot(IDataset slot)
Description copied from interface: NXdetector
Slot number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setSlot
in interface NXdetector
- Parameters:
slot
- the slot
-
setSlotScalar
public DataNode setSlotScalar(java.lang.Long slot)
Description copied from interface: NXdetector
Slot number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setSlotScalar
in interface NXdetector
- Parameters:
slot
- the slot
-
getSlotAttributeLocal_name
public java.lang.String getSlotAttributeLocal_name()
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
getSlotAttributeLocal_name
in interface NXdetector
- Returns:
- the value.
-
setSlotAttributeLocal_name
public void setSlotAttributeLocal_name(java.lang.String local_name)
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
setSlotAttributeLocal_name
in interface NXdetector
- Parameters:
local_name
- the local_name
-
getInput
public IDataset getInput()
Description copied from interface: NXdetector
Input number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getInput
in interface NXdetector
- Returns:
- the value.
-
getInputScalar
public java.lang.Long getInputScalar()
Description copied from interface: NXdetector
Input number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
getInputScalar
in interface NXdetector
- Returns:
- the value.
-
setInput
public DataNode setInput(IDataset input)
Description copied from interface: NXdetector
Input number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setInput
in interface NXdetector
- Parameters:
input
- the input
-
setInputScalar
public DataNode setInputScalar(java.lang.Long input)
Description copied from interface: NXdetector
Input number of detector
Type: NX_INT
Dimensions: 1: i; 2: j;
- Specified by:
setInputScalar
in interface NXdetector
- Parameters:
input
- the input
-
getInputAttributeLocal_name
public java.lang.String getInputAttributeLocal_name()
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
getInputAttributeLocal_name
in interface NXdetector
- Returns:
- the value.
-
setInputAttributeLocal_name
public void setInputAttributeLocal_name(java.lang.String local_name)
Description copied from interface: NXdetector
Equivalent local term
- Specified by:
setInputAttributeLocal_name
in interface NXdetector
- Parameters:
local_name
- the local_name
-
getType
public IDataset getType()
Description copied from interface: NXdetector
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
CMOS, ...
- Specified by:
getType
in interface NXdetector
- Returns:
- the value.
-
getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXdetector
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
CMOS, ...
- Specified by:
getTypeScalar
in interface NXdetector
- Returns:
- the value.
-
setType
public DataNode setType(IDataset type)
Description copied from interface: NXdetector
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
CMOS, ...
- Specified by:
setType
in interface NXdetector
- Parameters:
type
- the type
-
setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXdetector
Description of type such as He3 gas cylinder, He3 PSD, scintillator,
fission chamber, proportion counter, ion chamber, ccd, pixel, image plate,
CMOS, ...
- Specified by:
setTypeScalar
in interface NXdetector
- Parameters:
type
- the type
-
getEfficiency
public NXdata getEfficiency()
Description copied from interface: NXdetector
Spectral efficiency of detector with respect to e.g. wavelength
- Specified by:
getEfficiency
in interface NXdetector
- Returns:
- the value.
-
setEfficiency
public void setEfficiency(NXdata efficiency)
Description copied from interface: NXdetector
Spectral efficiency of detector with respect to e.g. wavelength
- Specified by:
setEfficiency
in interface NXdetector
- Parameters:
efficiency
- the efficiency
-
getCalibration_date
public IDataset getCalibration_date()
Description copied from interface: NXdetector
date of last calibration (geometry and/or efficiency) measurements
Type: NX_DATE_TIME
- Specified by:
getCalibration_date
in interface NXdetector
- Returns:
- the value.
-
getCalibration_dateScalar
public java.util.Date getCalibration_dateScalar()
Description copied from interface: NXdetector
date of last calibration (geometry and/or efficiency) measurements
Type: NX_DATE_TIME
- Specified by:
getCalibration_dateScalar
in interface NXdetector
- Returns:
- the value.
-
setCalibration_date
public DataNode setCalibration_date(IDataset calibration_date)
Description copied from interface: NXdetector
date of last calibration (geometry and/or efficiency) measurements
Type: NX_DATE_TIME
- Specified by:
setCalibration_date
in interface NXdetector
- Parameters:
calibration_date
- the calibration_date
-
setCalibration_dateScalar
public DataNode setCalibration_dateScalar(java.util.Date calibration_date)
Description copied from interface: NXdetector
date of last calibration (geometry and/or efficiency) measurements
Type: NX_DATE_TIME
- Specified by:
setCalibration_dateScalar
in interface NXdetector
- Parameters:
calibration_date
- the calibration_date
-
getCalibration_method
public NXnote getCalibration_method()
Description copied from interface: NXdetector
summary of conversion of array data to pixels (e.g. polynomial
approximations) and location of details of the calibrations
- Specified by:
getCalibration_method
in interface NXdetector
- Returns:
- the value.
-
setCalibration_method
public void setCalibration_method(NXnote calibration_method)
Description copied from interface: NXdetector
summary of conversion of array data to pixels (e.g. polynomial
approximations) and location of details of the calibrations
- Specified by:
setCalibration_method
in interface NXdetector
- Parameters:
calibration_method
- the calibration_method
-
getLayout
public IDataset getLayout()
Description copied from interface: NXdetector
How the detector is represented
Enumeration:
- point
- linear
- area
- Specified by:
getLayout
in interface NXdetector
- Returns:
- the value.
-
getLayoutScalar
public java.lang.String getLayoutScalar()
Description copied from interface: NXdetector
How the detector is represented
Enumeration:
- point
- linear
- area
- Specified by:
getLayoutScalar
in interface NXdetector
- Returns:
- the value.
-
setLayout
public DataNode setLayout(IDataset layout)
Description copied from interface: NXdetector
How the detector is represented
Enumeration:
- point
- linear
- area
- Specified by:
setLayout
in interface NXdetector
- Parameters:
layout
- the layout
-
setLayoutScalar
public DataNode setLayoutScalar(java.lang.String layout)
Description copied from interface: NXdetector
How the detector is represented
Enumeration:
- point
- linear
- area
- Specified by:
setLayoutScalar
in interface NXdetector
- Parameters:
layout
- the layout
-
getCount_time
public IDataset getCount_time()
Description copied from interface: NXdetector
Elapsed actual counting time
Type: NX_NUMBER
Units: NX_TIME
Dimensions: 1: np;
- Specified by:
getCount_time
in interface NXdetector
- Returns:
- the value.
-
getCount_timeScalar
public java.lang.Number getCount_timeScalar()
Description copied from interface: NXdetector
Elapsed actual counting time
Type: NX_NUMBER
Units: NX_TIME
Dimensions: 1: np;
- Specified by:
getCount_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setCount_time
public DataNode setCount_time(IDataset count_time)
Description copied from interface: NXdetector
Elapsed actual counting time
Type: NX_NUMBER
Units: NX_TIME
Dimensions: 1: np;
- Specified by:
setCount_time
in interface NXdetector
- Parameters:
count_time
- the count_time
-
setCount_timeScalar
public DataNode setCount_timeScalar(java.lang.Number count_time)
Description copied from interface: NXdetector
Elapsed actual counting time
Type: NX_NUMBER
Units: NX_TIME
Dimensions: 1: np;
- Specified by:
setCount_timeScalar
in interface NXdetector
- Parameters:
count_time
- the count_time
-
getData_file
public NXnote getData_file()
- Specified by:
getData_file
in interface NXdetector
- Returns:
- the value.
-
setData_file
public void setData_file(NXnote data_file)
- Specified by:
setData_file
in interface NXdetector
- Parameters:
data_file
- the data_file
-
getCollection
public NXcollection getCollection()
Description copied from interface: NXdetector
Use this group to provide other data related to this NXdetector group.
- Specified by:
getCollection
in interface NXdetector
- Returns:
- the value.
-
setCollection
public void setCollection(NXcollection collection)
Description copied from interface: NXdetector
Use this group to provide other data related to this NXdetector group.
- Specified by:
setCollection
in interface NXdetector
- Parameters:
collection
- the collection
-
getCollection
public NXcollection getCollection(java.lang.String name)
Description copied from interface: NXdetector
Get a NXcollection node by name:
-
Use this group to provide other data related to this NXdetector group.
- Specified by:
getCollection
in interface NXdetector
- Parameters:
name
- the name of the node.
- Returns:
- a map from node names to the NXcollection for that node.
-
setCollection
public void setCollection(java.lang.String name,
NXcollection collection)
Description copied from interface: NXdetector
Set a NXcollection node by name:
-
Use this group to provide other data related to this NXdetector group.
- Specified by:
setCollection
in interface NXdetector
- Parameters:
name
- the name of the node
collection
- the value to set
-
getAllCollection
public java.util.Map<java.lang.String,NXcollection> getAllCollection()
Description copied from interface: NXdetector
Get all NXcollection nodes:
-
Use this group to provide other data related to this NXdetector group.
- Specified by:
getAllCollection
in interface NXdetector
- Returns:
- a map from node names to the NXcollection for that node.
-
setAllCollection
public void setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Description copied from interface: NXdetector
Set multiple child nodes of a particular type.
-
Use this group to provide other data related to this NXdetector group.
- Specified by:
setAllCollection
in interface NXdetector
- Parameters:
collection
- the child nodes to add
-
getSequence_number
public IDataset getSequence_number()
Description copied from interface: NXdetector
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;
- Specified by:
getSequence_number
in interface NXdetector
- Returns:
- the value.
-
getSequence_numberScalar
public java.lang.Long getSequence_numberScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getSequence_numberScalar
in interface NXdetector
- Returns:
- the value.
-
setSequence_number
public DataNode setSequence_number(IDataset sequence_number)
Description copied from interface: NXdetector
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;
- Specified by:
setSequence_number
in interface NXdetector
- Parameters:
sequence_number
- the sequence_number
-
setSequence_numberScalar
public DataNode setSequence_numberScalar(java.lang.Long sequence_number)
Description copied from interface: NXdetector
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;
- Specified by:
setSequence_numberScalar
in interface NXdetector
- Parameters:
sequence_number
- the sequence_number
-
getBeam_center_x
public IDataset getBeam_center_x()
Description copied from interface: NXdetector
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
- Specified by:
getBeam_center_x
in interface NXdetector
- Returns:
- the value.
-
getBeam_center_xScalar
public java.lang.Double getBeam_center_xScalar()
Description copied from interface: NXdetector
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
- Specified by:
getBeam_center_xScalar
in interface NXdetector
- Returns:
- the value.
-
setBeam_center_x
public DataNode setBeam_center_x(IDataset beam_center_x)
Description copied from interface: NXdetector
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
- Specified by:
setBeam_center_x
in interface NXdetector
- Parameters:
beam_center_x
- the beam_center_x
-
setBeam_center_xScalar
public DataNode setBeam_center_xScalar(java.lang.Double beam_center_x)
Description copied from interface: NXdetector
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
- Specified by:
setBeam_center_xScalar
in interface NXdetector
- Parameters:
beam_center_x
- the beam_center_x
-
getBeam_center_y
public IDataset getBeam_center_y()
Description copied from interface: NXdetector
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
- Specified by:
getBeam_center_y
in interface NXdetector
- Returns:
- the value.
-
getBeam_center_yScalar
public java.lang.Double getBeam_center_yScalar()
Description copied from interface: NXdetector
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
- Specified by:
getBeam_center_yScalar
in interface NXdetector
- Returns:
- the value.
-
setBeam_center_y
public DataNode setBeam_center_y(IDataset beam_center_y)
Description copied from interface: NXdetector
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
- Specified by:
setBeam_center_y
in interface NXdetector
- Parameters:
beam_center_y
- the beam_center_y
-
setBeam_center_yScalar
public DataNode setBeam_center_yScalar(java.lang.Double beam_center_y)
Description copied from interface: NXdetector
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
- Specified by:
setBeam_center_yScalar
in interface NXdetector
- Parameters:
beam_center_y
- the beam_center_y
-
getFrame_start_number
public IDataset getFrame_start_number()
Description copied from interface: NXdetector
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
- Specified by:
getFrame_start_number
in interface NXdetector
- Returns:
- the value.
-
getFrame_start_numberScalar
public java.lang.Long getFrame_start_numberScalar()
Description copied from interface: NXdetector
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
- Specified by:
getFrame_start_numberScalar
in interface NXdetector
- Returns:
- the value.
-
setFrame_start_number
public DataNode setFrame_start_number(IDataset frame_start_number)
Description copied from interface: NXdetector
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
- Specified by:
setFrame_start_number
in interface NXdetector
- Parameters:
frame_start_number
- the frame_start_number
-
setFrame_start_numberScalar
public DataNode setFrame_start_numberScalar(java.lang.Long frame_start_number)
Description copied from interface: NXdetector
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
- Specified by:
setFrame_start_numberScalar
in interface NXdetector
- Parameters:
frame_start_number
- the frame_start_number
-
getDiameter
public IDataset getDiameter()
Description copied from interface: NXdetector
The diameter of a cylindrical detector
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getDiameter
in interface NXdetector
- Returns:
- the value.
-
getDiameterScalar
public java.lang.Double getDiameterScalar()
Description copied from interface: NXdetector
The diameter of a cylindrical detector
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getDiameterScalar
in interface NXdetector
- Returns:
- the value.
-
setDiameter
public DataNode setDiameter(IDataset diameter)
Description copied from interface: NXdetector
The diameter of a cylindrical detector
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setDiameter
in interface NXdetector
- Parameters:
diameter
- the diameter
-
setDiameterScalar
public DataNode setDiameterScalar(java.lang.Double diameter)
Description copied from interface: NXdetector
The diameter of a cylindrical detector
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setDiameterScalar
in interface NXdetector
- Parameters:
diameter
- the diameter
-
getAcquisition_mode
public IDataset getAcquisition_mode()
Description copied from interface: NXdetector
The acquisition mode of the detector.
Type: NX_CHAR
Enumeration:
- gated
- triggered
- summed
- event
- histogrammed
- decimated
- Specified by:
getAcquisition_mode
in interface NXdetector
- Returns:
- the value.
-
getAcquisition_modeScalar
public java.lang.String getAcquisition_modeScalar()
Description copied from interface: NXdetector
The acquisition mode of the detector.
Type: NX_CHAR
Enumeration:
- gated
- triggered
- summed
- event
- histogrammed
- decimated
- Specified by:
getAcquisition_modeScalar
in interface NXdetector
- Returns:
- the value.
-
setAcquisition_mode
public DataNode setAcquisition_mode(IDataset acquisition_mode)
Description copied from interface: NXdetector
The acquisition mode of the detector.
Type: NX_CHAR
Enumeration:
- gated
- triggered
- summed
- event
- histogrammed
- decimated
- Specified by:
setAcquisition_mode
in interface NXdetector
- Parameters:
acquisition_mode
- the acquisition_mode
-
setAcquisition_modeScalar
public DataNode setAcquisition_modeScalar(java.lang.String acquisition_mode)
Description copied from interface: NXdetector
The acquisition mode of the detector.
Type: NX_CHAR
Enumeration:
- gated
- triggered
- summed
- event
- histogrammed
- decimated
- Specified by:
setAcquisition_modeScalar
in interface NXdetector
- Parameters:
acquisition_mode
- the acquisition_mode
-
getAngular_calibration_applied
public IDataset getAngular_calibration_applied()
Description copied from interface: NXdetector
True when the angular calibration has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getAngular_calibration_applied
in interface NXdetector
- Returns:
- the value.
-
getAngular_calibration_appliedScalar
public java.lang.Boolean getAngular_calibration_appliedScalar()
Description copied from interface: NXdetector
True when the angular calibration has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getAngular_calibration_appliedScalar
in interface NXdetector
- Returns:
- the value.
-
setAngular_calibration_applied
public DataNode setAngular_calibration_applied(IDataset angular_calibration_applied)
Description copied from interface: NXdetector
True when the angular calibration has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setAngular_calibration_applied
in interface NXdetector
- Parameters:
angular_calibration_applied
- the angular_calibration_applied
-
setAngular_calibration_appliedScalar
public DataNode setAngular_calibration_appliedScalar(java.lang.Boolean angular_calibration_applied)
Description copied from interface: NXdetector
True when the angular calibration has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setAngular_calibration_appliedScalar
in interface NXdetector
- Parameters:
angular_calibration_applied
- the angular_calibration_applied
-
getAngular_calibration
public IDataset getAngular_calibration()
Description copied from interface: NXdetector
Angular calibration data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getAngular_calibration
in interface NXdetector
- Returns:
- the value.
-
getAngular_calibrationScalar
public java.lang.Double getAngular_calibrationScalar()
Description copied from interface: NXdetector
Angular calibration data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getAngular_calibrationScalar
in interface NXdetector
- Returns:
- the value.
-
setAngular_calibration
public DataNode setAngular_calibration(IDataset angular_calibration)
Description copied from interface: NXdetector
Angular calibration data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setAngular_calibration
in interface NXdetector
- Parameters:
angular_calibration
- the angular_calibration
-
setAngular_calibrationScalar
public DataNode setAngular_calibrationScalar(java.lang.Double angular_calibration)
Description copied from interface: NXdetector
Angular calibration data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setAngular_calibrationScalar
in interface NXdetector
- Parameters:
angular_calibration
- the angular_calibration
-
getFlatfield_applied
public IDataset getFlatfield_applied()
Description copied from interface: NXdetector
True when the flat field correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getFlatfield_applied
in interface NXdetector
- Returns:
- the value.
-
getFlatfield_appliedScalar
public java.lang.Boolean getFlatfield_appliedScalar()
Description copied from interface: NXdetector
True when the flat field correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getFlatfield_appliedScalar
in interface NXdetector
- Returns:
- the value.
-
setFlatfield_applied
public DataNode setFlatfield_applied(IDataset flatfield_applied)
Description copied from interface: NXdetector
True when the flat field correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setFlatfield_applied
in interface NXdetector
- Parameters:
flatfield_applied
- the flatfield_applied
-
setFlatfield_appliedScalar
public DataNode setFlatfield_appliedScalar(java.lang.Boolean flatfield_applied)
Description copied from interface: NXdetector
True when the flat field correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setFlatfield_appliedScalar
in interface NXdetector
- Parameters:
flatfield_applied
- the flatfield_applied
-
getFlatfield
public IDataset getFlatfield()
Description copied from interface: NXdetector
Flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getFlatfield
in interface NXdetector
- Returns:
- the value.
-
getFlatfieldScalar
public java.lang.Double getFlatfieldScalar()
Description copied from interface: NXdetector
Flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getFlatfieldScalar
in interface NXdetector
- Returns:
- the value.
-
setFlatfield
public DataNode setFlatfield(IDataset flatfield)
Description copied from interface: NXdetector
Flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setFlatfield
in interface NXdetector
- Parameters:
flatfield
- the flatfield
-
setFlatfieldScalar
public DataNode setFlatfieldScalar(java.lang.Double flatfield)
Description copied from interface: NXdetector
Flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setFlatfieldScalar
in interface NXdetector
- Parameters:
flatfield
- the flatfield
-
getFlatfield_error
public IDataset getFlatfield_error()
Description copied from interface: NXdetector
Errors of the flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getFlatfield_error
in interface NXdetector
- Returns:
- the value.
-
getFlatfield_errorScalar
public java.lang.Double getFlatfield_errorScalar()
Description copied from interface: NXdetector
Errors of the flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
getFlatfield_errorScalar
in interface NXdetector
- Returns:
- the value.
-
setFlatfield_error
public DataNode setFlatfield_error(IDataset flatfield_error)
Description copied from interface: NXdetector
Errors of the flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setFlatfield_error
in interface NXdetector
- Parameters:
flatfield_error
- the flatfield_error
-
setFlatfield_errorScalar
public DataNode setFlatfield_errorScalar(java.lang.Double flatfield_error)
Description copied from interface: NXdetector
Errors of the flat field correction data.
Type: NX_FLOAT
Dimensions: 1: i; 2: j;
- Specified by:
setFlatfield_errorScalar
in interface NXdetector
- Parameters:
flatfield_error
- the flatfield_error
-
getPixel_mask_applied
public IDataset getPixel_mask_applied()
Description copied from interface: NXdetector
True when the pixel mask correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getPixel_mask_applied
in interface NXdetector
- Returns:
- the value.
-
getPixel_mask_appliedScalar
public java.lang.Boolean getPixel_mask_appliedScalar()
Description copied from interface: NXdetector
True when the pixel mask correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getPixel_mask_appliedScalar
in interface NXdetector
- Returns:
- the value.
-
setPixel_mask_applied
public DataNode setPixel_mask_applied(IDataset pixel_mask_applied)
Description copied from interface: NXdetector
True when the pixel mask correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setPixel_mask_applied
in interface NXdetector
- Parameters:
pixel_mask_applied
- the pixel_mask_applied
-
setPixel_mask_appliedScalar
public DataNode setPixel_mask_appliedScalar(java.lang.Boolean pixel_mask_applied)
Description copied from interface: NXdetector
True when the pixel mask correction has been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setPixel_mask_appliedScalar
in interface NXdetector
- Parameters:
pixel_mask_applied
- the pixel_mask_applied
-
getPixel_mask
public IDataset getPixel_mask()
Description copied from interface: NXdetector
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;
- Specified by:
getPixel_mask
in interface NXdetector
- Returns:
- the value.
-
getPixel_maskScalar
public java.lang.Long getPixel_maskScalar()
Description copied from interface: NXdetector
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;
- Specified by:
getPixel_maskScalar
in interface NXdetector
- Returns:
- the value.
-
setPixel_mask
public DataNode setPixel_mask(IDataset pixel_mask)
Description copied from interface: NXdetector
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;
- Specified by:
setPixel_mask
in interface NXdetector
- Parameters:
pixel_mask
- the pixel_mask
-
setPixel_maskScalar
public DataNode setPixel_maskScalar(java.lang.Long pixel_mask)
Description copied from interface: NXdetector
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;
- Specified by:
setPixel_maskScalar
in interface NXdetector
- Parameters:
pixel_mask
- the pixel_mask
-
getCountrate_correction__applied
public IDataset getCountrate_correction__applied()
Description copied from interface: NXdetector
True when a count-rate correction has already been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getCountrate_correction__applied
in interface NXdetector
- Returns:
- the value.
-
getCountrate_correction__appliedScalar
public java.lang.Boolean getCountrate_correction__appliedScalar()
Description copied from interface: NXdetector
True when a count-rate correction has already been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
getCountrate_correction__appliedScalar
in interface NXdetector
- Returns:
- the value.
-
setCountrate_correction__applied
public DataNode setCountrate_correction__applied(IDataset countrate_correction__applied)
Description copied from interface: NXdetector
True when a count-rate correction has already been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setCountrate_correction__applied
in interface NXdetector
- Parameters:
countrate_correction__applied
- the countrate_correction__applied
-
setCountrate_correction__appliedScalar
public DataNode setCountrate_correction__appliedScalar(java.lang.Boolean countrate_correction__applied)
Description copied from interface: NXdetector
True when a count-rate correction has already been applied in the
electronics, false otherwise.
Type: NX_BOOLEAN
- Specified by:
setCountrate_correction__appliedScalar
in interface NXdetector
- Parameters:
countrate_correction__applied
- the countrate_correction__applied
-
getBit_depth_readout
public IDataset getBit_depth_readout()
Description copied from interface: NXdetector
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
- Specified by:
getBit_depth_readout
in interface NXdetector
- Returns:
- the value.
-
getBit_depth_readoutScalar
public java.lang.Long getBit_depth_readoutScalar()
Description copied from interface: NXdetector
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
- Specified by:
getBit_depth_readoutScalar
in interface NXdetector
- Returns:
- the value.
-
setBit_depth_readout
public DataNode setBit_depth_readout(IDataset bit_depth_readout)
Description copied from interface: NXdetector
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
- Specified by:
setBit_depth_readout
in interface NXdetector
- Parameters:
bit_depth_readout
- the bit_depth_readout
-
setBit_depth_readoutScalar
public DataNode setBit_depth_readoutScalar(java.lang.Long bit_depth_readout)
Description copied from interface: NXdetector
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
- Specified by:
setBit_depth_readoutScalar
in interface NXdetector
- Parameters:
bit_depth_readout
- the bit_depth_readout
-
getDetector_readout_time
public IDataset getDetector_readout_time()
Description copied from interface: NXdetector
Time it takes to read the detector (typically milliseconds).
This is important to know for time resolved experiments.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
getDetector_readout_time
in interface NXdetector
- Returns:
- the value.
-
getDetector_readout_timeScalar
public java.lang.Double getDetector_readout_timeScalar()
Description copied from interface: NXdetector
Time it takes to read the detector (typically milliseconds).
This is important to know for time resolved experiments.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
getDetector_readout_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setDetector_readout_time
public DataNode setDetector_readout_time(IDataset detector_readout_time)
Description copied from interface: NXdetector
Time it takes to read the detector (typically milliseconds).
This is important to know for time resolved experiments.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
setDetector_readout_time
in interface NXdetector
- Parameters:
detector_readout_time
- the detector_readout_time
-
setDetector_readout_timeScalar
public DataNode setDetector_readout_timeScalar(java.lang.Double detector_readout_time)
Description copied from interface: NXdetector
Time it takes to read the detector (typically milliseconds).
This is important to know for time resolved experiments.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
setDetector_readout_timeScalar
in interface NXdetector
- Parameters:
detector_readout_time
- the detector_readout_time
-
getTrigger_delay_time
public IDataset getTrigger_delay_time()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_delay_time
in interface NXdetector
- Returns:
- the value.
-
getTrigger_delay_timeScalar
public java.lang.Double getTrigger_delay_timeScalar()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_delay_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setTrigger_delay_time
public DataNode setTrigger_delay_time(IDataset trigger_delay_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_delay_time
in interface NXdetector
- Parameters:
trigger_delay_time
- the trigger_delay_time
-
setTrigger_delay_timeScalar
public DataNode setTrigger_delay_timeScalar(java.lang.Double trigger_delay_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_delay_timeScalar
in interface NXdetector
- Parameters:
trigger_delay_time
- the trigger_delay_time
-
getTrigger_delay_time_set
public IDataset getTrigger_delay_time_set()
Description copied from interface: NXdetector
User-specified trigger delay.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
getTrigger_delay_time_set
in interface NXdetector
- Returns:
- the value.
-
getTrigger_delay_time_setScalar
public java.lang.Double getTrigger_delay_time_setScalar()
Description copied from interface: NXdetector
User-specified trigger delay.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
getTrigger_delay_time_setScalar
in interface NXdetector
- Returns:
- the value.
-
setTrigger_delay_time_set
public DataNode setTrigger_delay_time_set(IDataset trigger_delay_time_set)
Description copied from interface: NXdetector
User-specified trigger delay.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
setTrigger_delay_time_set
in interface NXdetector
- Parameters:
trigger_delay_time_set
- the trigger_delay_time_set
-
setTrigger_delay_time_setScalar
public DataNode setTrigger_delay_time_setScalar(java.lang.Double trigger_delay_time_set)
Description copied from interface: NXdetector
User-specified trigger delay.
Type: NX_FLOAT
Units: NX_TIME
- Specified by:
setTrigger_delay_time_setScalar
in interface NXdetector
- Parameters:
trigger_delay_time_set
- the trigger_delay_time_set
-
getTrigger_internal_delay_time
public IDataset getTrigger_internal_delay_time()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_internal_delay_time
in interface NXdetector
- Returns:
- the value.
-
getTrigger_internal_delay_timeScalar
public java.lang.Double getTrigger_internal_delay_timeScalar()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_internal_delay_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setTrigger_internal_delay_time
public DataNode setTrigger_internal_delay_time(IDataset trigger_internal_delay_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_internal_delay_time
in interface NXdetector
- Parameters:
trigger_internal_delay_time
- the trigger_internal_delay_time
-
setTrigger_internal_delay_timeScalar
public DataNode setTrigger_internal_delay_timeScalar(java.lang.Double trigger_internal_delay_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_internal_delay_timeScalar
in interface NXdetector
- Parameters:
trigger_internal_delay_time
- the trigger_internal_delay_time
-
getTrigger_dead_time
public IDataset getTrigger_dead_time()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_dead_time
in interface NXdetector
- Returns:
- the value.
-
getTrigger_dead_timeScalar
public java.lang.Double getTrigger_dead_timeScalar()
Description copied from interface: NXdetector
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
- Specified by:
getTrigger_dead_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setTrigger_dead_time
public DataNode setTrigger_dead_time(IDataset trigger_dead_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_dead_time
in interface NXdetector
- Parameters:
trigger_dead_time
- the trigger_dead_time
-
setTrigger_dead_timeScalar
public DataNode setTrigger_dead_timeScalar(java.lang.Double trigger_dead_time)
Description copied from interface: NXdetector
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
- Specified by:
setTrigger_dead_timeScalar
in interface NXdetector
- Parameters:
trigger_dead_time
- the trigger_dead_time
-
getFrame_time
public IDataset getFrame_time()
Description copied from interface: NXdetector
This is time for each frame. This is exposure_time + readout time.
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: NP;
- Specified by:
getFrame_time
in interface NXdetector
- Returns:
- the value.
-
getFrame_timeScalar
public java.lang.Double getFrame_timeScalar()
Description copied from interface: NXdetector
This is time for each frame. This is exposure_time + readout time.
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: NP;
- Specified by:
getFrame_timeScalar
in interface NXdetector
- Returns:
- the value.
-
setFrame_time
public DataNode setFrame_time(IDataset frame_time)
Description copied from interface: NXdetector
This is time for each frame. This is exposure_time + readout time.
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: NP;
- Specified by:
setFrame_time
in interface NXdetector
- Parameters:
frame_time
- the frame_time
-
setFrame_timeScalar
public DataNode setFrame_timeScalar(java.lang.Double frame_time)
Description copied from interface: NXdetector
This is time for each frame. This is exposure_time + readout time.
Type: NX_FLOAT
Units: NX_TIME
Dimensions: 1: NP;
- Specified by:
setFrame_timeScalar
in interface NXdetector
- Parameters:
frame_time
- the frame_time
-
getGain_setting
public IDataset getGain_setting()
Description copied from interface: NXdetector
The gain setting of the detector. This influences background etc.
Type: NX_CHAR
Enumeration:
- high
- standard
- fast
- auto
- Specified by:
getGain_setting
in interface NXdetector
- Returns:
- the value.
-
getGain_settingScalar
public java.lang.String getGain_settingScalar()
Description copied from interface: NXdetector
The gain setting of the detector. This influences background etc.
Type: NX_CHAR
Enumeration:
- high
- standard
- fast
- auto
- Specified by:
getGain_settingScalar
in interface NXdetector
- Returns:
- the value.
-
setGain_setting
public DataNode setGain_setting(IDataset gain_setting)
Description copied from interface: NXdetector
The gain setting of the detector. This influences background etc.
Type: NX_CHAR
Enumeration:
- high
- standard
- fast
- auto
- Specified by:
setGain_setting
in interface NXdetector
- Parameters:
gain_setting
- the gain_setting
-
setGain_settingScalar
public DataNode setGain_settingScalar(java.lang.String gain_setting)
Description copied from interface: NXdetector
The gain setting of the detector. This influences background etc.
Type: NX_CHAR
Enumeration:
- high
- standard
- fast
- auto
- Specified by:
setGain_settingScalar
in interface NXdetector
- Parameters:
gain_setting
- the gain_setting
-
getSaturation_value
public IDataset getSaturation_value()
Description copied from interface: NXdetector
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
- Specified by:
getSaturation_value
in interface NXdetector
- Returns:
- the value.
-
getSaturation_valueScalar
public java.lang.Long getSaturation_valueScalar()
Description copied from interface: NXdetector
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
- Specified by:
getSaturation_valueScalar
in interface NXdetector
- Returns:
- the value.
-
setSaturation_value
public DataNode setSaturation_value(IDataset saturation_value)
Description copied from interface: NXdetector
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
- Specified by:
setSaturation_value
in interface NXdetector
- Parameters:
saturation_value
- the saturation_value
-
setSaturation_valueScalar
public DataNode setSaturation_valueScalar(java.lang.Long saturation_value)
Description copied from interface: NXdetector
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
- Specified by:
setSaturation_valueScalar
in interface NXdetector
- Parameters:
saturation_value
- the saturation_value
-
getNumber_of_cycles
public IDataset getNumber_of_cycles()
Description copied from interface: NXdetector
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
- Specified by:
getNumber_of_cycles
in interface NXdetector
- Returns:
- the value.
-
getNumber_of_cyclesScalar
public java.lang.Long getNumber_of_cyclesScalar()
Description copied from interface: NXdetector
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
- Specified by:
getNumber_of_cyclesScalar
in interface NXdetector
- Returns:
- the value.
-
setNumber_of_cycles
public DataNode setNumber_of_cycles(IDataset number_of_cycles)
Description copied from interface: NXdetector
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
- Specified by:
setNumber_of_cycles
in interface NXdetector
- Parameters:
number_of_cycles
- the number_of_cycles
-
setNumber_of_cyclesScalar
public DataNode setNumber_of_cyclesScalar(java.lang.Long number_of_cycles)
Description copied from interface: NXdetector
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
- Specified by:
setNumber_of_cyclesScalar
in interface NXdetector
- Parameters:
number_of_cycles
- the number_of_cycles
-
getSensor_material
public IDataset getSensor_material()
Description copied from interface: NXdetector
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
- Specified by:
getSensor_material
in interface NXdetector
- Returns:
- the value.
-
getSensor_materialScalar
public java.lang.String getSensor_materialScalar()
Description copied from interface: NXdetector
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
- Specified by:
getSensor_materialScalar
in interface NXdetector
- Returns:
- the value.
-
setSensor_material
public DataNode setSensor_material(IDataset sensor_material)
Description copied from interface: NXdetector
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
- Specified by:
setSensor_material
in interface NXdetector
- Parameters:
sensor_material
- the sensor_material
-
setSensor_materialScalar
public DataNode setSensor_materialScalar(java.lang.String sensor_material)
Description copied from interface: NXdetector
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
- Specified by:
setSensor_materialScalar
in interface NXdetector
- Parameters:
sensor_material
- the sensor_material
-
getSensor_thickness
public IDataset getSensor_thickness()
Description copied from interface: NXdetector
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
- Specified by:
getSensor_thickness
in interface NXdetector
- Returns:
- the value.
-
getSensor_thicknessScalar
public java.lang.Double getSensor_thicknessScalar()
Description copied from interface: NXdetector
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
- Specified by:
getSensor_thicknessScalar
in interface NXdetector
- Returns:
- the value.
-
setSensor_thickness
public DataNode setSensor_thickness(IDataset sensor_thickness)
Description copied from interface: NXdetector
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
- Specified by:
setSensor_thickness
in interface NXdetector
- Parameters:
sensor_thickness
- the sensor_thickness
-
setSensor_thicknessScalar
public DataNode setSensor_thicknessScalar(java.lang.Double sensor_thickness)
Description copied from interface: NXdetector
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
- Specified by:
setSensor_thicknessScalar
in interface NXdetector
- Parameters:
sensor_thickness
- the sensor_thickness
-
getThreshold_energy
public IDataset getThreshold_energy()
Description copied from interface: NXdetector
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
- Specified by:
getThreshold_energy
in interface NXdetector
- Returns:
- the value.
-
getThreshold_energyScalar
public java.lang.Double getThreshold_energyScalar()
Description copied from interface: NXdetector
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
- Specified by:
getThreshold_energyScalar
in interface NXdetector
- Returns:
- the value.
-
setThreshold_energy
public DataNode setThreshold_energy(IDataset threshold_energy)
Description copied from interface: NXdetector
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
- Specified by:
setThreshold_energy
in interface NXdetector
- Parameters:
threshold_energy
- the threshold_energy
-
setThreshold_energyScalar
public DataNode setThreshold_energyScalar(java.lang.Double threshold_energy)
Description copied from interface: NXdetector
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
- Specified by:
setThreshold_energyScalar
in interface NXdetector
- Parameters:
threshold_energy
- the threshold_energy
-
getDetector_module
public NXdetector_module getDetector_module()
Description copied from interface: NXdetector
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.
- Specified by:
getDetector_module
in interface NXdetector
- Returns:
- the value.
-
setDetector_module
public void setDetector_module(NXdetector_module detector_module)
Description copied from interface: NXdetector
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.
- Specified by:
setDetector_module
in interface NXdetector
- Parameters:
detector_module
- the detector_module
-
getDetector_module
public NXdetector_module getDetector_module(java.lang.String name)
Description copied from interface: NXdetector
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.
- Specified by:
getDetector_module
in interface NXdetector
- Parameters:
name
- the name of the node.
- Returns:
- a map from node names to the NXdetector_module for that node.
-
setDetector_module
public void setDetector_module(java.lang.String name,
NXdetector_module detector_module)
Description copied from interface: NXdetector
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.
- Specified by:
setDetector_module
in interface NXdetector
- Parameters:
name
- the name of the node
detector_module
- the value to set
-
getAllDetector_module
public java.util.Map<java.lang.String,NXdetector_module> getAllDetector_module()
Description copied from interface: NXdetector
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.
- Specified by:
getAllDetector_module
in interface NXdetector
- Returns:
- a map from node names to the NXdetector_module for that node.
-
setAllDetector_module
public void setAllDetector_module(java.util.Map<java.lang.String,NXdetector_module> detector_module)
Description copied from interface: NXdetector
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.
- Specified by:
setAllDetector_module
in interface NXdetector
- Parameters:
detector_module
- the child nodes to add