Interface NXparameters

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXobject
All Known Subinterfaces:
NXapm_paraprobe_tool_parameters, NXmatch_filter, NXmicrostructure_mtex_config, NXspatial_filter, NXsubsampling_filter

public interface NXparameters extends NXobject
Container for parameters, usually used in processing or analysis.
  • Field Details

  • Method Details

    • getParameter

      org.eclipse.january.dataset.Dataset getParameter(String parameter)
      A parameter (also known as a term) that is used in or results from processing.

      Type: NX_CHAR_OR_NUMBER Units: NX_ANY

      Parameters:
      parameter - the parameter
      Returns:
      the value.
    • setParameter

      DataNode setParameter(String parameter, org.eclipse.january.dataset.IDataset parameterDataset)
      A parameter (also known as a term) that is used in or results from processing.

      Type: NX_CHAR_OR_NUMBER Units: NX_ANY

      Parameters:
      parameter - the parameter
      parameterDataset - the parameterDataset
    • getParameterScalar

      Object getParameterScalar(String parameter)
      A parameter (also known as a term) that is used in or results from processing.

      Type: NX_CHAR_OR_NUMBER Units: NX_ANY

      Parameters:
      parameter - the parameter
      Returns:
      the value.
    • setParameterScalar

      DataNode setParameterScalar(String parameter, Object parameterValue)
      A parameter (also known as a term) that is used in or results from processing.

      Type: NX_CHAR_OR_NUMBER Units: NX_ANY

      Parameters:
      parameter - the parameter
      parameter - the parameter
    • getAllParameter

      Map<String,? extends org.eclipse.january.dataset.IDataset> getAllParameter()
      Get all Parameter fields: A parameter (also known as a term) that is used in or results from processing.

      Type: NX_CHAR_OR_NUMBER Units: NX_ANY

      Note: this method returns ALL datasets within this group.

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

      String getParameterAttributeUnits(String parameter)
      Parameters:
      parameter - the parameter
      Returns:
      the value.
    • setParameterAttributeUnits

      void setParameterAttributeUnits(String parameter, String unitsValue)
      Parameters:
      parameter - the parameter
      unitsValue - the unitsValue