Package org.eclipse.dawnsci.nexus

Interface NXdata

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXobject
public interface NXdata extends NXobject
The :ref:`NXdata` class is designed to encapsulate all the information required for a set of data to be plotted. NXdata groups contain plottable data (also referred to as *signals* or *dependent variables*) and their associated axis coordinates (also referred to as *axes* or *independent variables*). The actual names of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` and :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` fields can be chosen :ref:`freely `, as indicated by the upper case (this is a common convention in all NeXus classes). .. note:: ``NXdata`` provides data and coordinates to be plotted but does not describe how the data is to be plotted or even the dimensionality of the plot. https://www.nexusformat.org/NIAC2018Minutes.html#nxdata-plottype--attribute .. include:: data/index.rst :start-line: 1 .. admonition:: Example of a simple curve plot .. code-block:: data:NXdata

  • Field Details

  • Method Details

    • getAttributeSignal

      String getAttributeSignal()
      .. index:: find the default plottable data .. index:: plotting .. index:: signal attribute value The value is the :ref:`name ` of the signal that contains the default plottable data. This field or link *must* exist and be a direct child of this NXdata group. It is recommended (as of NIAC2014) to use this attribute rather than adding a signal attribute to the field. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.
      Returns:
      the value.

    • setAttributeSignal

      void setAttributeSignal(String signalValue)
      .. index:: find the default plottable data .. index:: plotting .. index:: signal attribute value The value is the :ref:`name ` of the signal that contains the default plottable data. This field or link *must* exist and be a direct child of this NXdata group. It is recommended (as of NIAC2014) to use this attribute rather than adding a signal attribute to the field. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.
      Parameters:
      signalValue - the signalValue

    • getAttributeAuxiliary_signals

      String getAttributeAuxiliary_signals()
      .. index:: plotting Array of strings holding the :ref:`names ` of additional signals to be plotted with the :ref:`default signal invalid input: '<'/NXdata@signal-attribute>`. These fields or links *must* exist and be direct children of this NXdata group. Each auxiliary signal needs to be of the same shape as the default signal. .. NIAC2018: https://www.nexusformat.org/NIAC2018Minutes.html
      Returns:
      the value.

    • setAttributeAuxiliary_signals

      void setAttributeAuxiliary_signals(String auxiliary_signalsValue)
      .. index:: plotting Array of strings holding the :ref:`names ` of additional signals to be plotted with the :ref:`default signal invalid input: '<'/NXdata@signal-attribute>`. These fields or links *must* exist and be direct children of this NXdata group. Each auxiliary signal needs to be of the same shape as the default signal. .. NIAC2018: https://www.nexusformat.org/NIAC2018Minutes.html
      Parameters:
      auxiliary_signalsValue - the auxiliary_signalsValue

    • getAttributeDefault_slice

      String getAttributeDefault_slice()
      Which slice of data to show in a plot by default. This is useful especially for datasets with more than 2 dimensions. Should be an array of length equal to the number of dimensions in the data, with the following possible values: * ".": All the data in this dimension should be included * Integer: Only this slice should be used. * String: Only this slice should be used. Use if ``AXISNAME`` is a string array. Example:: data:NXdata
      Returns:
      the value.

    • setAttributeDefault_slice

      void setAttributeDefault_slice(String default_sliceValue)
      Which slice of data to show in a plot by default. This is useful especially for datasets with more than 2 dimensions. Should be an array of length equal to the number of dimensions in the data, with the following possible values: * ".": All the data in this dimension should be included * Integer: Only this slice should be used. * String: Only this slice should be used. Use if ``AXISNAME`` is a string array. Example:: data:NXdata
      Parameters:
      default_sliceValue - the default_sliceValue

    • getAttributeIndices

      Long getAttributeIndices(String axisname)
      The ``AXISNAME_indices`` attribute is a single integer or an array of integers that defines which :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions are spanned by the corresponding axis. The first dimension index is ``0`` (zero). The number of indices must be equal to the rank of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field. When the ``AXISNAME_indices`` attribute is missing for a given :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field, its value becomes the index (or indices) of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` name in the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute. .. note:: When ``AXISNAME_indices`` contains multiple integers, it must be saved as an actual array of integers and not a comma separated string.
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAttributeIndices

      void setAttributeIndices(String axisname, Long indicesValue)
      The ``AXISNAME_indices`` attribute is a single integer or an array of integers that defines which :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions are spanned by the corresponding axis. The first dimension index is ``0`` (zero). The number of indices must be equal to the rank of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field. When the ``AXISNAME_indices`` attribute is missing for a given :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field, its value becomes the index (or indices) of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` name in the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute. .. note:: When ``AXISNAME_indices`` contains multiple integers, it must be saved as an actual array of integers and not a comma separated string.
      Parameters:
      axisname - the axisname
      indicesValue - the indicesValue

    • getAttributeAxes

      String getAttributeAxes()
      .. index:: plotting The ``axes`` attribute is a list of strings which are the names of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` fields to be used as the default axis along every :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimension. As a result the length must be equal to the rank of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` fields. The string "." can be used for dimensions without a default axis. .. note:: When ``axes`` contains multiple strings, it must be saved as an actual array of strings and not a single comma separated string.

      1: dataRank;

      Returns:
      the value.

    • setAttributeAxes

      void setAttributeAxes(String axesValue)
      .. index:: plotting The ``axes`` attribute is a list of strings which are the names of the :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` fields to be used as the default axis along every :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimension. As a result the length must be equal to the rank of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` fields. The string "." can be used for dimensions without a default axis. .. note:: When ``axes`` contains multiple strings, it must be saved as an actual array of strings and not a single comma separated string.

      1: dataRank;

      Parameters:
      axesValue - the axesValue

    • getAxisname

      org.eclipse.january.dataset.Dataset getAxisname(String axisname)
      Coordinate values along one or more :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions. The shape of an ``AXISNAME`` field must correspond to the shape of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions it spans. This means that for each ``i`` in ``[0, AXISNAME.ndim)`` the number of data points ``DATA.shape[AXISNAME_indices[i]]`` must be equal to the number of coordinates ``AXISNAME.shape[i]`` or the number of bin edges ``AXISNAME.shape[i]+1`` in case of histogram data. As the upper case ``AXISNAME`` indicates, the names of the ``AXISNAME`` fields can be chosen :ref:`freely `. Most ``AXISNAME`` fields will be sequences of numbers but if an axis is better represented using names, such as channel names, an array of NX_CHAR can be provided.

      Type: NX_CHAR_OR_NUMBER

      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisname

      DataNode setAxisname(String axisname, org.eclipse.january.dataset.IDataset axisnameDataset)
      Coordinate values along one or more :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions. The shape of an ``AXISNAME`` field must correspond to the shape of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions it spans. This means that for each ``i`` in ``[0, AXISNAME.ndim)`` the number of data points ``DATA.shape[AXISNAME_indices[i]]`` must be equal to the number of coordinates ``AXISNAME.shape[i]`` or the number of bin edges ``AXISNAME.shape[i]+1`` in case of histogram data. As the upper case ``AXISNAME`` indicates, the names of the ``AXISNAME`` fields can be chosen :ref:`freely `. Most ``AXISNAME`` fields will be sequences of numbers but if an axis is better represented using names, such as channel names, an array of NX_CHAR can be provided.

      Type: NX_CHAR_OR_NUMBER

      Parameters:
      axisname - the axisname
      axisnameDataset - the axisnameDataset

    • getAxisnameScalar

      Object getAxisnameScalar(String axisname)
      Coordinate values along one or more :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions. The shape of an ``AXISNAME`` field must correspond to the shape of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions it spans. This means that for each ``i`` in ``[0, AXISNAME.ndim)`` the number of data points ``DATA.shape[AXISNAME_indices[i]]`` must be equal to the number of coordinates ``AXISNAME.shape[i]`` or the number of bin edges ``AXISNAME.shape[i]+1`` in case of histogram data. As the upper case ``AXISNAME`` indicates, the names of the ``AXISNAME`` fields can be chosen :ref:`freely `. Most ``AXISNAME`` fields will be sequences of numbers but if an axis is better represented using names, such as channel names, an array of NX_CHAR can be provided.

      Type: NX_CHAR_OR_NUMBER

      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameScalar

      DataNode setAxisnameScalar(String axisname, Object axisnameValue)
      Coordinate values along one or more :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions. The shape of an ``AXISNAME`` field must correspond to the shape of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions it spans. This means that for each ``i`` in ``[0, AXISNAME.ndim)`` the number of data points ``DATA.shape[AXISNAME_indices[i]]`` must be equal to the number of coordinates ``AXISNAME.shape[i]`` or the number of bin edges ``AXISNAME.shape[i]+1`` in case of histogram data. As the upper case ``AXISNAME`` indicates, the names of the ``AXISNAME`` fields can be chosen :ref:`freely `. Most ``AXISNAME`` fields will be sequences of numbers but if an axis is better represented using names, such as channel names, an array of NX_CHAR can be provided.

      Type: NX_CHAR_OR_NUMBER

      Parameters:
      axisname - the axisname
      axisname - the axisname

    • getAllAxisname

      Map<String,? extends org.eclipse.january.dataset.IDataset> getAllAxisname()
      Get all Axisname fields: Coordinate values along one or more :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions. The shape of an ``AXISNAME`` field must correspond to the shape of the :ref:`DATA invalid input: '<'/NXdata/DATA-field>` dimensions it spans. This means that for each ``i`` in ``[0, AXISNAME.ndim)`` the number of data points ``DATA.shape[AXISNAME_indices[i]]`` must be equal to the number of coordinates ``AXISNAME.shape[i]`` or the number of bin edges ``AXISNAME.shape[i]+1`` in case of histogram data. As the upper case ``AXISNAME`` indicates, the names of the ``AXISNAME`` fields can be chosen :ref:`freely `. Most ``AXISNAME`` fields will be sequences of numbers but if an axis is better represented using names, such as channel names, an array of NX_CHAR can be provided.

      Type: NX_CHAR_OR_NUMBER

      Note: this method returns ALL datasets within this group.

      Returns:
      a map from node names to the ? extends IDataset for that node.

    • getAxisnameAttributeLong_name

      String getAxisnameAttributeLong_name(String axisname)
      Axis label
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeLong_name

      void setAxisnameAttributeLong_name(String axisname, String long_nameValue)
      Axis label
      Parameters:
      axisname - the axisname
      long_nameValue - the long_nameValue

    • getAxisnameAttributeUnits

      String getAxisnameAttributeUnits(String axisname)
      Unit in which the coordinate values are expressed. See the section :ref:`Design-Units` for more information.
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeUnits

      void setAxisnameAttributeUnits(String axisname, String unitsValue)
      Unit in which the coordinate values are expressed. See the section :ref:`Design-Units` for more information.
      Parameters:
      axisname - the axisname
      unitsValue - the unitsValue

    • getAxisnameAttributeDistribution

      Boolean getAxisnameAttributeDistribution(String axisname)
      ``0|false``: single value, ``1|true``: multiple values
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeDistribution

      void setAxisnameAttributeDistribution(String axisname, Boolean distributionValue)
      ``0|false``: single value, ``1|true``: multiple values
      Parameters:
      axisname - the axisname
      distributionValue - the distributionValue

    • getAxisnameAttributeFirst_good

      Long getAxisnameAttributeFirst_good(String axisname)
      Index of first good value
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeFirst_good

      void setAxisnameAttributeFirst_good(String axisname, Long first_goodValue)
      Index of first good value
      Parameters:
      axisname - the axisname
      first_goodValue - the first_goodValue

    • getAxisnameAttributeLast_good

      Long getAxisnameAttributeLast_good(String axisname)
      Index of last good value
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeLast_good

      void setAxisnameAttributeLast_good(String axisname, Long last_goodValue)
      Index of last good value
      Parameters:
      axisname - the axisname
      last_goodValue - the last_goodValue

    • getAxisnameAttributeAxis

      @Deprecated Long getAxisnameAttributeAxis(String axisname)
      Deprecated.
      Use the group ``axes`` attribute (NIAC2014)
      Index (positive integer) identifying this specific set of numbers. N.B. The ``axis`` attribute is the old way of designating a link. Do not use the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute with the ``axis`` attribute. The :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute is now preferred.
      Parameters:
      axisname - the axisname
      Returns:
      the value.

    • setAxisnameAttributeAxis

      @Deprecated void setAxisnameAttributeAxis(String axisname, Long axisValue)
      Deprecated.
      Use the group ``axes`` attribute (NIAC2014)
      Index (positive integer) identifying this specific set of numbers. N.B. The ``axis`` attribute is the old way of designating a link. Do not use the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute with the ``axis`` attribute. The :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute is now preferred.
      Parameters:
      axisname - the axisname
      axisValue - the axisValue

    • getData

      org.eclipse.january.dataset.Dataset getData(String data)
      .. index:: plotting Data values to be used as the NeXus *plottable data*. As the upper case ``DATA`` indicates, the names of the ``DATA`` fields can be chosen :ref:`freely `. The :ref:`signal attribute invalid input: '<'/NXdata@signal-attribute>` and :ref:`auxiliary_signals attributeinvalid input: '<'/NXdata@auxiliary_signals-attribute>` can be used to find all datasets in the ``NXdata`` that contain data values. The maximum rank is ``32`` for compatibility with backend file formats.

      Type: NX_NUMBER Dimensions:

      Parameters:
      data - the data
      Returns:
      the value.

    • setData

      DataNode setData(String data, org.eclipse.january.dataset.IDataset dataDataset)
      .. index:: plotting Data values to be used as the NeXus *plottable data*. As the upper case ``DATA`` indicates, the names of the ``DATA`` fields can be chosen :ref:`freely `. The :ref:`signal attribute invalid input: '<'/NXdata@signal-attribute>` and :ref:`auxiliary_signals attributeinvalid input: '<'/NXdata@auxiliary_signals-attribute>` can be used to find all datasets in the ``NXdata`` that contain data values. The maximum rank is ``32`` for compatibility with backend file formats.

      Type: NX_NUMBER Dimensions:

      Parameters:
      data - the data
      dataDataset - the dataDataset

    • getDataScalar

      Number getDataScalar(String data)
      .. index:: plotting Data values to be used as the NeXus *plottable data*. As the upper case ``DATA`` indicates, the names of the ``DATA`` fields can be chosen :ref:`freely `. The :ref:`signal attribute invalid input: '<'/NXdata@signal-attribute>` and :ref:`auxiliary_signals attributeinvalid input: '<'/NXdata@auxiliary_signals-attribute>` can be used to find all datasets in the ``NXdata`` that contain data values. The maximum rank is ``32`` for compatibility with backend file formats.

      Type: NX_NUMBER Dimensions:

      Parameters:
      data - the data
      Returns:
      the value.

    • setDataScalar

      DataNode setDataScalar(String data, Number dataValue)
      .. index:: plotting Data values to be used as the NeXus *plottable data*. As the upper case ``DATA`` indicates, the names of the ``DATA`` fields can be chosen :ref:`freely `. The :ref:`signal attribute invalid input: '<'/NXdata@signal-attribute>` and :ref:`auxiliary_signals attributeinvalid input: '<'/NXdata@auxiliary_signals-attribute>` can be used to find all datasets in the ``NXdata`` that contain data values. The maximum rank is ``32`` for compatibility with backend file formats.

      Type: NX_NUMBER Dimensions:

      Parameters:
      data - the data
      data - the data

    • getAllData

      Map<String,? extends org.eclipse.january.dataset.IDataset> getAllData()
      Get all Data fields: .. index:: plotting Data values to be used as the NeXus *plottable data*. As the upper case ``DATA`` indicates, the names of the ``DATA`` fields can be chosen :ref:`freely `. The :ref:`signal attribute invalid input: '<'/NXdata@signal-attribute>` and :ref:`auxiliary_signals attributeinvalid input: '<'/NXdata@auxiliary_signals-attribute>` can be used to find all datasets in the ``NXdata`` that contain data values. The maximum rank is ``32`` for compatibility with backend file formats.

      Type: NX_NUMBER Dimensions:

      Note: this method returns ALL datasets within this group.

      Returns:
      a map from node names to the ? extends IDataset for that node.

    • getDataAttributeSignal

      @Deprecated Long getDataAttributeSignal(String data)
      Deprecated.
      Use the group ``signal`` attribute (NIAC2014)
      .. index:: plotting Plottable (independent) axis, indicate index number. Only one field in a :ref:`NXdata` group may have the ``signal=1`` attribute. Do not use the ``signal`` attribute with the ``axis`` attribute.
      Parameters:
      data - the data
      Returns:
      the value.

    • setDataAttributeSignal

      @Deprecated void setDataAttributeSignal(String data, Long signalValue)
      Deprecated.
      Use the group ``signal`` attribute (NIAC2014)
      .. index:: plotting Plottable (independent) axis, indicate index number. Only one field in a :ref:`NXdata` group may have the ``signal=1`` attribute. Do not use the ``signal`` attribute with the ``axis`` attribute.
      Parameters:
      data - the data
      signalValue - the signalValue

    • getDataAttributeAxes

      @Deprecated String getDataAttributeAxes(String data)
      Deprecated.
      Use the group ``axes`` attribute (NIAC2014)
      Defines the names of the coordinates (independent axes) for this data set as a colon-delimited array. NOTE: The :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute is the preferred method of designating a link. Do not use the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute with the ``axis`` attribute.
      Parameters:
      data - the data
      Returns:
      the value.

    • setDataAttributeAxes

      @Deprecated void setDataAttributeAxes(String data, String axesValue)
      Deprecated.
      Use the group ``axes`` attribute (NIAC2014)
      Defines the names of the coordinates (independent axes) for this data set as a colon-delimited array. NOTE: The :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute is the preferred method of designating a link. Do not use the :ref:`axes invalid input: '<'/NXdata@axes-attribute>` attribute with the ``axis`` attribute.
      Parameters:
      data - the data
      axesValue - the axesValue

    • getDataAttributeLong_name

      String getDataAttributeLong_name(String data)
      data label
      Parameters:
      data - the data
      Returns:
      the value.

    • setDataAttributeLong_name

      void setDataAttributeLong_name(String data, String long_nameValue)
      data label
      Parameters:
      data - the data
      long_nameValue - the long_nameValue

    • getFieldname_errors

      org.eclipse.january.dataset.Dataset getFieldname_errors()
      "Errors" (meaning *uncertainties* or *standard deviations*) associated with any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The dimensions of the ``FIELDNAME_errors`` field must match the dimensions of the corresponding ``FIELDNAME`` field.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_errors

      DataNode setFieldname_errors(org.eclipse.january.dataset.IDataset fieldname_errorsDataset)
      "Errors" (meaning *uncertainties* or *standard deviations*) associated with any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The dimensions of the ``FIELDNAME_errors`` field must match the dimensions of the corresponding ``FIELDNAME`` field.

      Type: NX_NUMBER

      Parameters:
      fieldname_errorsDataset - the fieldname_errorsDataset

    • getFieldname_errorsScalar

      Number getFieldname_errorsScalar()
      "Errors" (meaning *uncertainties* or *standard deviations*) associated with any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The dimensions of the ``FIELDNAME_errors`` field must match the dimensions of the corresponding ``FIELDNAME`` field.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_errorsScalar

      DataNode setFieldname_errorsScalar(Number fieldname_errorsValue)
      "Errors" (meaning *uncertainties* or *standard deviations*) associated with any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The dimensions of the ``FIELDNAME_errors`` field must match the dimensions of the corresponding ``FIELDNAME`` field.

      Type: NX_NUMBER

      Parameters:
      fieldname_errors - the fieldname_errors

    • getErrors

      @Deprecated org.eclipse.january.dataset.Dataset getErrors()
      Deprecated.
      Use ``DATA_errors`` instead (NIAC2018)
      Standard deviations of data values - the data array is identified by the group attribute ``signal``. The ``errors`` array must have the same dimensions as ``DATA``. Client is responsible for defining the dimensions of the data.

      Type: NX_NUMBER Dimensions:

      Returns:
      the value.

    • setErrors

      @Deprecated DataNode setErrors(org.eclipse.january.dataset.IDataset errorsDataset)
      Deprecated.
      Use ``DATA_errors`` instead (NIAC2018)
      Standard deviations of data values - the data array is identified by the group attribute ``signal``. The ``errors`` array must have the same dimensions as ``DATA``. Client is responsible for defining the dimensions of the data.

      Type: NX_NUMBER Dimensions:

      Parameters:
      errorsDataset - the errorsDataset

    • getErrorsScalar

      @Deprecated Number getErrorsScalar()
      Deprecated.
      Use ``DATA_errors`` instead (NIAC2018)
      Standard deviations of data values - the data array is identified by the group attribute ``signal``. The ``errors`` array must have the same dimensions as ``DATA``. Client is responsible for defining the dimensions of the data.

      Type: NX_NUMBER Dimensions:

      Returns:
      the value.

    • setErrorsScalar

      @Deprecated DataNode setErrorsScalar(Number errorsValue)
      Deprecated.
      Use ``DATA_errors`` instead (NIAC2018)
      Standard deviations of data values - the data array is identified by the group attribute ``signal``. The ``errors`` array must have the same dimensions as ``DATA``. Client is responsible for defining the dimensions of the data.

      Type: NX_NUMBER Dimensions:

      Parameters:
      errors - the errors

    • getFieldname_scaling_factor

      org.eclipse.january.dataset.Dataset getFieldname_scaling_factor()
      An optional scaling factor to apply to the values in any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The elements stored in NXdata datasets are often stored as integers for efficiency reasons and need further correction or conversion, generating floats. For example, raw values could be stored from a device that need to be converted to values that represent the physical values. The two fields FIELDNAME_scaling_factor and FIELDNAME_offset allow linear corrections using the following convention: .. code-block:: corrected values = (FIELDNAME + offset) * scaling_factor This formula will derive the values to use in downstream applications, when necessary. When omitted, the scaling factor is assumed to be 1.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_scaling_factor

      DataNode setFieldname_scaling_factor(org.eclipse.january.dataset.IDataset fieldname_scaling_factorDataset)
      An optional scaling factor to apply to the values in any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The elements stored in NXdata datasets are often stored as integers for efficiency reasons and need further correction or conversion, generating floats. For example, raw values could be stored from a device that need to be converted to values that represent the physical values. The two fields FIELDNAME_scaling_factor and FIELDNAME_offset allow linear corrections using the following convention: .. code-block:: corrected values = (FIELDNAME + offset) * scaling_factor This formula will derive the values to use in downstream applications, when necessary. When omitted, the scaling factor is assumed to be 1.

      Type: NX_NUMBER

      Parameters:
      fieldname_scaling_factorDataset - the fieldname_scaling_factorDataset

    • getFieldname_scaling_factorScalar

      Number getFieldname_scaling_factorScalar()
      An optional scaling factor to apply to the values in any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The elements stored in NXdata datasets are often stored as integers for efficiency reasons and need further correction or conversion, generating floats. For example, raw values could be stored from a device that need to be converted to values that represent the physical values. The two fields FIELDNAME_scaling_factor and FIELDNAME_offset allow linear corrections using the following convention: .. code-block:: corrected values = (FIELDNAME + offset) * scaling_factor This formula will derive the values to use in downstream applications, when necessary. When omitted, the scaling factor is assumed to be 1.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_scaling_factorScalar

      DataNode setFieldname_scaling_factorScalar(Number fieldname_scaling_factorValue)
      An optional scaling factor to apply to the values in any field named ``FIELDNAME`` in this ``NXdata`` group. This can be a :ref:`DATA invalid input: '<'/NXdata/DATA-field>` field (signal or auxiliary signal) or a :ref:`AXISNAME invalid input: '<'/NXdata/AXISNAME-field>` field (axis). The elements stored in NXdata datasets are often stored as integers for efficiency reasons and need further correction or conversion, generating floats. For example, raw values could be stored from a device that need to be converted to values that represent the physical values. The two fields FIELDNAME_scaling_factor and FIELDNAME_offset allow linear corrections using the following convention: .. code-block:: corrected values = (FIELDNAME + offset) * scaling_factor This formula will derive the values to use in downstream applications, when necessary. When omitted, the scaling factor is assumed to be 1.

      Type: NX_NUMBER

      Parameters:
      fieldname_scaling_factor - the fieldname_scaling_factor

    • getFieldname_offset

      org.eclipse.january.dataset.Dataset getFieldname_offset()
      An optional offset to apply to the values in FIELDNAME (usually the signal). When omitted, the offset is assumed to be 0. See :ref:`FIELDNAME_scaling_factor invalid input: '<'/NXdata/FIELDNAME_scaling_factor-field>` for more information.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_offset

      DataNode setFieldname_offset(org.eclipse.january.dataset.IDataset fieldname_offsetDataset)
      An optional offset to apply to the values in FIELDNAME (usually the signal). When omitted, the offset is assumed to be 0. See :ref:`FIELDNAME_scaling_factor invalid input: '<'/NXdata/FIELDNAME_scaling_factor-field>` for more information.

      Type: NX_NUMBER

      Parameters:
      fieldname_offsetDataset - the fieldname_offsetDataset

    • getFieldname_offsetScalar

      Number getFieldname_offsetScalar()
      An optional offset to apply to the values in FIELDNAME (usually the signal). When omitted, the offset is assumed to be 0. See :ref:`FIELDNAME_scaling_factor invalid input: '<'/NXdata/FIELDNAME_scaling_factor-field>` for more information.

      Type: NX_NUMBER

      Returns:
      the value.

    • setFieldname_offsetScalar

      DataNode setFieldname_offsetScalar(Number fieldname_offsetValue)
      An optional offset to apply to the values in FIELDNAME (usually the signal). When omitted, the offset is assumed to be 0. See :ref:`FIELDNAME_scaling_factor invalid input: '<'/NXdata/FIELDNAME_scaling_factor-field>` for more information.

      Type: NX_NUMBER

      Parameters:
      fieldname_offset - the fieldname_offset

    • getScaling_factor

      @Deprecated org.eclipse.january.dataset.Dataset getScaling_factor()
      Deprecated.
      Use FIELDNAME_scaling_factor instead
      The scaling_factor and FIELDNAME_scaling_factor fields have similar semantics. However, scaling_factor is ambiguous in the case of multiple signals. Therefore scaling_factor is deprecated. Use FIELDNAME_scaling_factor instead, even when only a single signal is present.

      Type: NX_FLOAT

      Returns:
      the value.

    • setScaling_factor

      @Deprecated DataNode setScaling_factor(org.eclipse.january.dataset.IDataset scaling_factorDataset)
      Deprecated.
      Use FIELDNAME_scaling_factor instead
      The scaling_factor and FIELDNAME_scaling_factor fields have similar semantics. However, scaling_factor is ambiguous in the case of multiple signals. Therefore scaling_factor is deprecated. Use FIELDNAME_scaling_factor instead, even when only a single signal is present.

      Type: NX_FLOAT

      Parameters:
      scaling_factorDataset - the scaling_factorDataset

    • getScaling_factorScalar

      @Deprecated Double getScaling_factorScalar()
      Deprecated.
      Use FIELDNAME_scaling_factor instead
      The scaling_factor and FIELDNAME_scaling_factor fields have similar semantics. However, scaling_factor is ambiguous in the case of multiple signals. Therefore scaling_factor is deprecated. Use FIELDNAME_scaling_factor instead, even when only a single signal is present.

      Type: NX_FLOAT

      Returns:
      the value.

    • setScaling_factorScalar

      @Deprecated DataNode setScaling_factorScalar(Double scaling_factorValue)
      Deprecated.
      Use FIELDNAME_scaling_factor instead
      The scaling_factor and FIELDNAME_scaling_factor fields have similar semantics. However, scaling_factor is ambiguous in the case of multiple signals. Therefore scaling_factor is deprecated. Use FIELDNAME_scaling_factor instead, even when only a single signal is present.

      Type: NX_FLOAT

      Parameters:
      scaling_factor - the scaling_factor

    • getOffset

      @Deprecated org.eclipse.january.dataset.Dataset getOffset()
      Deprecated.
      Use FIELDNAME_offset instead
      The offset and FIELDNAME_offset fields have similar semantics. However, offset is ambiguous in the case of multiple signals. Therefore offset is deprecated. Use FIELDNAME_offset instead, even when only a single signal is present.

      Type: NX_FLOAT

      Returns:
      the value.

    • setOffset

      @Deprecated DataNode setOffset(org.eclipse.january.dataset.IDataset offsetDataset)
      Deprecated.
      Use FIELDNAME_offset instead
      The offset and FIELDNAME_offset fields have similar semantics. However, offset is ambiguous in the case of multiple signals. Therefore offset is deprecated. Use FIELDNAME_offset instead, even when only a single signal is present.

      Type: NX_FLOAT

      Parameters:
      offsetDataset - the offsetDataset

    • getOffsetScalar

      @Deprecated Double getOffsetScalar()
      Deprecated.
      Use FIELDNAME_offset instead
      The offset and FIELDNAME_offset fields have similar semantics. However, offset is ambiguous in the case of multiple signals. Therefore offset is deprecated. Use FIELDNAME_offset instead, even when only a single signal is present.

      Type: NX_FLOAT

      Returns:
      the value.

    • setOffsetScalar

      @Deprecated DataNode setOffsetScalar(Double offsetValue)
      Deprecated.
      Use FIELDNAME_offset instead
      The offset and FIELDNAME_offset fields have similar semantics. However, offset is ambiguous in the case of multiple signals. Therefore offset is deprecated. Use FIELDNAME_offset instead, even when only a single signal is present.

      Type: NX_FLOAT

      Parameters:
      offset - the offset

    • getTitle

      org.eclipse.january.dataset.Dataset getTitle()
      Title for the plot.
      Returns:
      the value.

    • setTitle

      DataNode setTitle(org.eclipse.january.dataset.IDataset titleDataset)
      Title for the plot.
      Parameters:
      titleDataset - the titleDataset

    • getTitleScalar

      String getTitleScalar()
      Title for the plot.
      Returns:
      the value.

    • setTitleScalar

      DataNode setTitleScalar(String titleValue)
      Title for the plot.
      Parameters:
      title - the title

    • getX

      org.eclipse.january.dataset.Dataset getX()
      This is an array holding the values to use for the x-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setX

      DataNode setX(org.eclipse.january.dataset.IDataset xDataset)
      This is an array holding the values to use for the x-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      xDataset - the xDataset

    • getXScalar

      Double getXScalar()
      This is an array holding the values to use for the x-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setXScalar

      DataNode setXScalar(Double xValue)
      This is an array holding the values to use for the x-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      x - the x

    • getY

      org.eclipse.january.dataset.Dataset getY()
      This is an array holding the values to use for the y-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setY

      DataNode setY(org.eclipse.january.dataset.IDataset yDataset)
      This is an array holding the values to use for the y-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      yDataset - the yDataset

    • getYScalar

      Double getYScalar()
      This is an array holding the values to use for the y-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setYScalar

      DataNode setYScalar(Double yValue)
      This is an array holding the values to use for the y-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      y - the y

    • getZ

      org.eclipse.january.dataset.Dataset getZ()
      This is an array holding the values to use for the z-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setZ

      DataNode setZ(org.eclipse.january.dataset.IDataset zDataset)
      This is an array holding the values to use for the z-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      zDataset - the zDataset

    • getZScalar

      Double getZScalar()
      This is an array holding the values to use for the z-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Returns:
      the value.

    • setZScalar

      DataNode setZScalar(Double zValue)
      This is an array holding the values to use for the z-axis of data. The units must be appropriate for the measurement. This is a special case of a :ref:`AXISNAME field invalid input: '<'/NXdata/AXISNAME-field>` kept for backward compatibility.

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

      Parameters:
      z - the z