All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.dawnsci.nexus.NXdetector Maven / Gradle / Ivy

/*-
 *******************************************************************************
 * Copyright (c) 2015 Diamond Light Source Ltd.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * This file was auto-generated from the NXDL XML definition.
 *******************************************************************************/

package org.eclipse.dawnsci.nexus;

import java.util.Date;
import java.util.Map;

import org.eclipse.dawnsci.analysis.api.tree.DataNode;
import org.eclipse.january.dataset.IDataset;

/**
 * A detector, detector bank, or multidetector.
 * 

Symbols: * These symbols will be used below to coordinate datasets with the same shape.

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

* */ public interface NXdetector extends NXobject { public static final String NX_TIME_OF_FLIGHT = "time_of_flight"; public static final String NX_TIME_OF_FLIGHT_ATTRIBUTE_AXIS = "axis"; public static final String NX_TIME_OF_FLIGHT_ATTRIBUTE_PRIMARY = "primary"; public static final String NX_TIME_OF_FLIGHT_ATTRIBUTE_LONG_NAME = "long_name"; public static final String NX_RAW_TIME_OF_FLIGHT = "raw_time_of_flight"; public static final String NX_RAW_TIME_OF_FLIGHT_ATTRIBUTE_FREQUENCY = "frequency"; public static final String NX_DETECTOR_NUMBER = "detector_number"; public static final String NX_DATA = "data"; public static final String NX_DATA_ATTRIBUTE_LONG_NAME = "long_name"; public static final String NX_DATA_ATTRIBUTE_CHECK_SUM = "check_sum"; public static final String NX_DATA_ERROR = "data_error"; public static final String NX_X_PIXEL_OFFSET = "x_pixel_offset"; public static final String NX_X_PIXEL_OFFSET_ATTRIBUTE_AXIS = "axis"; public static final String NX_X_PIXEL_OFFSET_ATTRIBUTE_PRIMARY = "primary"; public static final String NX_X_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME = "long_name"; public static final String NX_Y_PIXEL_OFFSET = "y_pixel_offset"; public static final String NX_Y_PIXEL_OFFSET_ATTRIBUTE_AXIS = "axis"; public static final String NX_Y_PIXEL_OFFSET_ATTRIBUTE_PRIMARY = "primary"; public static final String NX_Y_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME = "long_name"; public static final String NX_Z_PIXEL_OFFSET = "z_pixel_offset"; public static final String NX_Z_PIXEL_OFFSET_ATTRIBUTE_AXIS = "axis"; public static final String NX_Z_PIXEL_OFFSET_ATTRIBUTE_PRIMARY = "primary"; public static final String NX_Z_PIXEL_OFFSET_ATTRIBUTE_LONG_NAME = "long_name"; public static final String NX_DISTANCE = "distance"; public static final String NX_POLAR_ANGLE = "polar_angle"; public static final String NX_AZIMUTHAL_ANGLE = "azimuthal_angle"; public static final String NX_DESCRIPTION = "description"; public static final String NX_SERIAL_NUMBER = "serial_number"; public static final String NX_LOCAL_NAME = "local_name"; public static final String NX_SOLID_ANGLE = "solid_angle"; public static final String NX_X_PIXEL_SIZE = "x_pixel_size"; public static final String NX_Y_PIXEL_SIZE = "y_pixel_size"; public static final String NX_DEAD_TIME = "dead_time"; public static final String NX_GAS_PRESSURE = "gas_pressure"; public static final String NX_DETECTION_GAS_PATH = "detection_gas_path"; public static final String NX_CRATE = "crate"; public static final String NX_CRATE_ATTRIBUTE_LOCAL_NAME = "local_name"; public static final String NX_SLOT = "slot"; public static final String NX_SLOT_ATTRIBUTE_LOCAL_NAME = "local_name"; public static final String NX_INPUT = "input"; public static final String NX_INPUT_ATTRIBUTE_LOCAL_NAME = "local_name"; public static final String NX_TYPE = "type"; public static final String NX_CALIBRATION_DATE = "calibration_date"; public static final String NX_LAYOUT = "layout"; public static final String NX_COUNT_TIME = "count_time"; public static final String NX_SEQUENCE_NUMBER = "sequence_number"; public static final String NX_BEAM_CENTER_X = "beam_center_x"; public static final String NX_BEAM_CENTER_Y = "beam_center_y"; public static final String NX_FRAME_START_NUMBER = "frame_start_number"; public static final String NX_DIAMETER = "diameter"; public static final String NX_ACQUISITION_MODE = "acquisition_mode"; public static final String NX_ANGULAR_CALIBRATION_APPLIED = "angular_calibration_applied"; public static final String NX_ANGULAR_CALIBRATION = "angular_calibration"; public static final String NX_FLATFIELD_APPLIED = "flatfield_applied"; public static final String NX_FLATFIELD = "flatfield"; public static final String NX_FLATFIELD_ERROR = "flatfield_error"; public static final String NX_PIXEL_MASK_APPLIED = "pixel_mask_applied"; public static final String NX_PIXEL_MASK = "pixel_mask"; public static final String NX_COUNTRATE_CORRECTION__APPLIED = "countrate_correction__applied"; public static final String NX_BIT_DEPTH_READOUT = "bit_depth_readout"; public static final String NX_DETECTOR_READOUT_TIME = "detector_readout_time"; public static final String NX_TRIGGER_DELAY_TIME = "trigger_delay_time"; public static final String NX_TRIGGER_DELAY_TIME_SET = "trigger_delay_time_set"; public static final String NX_TRIGGER_INTERNAL_DELAY_TIME = "trigger_internal_delay_time"; public static final String NX_TRIGGER_DEAD_TIME = "trigger_dead_time"; public static final String NX_FRAME_TIME = "frame_time"; public static final String NX_GAIN_SETTING = "gain_setting"; public static final String NX_SATURATION_VALUE = "saturation_value"; public static final String NX_NUMBER_OF_CYCLES = "number_of_cycles"; public static final String NX_SENSOR_MATERIAL = "sensor_material"; public static final String NX_SENSOR_THICKNESS = "sensor_thickness"; public static final String NX_THRESHOLD_ENERGY = "threshold_energy"; /** * Total time of flight *

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

* * @return the value. */ public IDataset getTime_of_flight(); /** * Total time of flight *

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

* * @param time_of_flight the time_of_flight */ public DataNode setTime_of_flight(IDataset time_of_flight); /** * Total time of flight *

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

* * @return the value. */ public Double getTime_of_flightScalar(); /** * Total time of flight *

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

* * @param time_of_flight the time_of_flight */ public DataNode setTime_of_flightScalar(Double time_of_flight); /** *

*

Enumeration:

    *
  • 3

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getTime_of_flightAttributeAxis(); /** *

*

Enumeration:

    *
  • 3

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param axis the axis */ @Deprecated public void setTime_of_flightAttributeAxis(Long axis); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getTime_of_flightAttributePrimary(); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param primary the primary */ @Deprecated public void setTime_of_flightAttributePrimary(Long primary); /** * Total time of flight * * @return the value. */ public String getTime_of_flightAttributeLong_name(); /** * Total time of flight * * @param long_name the long_name */ public void setTime_of_flightAttributeLong_name(String long_name); /** * In DAQ clock pulses *

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

* * @return the value. */ public IDataset getRaw_time_of_flight(); /** * In DAQ clock pulses *

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

* * @param raw_time_of_flight the raw_time_of_flight */ public DataNode setRaw_time_of_flight(IDataset raw_time_of_flight); /** * In DAQ clock pulses *

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

* * @return the value. */ public Long getRaw_time_of_flightScalar(); /** * In DAQ clock pulses *

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

* * @param raw_time_of_flight the raw_time_of_flight */ public DataNode setRaw_time_of_flightScalar(Long raw_time_of_flight); /** * Clock frequency in Hz * * @return the value. */ public Number getRaw_time_of_flightAttributeFrequency(); /** * Clock frequency in Hz * * @param frequency the frequency */ public void setRaw_time_of_flightAttributeFrequency(Number frequency); /** * Identifier for detector (pixels) * Can be multidimensional, if needed *

* Type: NX_INT *

* * @return the value. */ public IDataset getDetector_number(); /** * Identifier for detector (pixels) * Can be multidimensional, if needed *

* Type: NX_INT *

* * @param detector_number the detector_number */ public DataNode setDetector_number(IDataset detector_number); /** * Identifier for detector (pixels) * Can be multidimensional, if needed *

* Type: NX_INT *

* * @return the value. */ public Long getDetector_numberScalar(); /** * Identifier for detector (pixels) * Can be multidimensional, if needed *

* Type: NX_INT *

* * @param detector_number the detector_number */ public DataNode setDetector_numberScalar(Long detector_number); /** * Data values from the detector. *

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

* * @return the value. */ public IDataset getData(); /** * Data values from the detector. *

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

* * @param data the data */ public DataNode setData(IDataset data); /** * Data values from the detector. *

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

* * @return the value. */ public Number getDataScalar(); /** * Data values from the detector. *

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

* * @param data the data */ public DataNode setDataScalar(Number data); /** * Title of measurement * * @return the value. */ public String getDataAttributeLong_name(); /** * Title of measurement * * @param long_name the long_name */ public void setDataAttributeLong_name(String long_name); /** * Integral of data as check of data integrity * * @return the value. */ public Long getDataAttributeCheck_sum(); /** * Integral of data as check of data integrity * * @param check_sum the check_sum */ public void setDataAttributeCheck_sum(Long check_sum); /** * 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; *

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

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

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

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

* * @return the value. */ public Number getData_errorScalar(); /** * The best estimate of the uncertainty in the data value. Where * possible, this should be the standard deviation, which has the same units * as the data. *

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

* * @param data_error the data_error */ public DataNode setData_errorScalar(Number data_error); /** * Offset from the detector center in x-direction. * Can be multidimensional when needed. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public IDataset getX_pixel_offset(); /** * Offset from the detector center in x-direction. * Can be multidimensional when needed. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param x_pixel_offset the x_pixel_offset */ public DataNode setX_pixel_offset(IDataset x_pixel_offset); /** * Offset from the detector center in x-direction. * Can be multidimensional when needed. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getX_pixel_offsetScalar(); /** * Offset from the detector center in x-direction. * Can be multidimensional when needed. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param x_pixel_offset the x_pixel_offset */ public DataNode setX_pixel_offsetScalar(Double x_pixel_offset); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getX_pixel_offsetAttributeAxis(); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param axis the axis */ @Deprecated public void setX_pixel_offsetAttributeAxis(Long axis); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getX_pixel_offsetAttributePrimary(); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param primary the primary */ @Deprecated public void setX_pixel_offsetAttributePrimary(Long primary); /** * x-axis offset from detector center * * @return the value. */ public String getX_pixel_offsetAttributeLong_name(); /** * x-axis offset from detector center * * @param long_name the long_name */ public void setX_pixel_offsetAttributeLong_name(String long_name); /** * 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 *

* * @return the value. */ public IDataset getY_pixel_offset(); /** * Offset from the detector center in the y-direction. * Can be multidimensional when different values are required for each pixel. *

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getY_pixel_offsetScalar(); /** * Offset from the detector center in the y-direction. * Can be multidimensional when different values are required for each pixel. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param y_pixel_offset the y_pixel_offset */ public DataNode setY_pixel_offsetScalar(Double y_pixel_offset); /** *

*

Enumeration:

    *
  • 2

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getY_pixel_offsetAttributeAxis(); /** *

*

Enumeration:

    *
  • 2

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param axis the axis */ @Deprecated public void setY_pixel_offsetAttributeAxis(Long axis); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getY_pixel_offsetAttributePrimary(); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param primary the primary */ @Deprecated public void setY_pixel_offsetAttributePrimary(Long primary); /** * y-axis offset from detector center * * @return the value. */ public String getY_pixel_offsetAttributeLong_name(); /** * y-axis offset from detector center * * @param long_name the long_name */ public void setY_pixel_offsetAttributeLong_name(String long_name); /** * 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 *

* * @return the value. */ public IDataset getZ_pixel_offset(); /** * Offset from the detector center in the z-direction. * Can be multidimensional when different values are required for each pixel. *

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getZ_pixel_offsetScalar(); /** * Offset from the detector center in the z-direction. * Can be multidimensional when different values are required for each pixel. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param z_pixel_offset the z_pixel_offset */ public DataNode setZ_pixel_offsetScalar(Double z_pixel_offset); /** *

*

Enumeration:

    *
  • 3

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getZ_pixel_offsetAttributeAxis(); /** *

*

Enumeration:

    *
  • 3

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param axis the axis */ @Deprecated public void setZ_pixel_offsetAttributeAxis(Long axis); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @return the value. */ @Deprecated public Long getZ_pixel_offsetAttributePrimary(); /** *

*

Enumeration:

    *
  • 1

*

* * @deprecated see: https://github.com/nexusformat/definitions/issues/436 * @param primary the primary */ @Deprecated public void setZ_pixel_offsetAttributePrimary(Long primary); /** * y-axis offset from detector center * * @return the value. */ public String getZ_pixel_offsetAttributeLong_name(); /** * y-axis offset from detector center * * @param long_name the long_name */ public void setZ_pixel_offsetAttributeLong_name(String long_name); /** * 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; *

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

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

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

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

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

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

* * @param distance the distance */ public DataNode setDistanceScalar(Double distance); /** * 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; *

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* * @param azimuthal_angle the azimuthal_angle */ public DataNode setAzimuthal_angleScalar(Double azimuthal_angle); /** * name/manufacturer/model/etc. information * * @return the value. */ public IDataset getDescription(); /** * name/manufacturer/model/etc. information * * @param description the description */ public DataNode setDescription(IDataset description); /** * name/manufacturer/model/etc. information * * @return the value. */ public String getDescriptionScalar(); /** * name/manufacturer/model/etc. information * * @param description the description */ public DataNode setDescriptionScalar(String description); /** * Serial number for the detector * * @return the value. */ public IDataset getSerial_number(); /** * Serial number for the detector * * @param serial_number the serial_number */ public DataNode setSerial_number(IDataset serial_number); /** * Serial number for the detector * * @return the value. */ public String getSerial_numberScalar(); /** * Serial number for the detector * * @param serial_number the serial_number */ public DataNode setSerial_numberScalar(String serial_number); /** * Local name for the detector * * @return the value. */ public IDataset getLocal_name(); /** * Local name for the detector * * @param local_name the local_name */ public DataNode setLocal_name(IDataset local_name); /** * Local name for the detector * * @return the value. */ public String getLocal_nameScalar(); /** * Local name for the detector * * @param local_name the local_name */ public DataNode setLocal_nameScalar(String local_name); /** * Position and orientation of detector * * @return the value. */ public NXgeometry getGeometry(); /** * Position and orientation of detector * * @param geometry the geometry */ public void setGeometry(NXgeometry geometry); /** * Get a NXgeometry node by name: *
    *
  • * Position and orientation of detector
  • *
* * @param name the name of the node. * @return a map from node names to the NXgeometry for that node. */ public NXgeometry getGeometry(String name); /** * Set a NXgeometry node by name: *
    *
  • * Position and orientation of detector
  • *
* * @param name the name of the node * @param geometry the value to set */ public void setGeometry(String name, NXgeometry geometry); /** * Get all NXgeometry nodes: *
    *
  • * Position and orientation of detector
  • *
* * @return a map from node names to the NXgeometry for that node. */ public Map getAllGeometry(); /** * Set multiple child nodes of a particular type. *
    *
  • * Position and orientation of detector
  • *
* * @param geometry the child nodes to add */ public void setAllGeometry(Map geometry); /** * Solid angle subtended by the detector at the sample *

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

* * @return the value. */ public IDataset getSolid_angle(); /** * Solid angle subtended by the detector at the sample *

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

* * @param solid_angle the solid_angle */ public DataNode setSolid_angle(IDataset solid_angle); /** * Solid angle subtended by the detector at the sample *

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

* * @return the value. */ public Double getSolid_angleScalar(); /** * Solid angle subtended by the detector at the sample *

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

* * @param solid_angle the solid_angle */ public DataNode setSolid_angleScalar(Double solid_angle); /** * 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; *

* * @return the value. */ public IDataset getX_pixel_size(); /** * Size of each detector pixel. If it is scalar all pixels are the same size. *

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

* * @param x_pixel_size the x_pixel_size */ public DataNode setX_pixel_size(IDataset x_pixel_size); /** * Size of each detector pixel. If it is scalar all pixels are the same size. *

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

* * @return the value. */ public Double getX_pixel_sizeScalar(); /** * Size of each detector pixel. If it is scalar all pixels are the same size. *

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

* * @param x_pixel_size the x_pixel_size */ public DataNode setX_pixel_sizeScalar(Double x_pixel_size); /** * Size of each detector pixel. If it is scalar all pixels are the same size *

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

* * @return the value. */ public IDataset getY_pixel_size(); /** * Size of each detector pixel. If it is scalar all pixels are the same size *

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

* * @param y_pixel_size the y_pixel_size */ public DataNode setY_pixel_size(IDataset y_pixel_size); /** * Size of each detector pixel. If it is scalar all pixels are the same size *

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

* * @return the value. */ public Double getY_pixel_sizeScalar(); /** * Size of each detector pixel. If it is scalar all pixels are the same size *

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

* * @param y_pixel_size the y_pixel_size */ public DataNode setY_pixel_sizeScalar(Double y_pixel_size); /** * Detector dead time *

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

* * @return the value. */ public IDataset getDead_time(); /** * Detector dead time *

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

* * @param dead_time the dead_time */ public DataNode setDead_time(IDataset dead_time); /** * Detector dead time *

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

* * @return the value. */ public Double getDead_timeScalar(); /** * Detector dead time *

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

* * @param dead_time the dead_time */ public DataNode setDead_timeScalar(Double dead_time); /** * Detector gas pressure *

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

* * @return the value. */ public IDataset getGas_pressure(); /** * Detector gas pressure *

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

* * @param gas_pressure the gas_pressure */ public DataNode setGas_pressure(IDataset gas_pressure); /** * Detector gas pressure *

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

* * @return the value. */ public Double getGas_pressureScalar(); /** * Detector gas pressure *

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

* * @param gas_pressure the gas_pressure */ public DataNode setGas_pressureScalar(Double gas_pressure); /** * maximum drift space dimension *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public IDataset getDetection_gas_path(); /** * maximum drift space dimension *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param detection_gas_path the detection_gas_path */ public DataNode setDetection_gas_path(IDataset detection_gas_path); /** * maximum drift space dimension *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getDetection_gas_pathScalar(); /** * maximum drift space dimension *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param detection_gas_path the detection_gas_path */ public DataNode setDetection_gas_pathScalar(Double detection_gas_path); /** * Crate number of detector *

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

* * @return the value. */ public IDataset getCrate(); /** * Crate number of detector *

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

* * @param crate the crate */ public DataNode setCrate(IDataset crate); /** * Crate number of detector *

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

* * @return the value. */ public Long getCrateScalar(); /** * Crate number of detector *

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

* * @param crate the crate */ public DataNode setCrateScalar(Long crate); /** * Equivalent local term * * @return the value. */ public String getCrateAttributeLocal_name(); /** * Equivalent local term * * @param local_name the local_name */ public void setCrateAttributeLocal_name(String local_name); /** * Slot number of detector *

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

* * @return the value. */ public IDataset getSlot(); /** * Slot number of detector *

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

* * @param slot the slot */ public DataNode setSlot(IDataset slot); /** * Slot number of detector *

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

* * @return the value. */ public Long getSlotScalar(); /** * Slot number of detector *

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

* * @param slot the slot */ public DataNode setSlotScalar(Long slot); /** * Equivalent local term * * @return the value. */ public String getSlotAttributeLocal_name(); /** * Equivalent local term * * @param local_name the local_name */ public void setSlotAttributeLocal_name(String local_name); /** * Input number of detector *

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

* * @return the value. */ public IDataset getInput(); /** * Input number of detector *

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

* * @param input the input */ public DataNode setInput(IDataset input); /** * Input number of detector *

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

* * @return the value. */ public Long getInputScalar(); /** * Input number of detector *

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

* * @param input the input */ public DataNode setInputScalar(Long input); /** * Equivalent local term * * @return the value. */ public String getInputAttributeLocal_name(); /** * Equivalent local term * * @param local_name the local_name */ public void setInputAttributeLocal_name(String local_name); /** * Description of type such as He3 gas cylinder, He3 PSD, scintillator, * fission chamber, proportion counter, ion chamber, ccd, pixel, image plate, * CMOS, ... * * @return the value. */ public IDataset getType(); /** * Description of type such as He3 gas cylinder, He3 PSD, scintillator, * fission chamber, proportion counter, ion chamber, ccd, pixel, image plate, * CMOS, ... * * @param type the type */ public 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, ... * * @return the value. */ public String getTypeScalar(); /** * Description of type such as He3 gas cylinder, He3 PSD, scintillator, * fission chamber, proportion counter, ion chamber, ccd, pixel, image plate, * CMOS, ... * * @param type the type */ public DataNode setTypeScalar(String type); /** * Spectral efficiency of detector with respect to e.g. wavelength * * @return the value. */ public NXdata getEfficiency(); /** * Spectral efficiency of detector with respect to e.g. wavelength * * @param efficiency the efficiency */ public void setEfficiency(NXdata efficiency); /** * date of last calibration (geometry and/or efficiency) measurements *

* Type: NX_DATE_TIME *

* * @return the value. */ public IDataset getCalibration_date(); /** * date of last calibration (geometry and/or efficiency) measurements *

* Type: NX_DATE_TIME *

* * @param calibration_date the calibration_date */ public DataNode setCalibration_date(IDataset calibration_date); /** * date of last calibration (geometry and/or efficiency) measurements *

* Type: NX_DATE_TIME *

* * @return the value. */ public Date getCalibration_dateScalar(); /** * date of last calibration (geometry and/or efficiency) measurements *

* Type: NX_DATE_TIME *

* * @param calibration_date the calibration_date */ public DataNode setCalibration_dateScalar(Date calibration_date); /** * summary of conversion of array data to pixels (e.g. polynomial * approximations) and location of details of the calibrations * * @return the value. */ public NXnote getCalibration_method(); /** * summary of conversion of array data to pixels (e.g. polynomial * approximations) and location of details of the calibrations * * @param calibration_method the calibration_method */ public void setCalibration_method(NXnote calibration_method); /** * How the detector is represented *

*

Enumeration:

    *
  • point
  • *
  • linear
  • *
  • area

*

* * @return the value. */ public IDataset getLayout(); /** * How the detector is represented *

*

Enumeration:

    *
  • point
  • *
  • linear
  • *
  • area

*

* * @param layout the layout */ public DataNode setLayout(IDataset layout); /** * How the detector is represented *

*

Enumeration:

    *
  • point
  • *
  • linear
  • *
  • area

*

* * @return the value. */ public String getLayoutScalar(); /** * How the detector is represented *

*

Enumeration:

    *
  • point
  • *
  • linear
  • *
  • area

*

* * @param layout the layout */ public DataNode setLayoutScalar(String layout); /** * Elapsed actual counting time *

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

* * @return the value. */ public IDataset getCount_time(); /** * Elapsed actual counting time *

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

* * @param count_time the count_time */ public DataNode setCount_time(IDataset count_time); /** * Elapsed actual counting time *

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

* * @return the value. */ public Number getCount_timeScalar(); /** * Elapsed actual counting time *

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

* * @param count_time the count_time */ public DataNode setCount_timeScalar(Number count_time); /** * * @return the value. */ public NXnote getData_file(); /** * * @param data_file the data_file */ public void setData_file(NXnote data_file); /** * Use this group to provide other data related to this NXdetector group. * * @return the value. */ public NXcollection getCollection(); /** * Use this group to provide other data related to this NXdetector group. * * @param collection the collection */ public void setCollection(NXcollection collection); /** * Get a NXcollection node by name: *
    *
  • * Use this group to provide other data related to this NXdetector group.
  • *
* * @param name the name of the node. * @return a map from node names to the NXcollection for that node. */ public NXcollection getCollection(String name); /** * Set a NXcollection node by name: *
    *
  • * Use this group to provide other data related to this NXdetector group.
  • *
* * @param name the name of the node * @param collection the value to set */ public void setCollection(String name, NXcollection collection); /** * Get all NXcollection nodes: *
    *
  • * Use this group to provide other data related to this NXdetector group.
  • *
* * @return a map from node names to the NXcollection for that node. */ public Map getAllCollection(); /** * Set multiple child nodes of a particular type. *
    *
  • * Use this group to provide other data related to this NXdetector group.
  • *
* * @param collection the child nodes to add */ public void setAllCollection(Map collection); /** * 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; *

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

* Type: NX_INT * Dimensions: 1: nBrightFrames; *

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

* Type: NX_INT * Dimensions: 1: nBrightFrames; *

* * @return the value. */ public Long getSequence_numberScalar(); /** * In order to properly sort the order of the images taken in (for * example) a tomography experiment, a sequence number is stored with each * image. *

* Type: NX_INT * Dimensions: 1: nBrightFrames; *

* * @param sequence_number the sequence_number */ public DataNode setSequence_numberScalar(Long sequence_number); /** * 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 *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getBeam_center_xScalar(); /** * This is the x position where the direct beam would hit the detector. * This is a length and can be outside of the actual * detector. The length can be in physical units or pixels * as documented by the units attribute. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param beam_center_x the beam_center_x */ public DataNode setBeam_center_xScalar(Double beam_center_x); /** * 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 *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getBeam_center_yScalar(); /** * This is the y position where the direct beam would hit the detector. * This is a length and can be outside of the actual * detector. The length can be in physical units or pixels * as documented by the units attribute. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param beam_center_y the beam_center_y */ public DataNode setBeam_center_yScalar(Double beam_center_y); /** * 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 *

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

* Type: NX_INT *

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

* Type: NX_INT *

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

* Type: NX_INT *

* * @param frame_start_number the frame_start_number */ public DataNode setFrame_start_numberScalar(Long frame_start_number); /** * The diameter of a cylindrical detector *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public IDataset getDiameter(); /** * The diameter of a cylindrical detector *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param diameter the diameter */ public DataNode setDiameter(IDataset diameter); /** * The diameter of a cylindrical detector *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getDiameterScalar(); /** * The diameter of a cylindrical detector *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param diameter the diameter */ public DataNode setDiameterScalar(Double diameter); /** * The acquisition mode of the detector. *

* Type: NX_CHAR *

Enumeration:

    *
  • gated
  • *
  • triggered
  • *
  • summed
  • *
  • event
  • *
  • histogrammed
  • *
  • decimated

*

* * @return the value. */ public IDataset getAcquisition_mode(); /** * The acquisition mode of the detector. *

* Type: NX_CHAR *

Enumeration:

    *
  • gated
  • *
  • triggered
  • *
  • summed
  • *
  • event
  • *
  • histogrammed
  • *
  • decimated

*

* * @param acquisition_mode the acquisition_mode */ public DataNode setAcquisition_mode(IDataset acquisition_mode); /** * The acquisition mode of the detector. *

* Type: NX_CHAR *

Enumeration:

    *
  • gated
  • *
  • triggered
  • *
  • summed
  • *
  • event
  • *
  • histogrammed
  • *
  • decimated

*

* * @return the value. */ public String getAcquisition_modeScalar(); /** * The acquisition mode of the detector. *

* Type: NX_CHAR *

Enumeration:

    *
  • gated
  • *
  • triggered
  • *
  • summed
  • *
  • event
  • *
  • histogrammed
  • *
  • decimated

*

* * @param acquisition_mode the acquisition_mode */ public DataNode setAcquisition_modeScalar(String acquisition_mode); /** * True when the angular calibration has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public IDataset getAngular_calibration_applied(); /** * True when the angular calibration has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param angular_calibration_applied the angular_calibration_applied */ public DataNode setAngular_calibration_applied(IDataset angular_calibration_applied); /** * True when the angular calibration has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public Boolean getAngular_calibration_appliedScalar(); /** * True when the angular calibration has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param angular_calibration_applied the angular_calibration_applied */ public DataNode setAngular_calibration_appliedScalar(Boolean angular_calibration_applied); /** * Angular calibration data. *

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

* * @return the value. */ public IDataset getAngular_calibration(); /** * Angular calibration data. *

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

* * @param angular_calibration the angular_calibration */ public DataNode setAngular_calibration(IDataset angular_calibration); /** * Angular calibration data. *

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

* * @return the value. */ public Double getAngular_calibrationScalar(); /** * Angular calibration data. *

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

* * @param angular_calibration the angular_calibration */ public DataNode setAngular_calibrationScalar(Double angular_calibration); /** * True when the flat field correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public IDataset getFlatfield_applied(); /** * True when the flat field correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param flatfield_applied the flatfield_applied */ public DataNode setFlatfield_applied(IDataset flatfield_applied); /** * True when the flat field correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public Boolean getFlatfield_appliedScalar(); /** * True when the flat field correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param flatfield_applied the flatfield_applied */ public DataNode setFlatfield_appliedScalar(Boolean flatfield_applied); /** * Flat field correction data. *

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

* * @return the value. */ public IDataset getFlatfield(); /** * Flat field correction data. *

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

* * @param flatfield the flatfield */ public DataNode setFlatfield(IDataset flatfield); /** * Flat field correction data. *

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

* * @return the value. */ public Double getFlatfieldScalar(); /** * Flat field correction data. *

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

* * @param flatfield the flatfield */ public DataNode setFlatfieldScalar(Double flatfield); /** * Errors of the flat field correction data. *

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

* * @return the value. */ public IDataset getFlatfield_error(); /** * Errors of the flat field correction data. *

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

* * @param flatfield_error the flatfield_error */ public DataNode setFlatfield_error(IDataset flatfield_error); /** * Errors of the flat field correction data. *

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

* * @return the value. */ public Double getFlatfield_errorScalar(); /** * Errors of the flat field correction data. *

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

* * @param flatfield_error the flatfield_error */ public DataNode setFlatfield_errorScalar(Double flatfield_error); /** * True when the pixel mask correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public IDataset getPixel_mask_applied(); /** * True when the pixel mask correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param pixel_mask_applied the pixel_mask_applied */ public DataNode setPixel_mask_applied(IDataset pixel_mask_applied); /** * True when the pixel mask correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public Boolean getPixel_mask_appliedScalar(); /** * True when the pixel mask correction has been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param pixel_mask_applied the pixel_mask_applied */ public DataNode setPixel_mask_appliedScalar(Boolean pixel_mask_applied); /** * 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; *

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

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

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

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

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

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

* * @param pixel_mask the pixel_mask */ public DataNode setPixel_maskScalar(Long pixel_mask); /** * True when a count-rate correction has already been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @return the value. */ public IDataset getCountrate_correction__applied(); /** * True when a count-rate correction has already been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

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

* Type: NX_BOOLEAN *

* * @return the value. */ public Boolean getCountrate_correction__appliedScalar(); /** * True when a count-rate correction has already been applied in the * electronics, false otherwise. *

* Type: NX_BOOLEAN *

* * @param countrate_correction__applied the countrate_correction__applied */ public DataNode setCountrate_correction__appliedScalar(Boolean countrate_correction__applied); /** * 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 *

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

* Type: NX_INT *

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

* Type: NX_INT *

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

* Type: NX_INT *

* * @param bit_depth_readout the bit_depth_readout */ public DataNode setBit_depth_readoutScalar(Long bit_depth_readout); /** * Time it takes to read the detector (typically milliseconds). * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @return the value. */ public IDataset getDetector_readout_time(); /** * Time it takes to read the detector (typically milliseconds). * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

* * @return the value. */ public Double getDetector_readout_timeScalar(); /** * Time it takes to read the detector (typically milliseconds). * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @param detector_readout_time the detector_readout_time */ public DataNode setDetector_readout_timeScalar(Double detector_readout_time); /** * Time it takes to start exposure after a trigger signal has been received. * This is the reaction time of the detector firmware after receiving the trigger signal * to when the detector starts to acquire the exposure, including any user set delay.. * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

* * @param trigger_delay_time the trigger_delay_time */ public DataNode setTrigger_delay_timeScalar(Double trigger_delay_time); /** * User-specified trigger delay. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @return the value. */ public IDataset getTrigger_delay_time_set(); /** * User-specified trigger delay. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @param trigger_delay_time_set the trigger_delay_time_set */ public DataNode setTrigger_delay_time_set(IDataset trigger_delay_time_set); /** * User-specified trigger delay. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @return the value. */ public Double getTrigger_delay_time_setScalar(); /** * User-specified trigger delay. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @param trigger_delay_time_set the trigger_delay_time_set */ public DataNode setTrigger_delay_time_setScalar(Double trigger_delay_time_set); /** * 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 *

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

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

* * @param trigger_internal_delay_time the trigger_internal_delay_time */ public DataNode setTrigger_internal_delay_timeScalar(Double trigger_internal_delay_time); /** * Time during which no new trigger signal can be accepted. * Typically this is the * trigger_delay_time + exposure_time + readout_time. * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

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

* Type: NX_FLOAT * Units: NX_TIME *

* * @return the value. */ public Double getTrigger_dead_timeScalar(); /** * Time during which no new trigger signal can be accepted. * Typically this is the * trigger_delay_time + exposure_time + readout_time. * This is important to know for time resolved experiments. *

* Type: NX_FLOAT * Units: NX_TIME *

* * @param trigger_dead_time the trigger_dead_time */ public DataNode setTrigger_dead_timeScalar(Double trigger_dead_time); /** * This is time for each frame. This is exposure_time + readout time. *

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

* * @return the value. */ public IDataset getFrame_time(); /** * This is time for each frame. This is exposure_time + readout time. *

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

* * @param frame_time the frame_time */ public DataNode setFrame_time(IDataset frame_time); /** * This is time for each frame. This is exposure_time + readout time. *

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

* * @return the value. */ public Double getFrame_timeScalar(); /** * This is time for each frame. This is exposure_time + readout time. *

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

* * @param frame_time the frame_time */ public DataNode setFrame_timeScalar(Double frame_time); /** * The gain setting of the detector. This influences background etc. *

* Type: NX_CHAR *

Enumeration:

    *
  • high
  • *
  • standard
  • *
  • fast
  • *
  • auto

*

* * @return the value. */ public IDataset getGain_setting(); /** * The gain setting of the detector. This influences background etc. *

* Type: NX_CHAR *

Enumeration:

    *
  • high
  • *
  • standard
  • *
  • fast
  • *
  • auto

*

* * @param gain_setting the gain_setting */ public DataNode setGain_setting(IDataset gain_setting); /** * The gain setting of the detector. This influences background etc. *

* Type: NX_CHAR *

Enumeration:

    *
  • high
  • *
  • standard
  • *
  • fast
  • *
  • auto

*

* * @return the value. */ public String getGain_settingScalar(); /** * The gain setting of the detector. This influences background etc. *

* Type: NX_CHAR *

Enumeration:

    *
  • high
  • *
  • standard
  • *
  • fast
  • *
  • auto

*

* * @param gain_setting the gain_setting */ public DataNode setGain_settingScalar(String gain_setting); /** * 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 *

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

* Type: NX_INT *

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

* Type: NX_INT *

* * @return the value. */ public Long getSaturation_valueScalar(); /** * The value at which the detector goes into saturation. * Especially common to CCD detectors, the data * is known to be invalid above this value. *

* Type: NX_INT *

* * @param saturation_value the saturation_value */ public DataNode setSaturation_valueScalar(Long saturation_value); /** * 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 *

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

* Type: NX_INT *

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

* Type: NX_INT *

* * @return the value. */ public Long getNumber_of_cyclesScalar(); /** * CCD images are sometimes constructed by summing * together multiple short exposures in the * electronics. This reduces background etc. * This is the number of short exposures used to sum * images for an image. *

* Type: NX_INT *

* * @param number_of_cycles the number_of_cycles */ public DataNode setNumber_of_cyclesScalar(Long number_of_cycles); /** * 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 *

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

* Type: NX_CHAR *

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

* Type: NX_CHAR *

* * @return the value. */ public String getSensor_materialScalar(); /** * At times, radiation is not directly sensed by the detector. * Rather, the detector might sense the output from some * converter like a scintillator. * This is the name of this converter material. *

* Type: NX_CHAR *

* * @param sensor_material the sensor_material */ public DataNode setSensor_materialScalar(String sensor_material); /** * At times, radiation is not directly sensed by the detector. * Rather, the detector might sense the output from some * converter like a scintillator. * This is the thickness of this converter material. *

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

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

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @return the value. */ public Double getSensor_thicknessScalar(); /** * At times, radiation is not directly sensed by the detector. * Rather, the detector might sense the output from some * converter like a scintillator. * This is the thickness of this converter material. *

* Type: NX_FLOAT * Units: NX_LENGTH *

* * @param sensor_thickness the sensor_thickness */ public DataNode setSensor_thicknessScalar(Double sensor_thickness); /** * 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 *

* * @return the value. */ public IDataset getThreshold_energy(); /** * Single photon counter detectors can be adjusted * for a certain energy range in which they * work optimally. This is the energy setting for this. *

* Type: NX_FLOAT * Units: NX_ENERGY *

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

* Type: NX_FLOAT * Units: NX_ENERGY *

* * @return the value. */ public Double getThreshold_energyScalar(); /** * Single photon counter detectors can be adjusted * for a certain energy range in which they * work optimally. This is the energy setting for this. *

* Type: NX_FLOAT * Units: NX_ENERGY *

* * @param threshold_energy the threshold_energy */ public DataNode setThreshold_energyScalar(Double threshold_energy); /** * 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. * * @return the value. */ public NXdetector_module getDetector_module(); /** * For use in special cases where the data in NXdetector * is represented in several parts, each with a separate geometry. * Use one or more instances of the NXdetector_module * group to declare regions of interest or some other * subdivision of a detector. * * @param detector_module the detector_module */ public void setDetector_module(NXdetector_module detector_module); /** * 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.
  • *
* * @param name the name of the node. * @return a map from node names to the NXdetector_module for that node. */ public NXdetector_module getDetector_module(String name); /** * 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.
  • *
* * @param name the name of the node * @param detector_module the value to set */ public void setDetector_module(String name, NXdetector_module detector_module); /** * Get all NXdetector_module nodes: *
    *
  • * For use in special cases where the data in NXdetector * is represented in several parts, each with a separate geometry. * Use one or more instances of the NXdetector_module * group to declare regions of interest or some other * subdivision of a detector.
  • *
* * @return a map from node names to the NXdetector_module for that node. */ public Map getAllDetector_module(); /** * Set multiple child nodes of a particular type. *
    *
  • * For use in special cases where the data in NXdetector * is represented in several parts, each with a separate geometry. * Use one or more instances of the NXdetector_module * group to declare regions of interest or some other * subdivision of a detector.
  • *
* * @param detector_module the child nodes to add */ public void setAllDetector_module(Map detector_module); // Unprocessed choice: pixel_shape // Unprocessed choice: detector_shape }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy