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

generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXfilter.html Maven / Gradle / Ivy






NXfilter (h5jan API)












org.eclipse.dawnsci.nexus

Interface NXfilter

  • All Superinterfaces:
    GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject
    All Known Implementing Classes:
    NXfilterImpl


    public interface NXfilter
    extends NXobject
    For band pass beam filters. If uncertain whether to use :ref:`NXfilter` (band-pass filter) or :ref:`NXattenuator` (reduces beam intensity), then use :ref:`NXattenuator`.
    • Method Detail

      • getGeometry

        NXgeometry getGeometry()
        Geometry of the filter
        Returns:
        the value.
      • setGeometry

        void setGeometry(NXgeometry geometry)
        Geometry of the filter
        Parameters:
        geometry - the geometry
      • getGeometry

        NXgeometry getGeometry(java.lang.String name)
        Get a NXgeometry node by name:
        • Geometry of the filter
        Parameters:
        name - the name of the node.
        Returns:
        a map from node names to the NXgeometry for that node.
      • setGeometry

        void setGeometry(java.lang.String name,
                         NXgeometry geometry)
        Set a NXgeometry node by name:
        • Geometry of the filter
        Parameters:
        name - the name of the node
        geometry - the value to set
      • getAllGeometry

        java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
        Get all NXgeometry nodes:
        • Geometry of the filter
        Returns:
        a map from node names to the NXgeometry for that node.
      • setAllGeometry

        void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
        Set multiple child nodes of a particular type.
        • Geometry of the filter
        Parameters:
        geometry - the child nodes to add
      • getDescription

        IDataset getDescription()
        Composition of the filter. Chemical formula can be specified separately. This field was changed (2010-11-17) from an enumeration to a string since common usage showed a wider variety of use than a simple list. These are the items in the list at the time of the change: Beryllium | Pyrolytic Graphite | Graphite | Sapphire | Silicon | Supermirror.
        Returns:
        the value.
      • setDescription

        DataNode setDescription(IDataset description)
        Composition of the filter. Chemical formula can be specified separately. This field was changed (2010-11-17) from an enumeration to a string since common usage showed a wider variety of use than a simple list. These are the items in the list at the time of the change: Beryllium | Pyrolytic Graphite | Graphite | Sapphire | Silicon | Supermirror.
        Parameters:
        description - the description
      • getDescriptionScalar

        java.lang.String getDescriptionScalar()
        Composition of the filter. Chemical formula can be specified separately. This field was changed (2010-11-17) from an enumeration to a string since common usage showed a wider variety of use than a simple list. These are the items in the list at the time of the change: Beryllium | Pyrolytic Graphite | Graphite | Sapphire | Silicon | Supermirror.
        Returns:
        the value.
      • setDescriptionScalar

        DataNode setDescriptionScalar(java.lang.String description)
        Composition of the filter. Chemical formula can be specified separately. This field was changed (2010-11-17) from an enumeration to a string since common usage showed a wider variety of use than a simple list. These are the items in the list at the time of the change: Beryllium | Pyrolytic Graphite | Graphite | Sapphire | Silicon | Supermirror.
        Parameters:
        description - the description
      • getStatus

        IDataset getStatus()
        position with respect to in or out of the beam (choice of only "in" or "out")

        Enumeration:

        • in in the beam
        • out out of the beam

        Returns:
        the value.
      • setStatus

        DataNode setStatus(IDataset status)
        position with respect to in or out of the beam (choice of only "in" or "out")

        Enumeration:

        • in in the beam
        • out out of the beam

        Parameters:
        status - the status
      • getStatusScalar

        java.lang.String getStatusScalar()
        position with respect to in or out of the beam (choice of only "in" or "out")

        Enumeration:

        • in in the beam
        • out out of the beam

        Returns:
        the value.
      • setStatusScalar

        DataNode setStatusScalar(java.lang.String status)
        position with respect to in or out of the beam (choice of only "in" or "out")

        Enumeration:

        • in in the beam
        • out out of the beam

        Parameters:
        status - the status
      • getTransmission

        NXdata getTransmission()
        Wavelength transmission profile of filter
        Returns:
        the value.
      • setTransmission

        void setTransmission(NXdata transmission)
        Wavelength transmission profile of filter
        Parameters:
        transmission - the transmission
      • getTemperature

        IDataset getTemperature()
        average/nominal filter temperature

        Type: NX_FLOAT Units: NX_TEMPERATURE

        Returns:
        the value.
      • setTemperature

        DataNode setTemperature(IDataset temperature)
        average/nominal filter temperature

        Type: NX_FLOAT Units: NX_TEMPERATURE

        Parameters:
        temperature - the temperature
      • getTemperatureScalar

        java.lang.Double getTemperatureScalar()
        average/nominal filter temperature

        Type: NX_FLOAT Units: NX_TEMPERATURE

        Returns:
        the value.
      • setTemperatureScalar

        DataNode setTemperatureScalar(java.lang.Double temperature)
        average/nominal filter temperature

        Type: NX_FLOAT Units: NX_TEMPERATURE

        Parameters:
        temperature - the temperature
      • getTemperature_log

        NXlog getTemperature_log()
        Linked temperature_log for the filter
        Returns:
        the value.
      • setTemperature_log

        void setTemperature_log(NXlog temperature_log)
        Linked temperature_log for the filter
        Parameters:
        temperature_log - the temperature_log
      • getThickness

        IDataset getThickness()
        Thickness of the filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setThickness

        DataNode setThickness(IDataset thickness)
        Thickness of the filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        thickness - the thickness
      • getThicknessScalar

        java.lang.Double getThicknessScalar()
        Thickness of the filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setThicknessScalar

        DataNode setThicknessScalar(java.lang.Double thickness)
        Thickness of the filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        thickness - the thickness
      • getDensity

        IDataset getDensity()
        mass density of the filter

        Type: NX_NUMBER Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setDensity

        DataNode setDensity(IDataset density)
        mass density of the filter

        Type: NX_NUMBER Units: NX_MASS_DENSITY

        Parameters:
        density - the density
      • getDensityScalar

        java.lang.Number getDensityScalar()
        mass density of the filter

        Type: NX_NUMBER Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setDensityScalar

        DataNode setDensityScalar(java.lang.Number density)
        mass density of the filter

        Type: NX_NUMBER Units: NX_MASS_DENSITY

        Parameters:
        density - the density
      • getChemical_formula

        IDataset getChemical_formula()
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: * C, then H, then the other elements in alphabetical order of their symbol. * If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Returns:
        the value.
      • setChemical_formula

        DataNode setChemical_formula(IDataset chemical_formula)
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: * C, then H, then the other elements in alphabetical order of their symbol. * If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Parameters:
        chemical_formula - the chemical_formula
      • getChemical_formulaScalar

        java.lang.String getChemical_formulaScalar()
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: * C, then H, then the other elements in alphabetical order of their symbol. * If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Returns:
        the value.
      • setChemical_formulaScalar

        DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: * C, then H, then the other elements in alphabetical order of their symbol. * If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Parameters:
        chemical_formula - the chemical_formula
      • getSensor_type

        NXsensor getSensor_type()
        Sensor(s)used to monitor the filter temperature
        Returns:
        the value.
      • setSensor_type

        void setSensor_type(NXsensor sensor_type)
        Sensor(s)used to monitor the filter temperature
        Parameters:
        sensor_type - the sensor_type
      • getUnit_cell_a

        IDataset getUnit_cell_a()
        Unit cell lattice parameter: length of side a

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_a

        DataNode setUnit_cell_a(IDataset unit_cell_a)
        Unit cell lattice parameter: length of side a

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_a - the unit_cell_a
      • getUnit_cell_aScalar

        java.lang.Double getUnit_cell_aScalar()
        Unit cell lattice parameter: length of side a

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_aScalar

        DataNode setUnit_cell_aScalar(java.lang.Double unit_cell_a)
        Unit cell lattice parameter: length of side a

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_a - the unit_cell_a
      • getUnit_cell_b

        IDataset getUnit_cell_b()
        Unit cell lattice parameter: length of side b

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_b

        DataNode setUnit_cell_b(IDataset unit_cell_b)
        Unit cell lattice parameter: length of side b

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_b - the unit_cell_b
      • getUnit_cell_bScalar

        java.lang.Double getUnit_cell_bScalar()
        Unit cell lattice parameter: length of side b

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_bScalar

        DataNode setUnit_cell_bScalar(java.lang.Double unit_cell_b)
        Unit cell lattice parameter: length of side b

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_b - the unit_cell_b
      • getUnit_cell_c

        IDataset getUnit_cell_c()
        Unit cell lattice parameter: length of side c

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_c

        DataNode setUnit_cell_c(IDataset unit_cell_c)
        Unit cell lattice parameter: length of side c

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_c - the unit_cell_c
      • getUnit_cell_cScalar

        java.lang.Double getUnit_cell_cScalar()
        Unit cell lattice parameter: length of side c

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setUnit_cell_cScalar

        DataNode setUnit_cell_cScalar(java.lang.Double unit_cell_c)
        Unit cell lattice parameter: length of side c

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        unit_cell_c - the unit_cell_c
      • getUnit_cell_alpha

        IDataset getUnit_cell_alpha()
        Unit cell lattice parameter: angle alpha

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_alpha

        DataNode setUnit_cell_alpha(IDataset unit_cell_alpha)
        Unit cell lattice parameter: angle alpha

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_alpha - the unit_cell_alpha
      • getUnit_cell_alphaScalar

        java.lang.Double getUnit_cell_alphaScalar()
        Unit cell lattice parameter: angle alpha

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_alphaScalar

        DataNode setUnit_cell_alphaScalar(java.lang.Double unit_cell_alpha)
        Unit cell lattice parameter: angle alpha

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_alpha - the unit_cell_alpha
      • getUnit_cell_beta

        IDataset getUnit_cell_beta()
        Unit cell lattice parameter: angle beta

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_beta

        DataNode setUnit_cell_beta(IDataset unit_cell_beta)
        Unit cell lattice parameter: angle beta

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_beta - the unit_cell_beta
      • getUnit_cell_betaScalar

        java.lang.Double getUnit_cell_betaScalar()
        Unit cell lattice parameter: angle beta

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_betaScalar

        DataNode setUnit_cell_betaScalar(java.lang.Double unit_cell_beta)
        Unit cell lattice parameter: angle beta

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_beta - the unit_cell_beta
      • getUnit_cell_gamma

        IDataset getUnit_cell_gamma()
        Unit cell lattice parameter: angle gamma

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_gamma

        DataNode setUnit_cell_gamma(IDataset unit_cell_gamma)
        Unit cell lattice parameter: angle gamma

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_gamma - the unit_cell_gamma
      • getUnit_cell_gammaScalar

        java.lang.Double getUnit_cell_gammaScalar()
        Unit cell lattice parameter: angle gamma

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setUnit_cell_gammaScalar

        DataNode setUnit_cell_gammaScalar(java.lang.Double unit_cell_gamma)
        Unit cell lattice parameter: angle gamma

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        unit_cell_gamma - the unit_cell_gamma
      • getUnit_cell_volume

        IDataset getUnit_cell_volume()
        Unit cell

        Type: NX_FLOAT Units: NX_VOLUME Dimensions: 1: n_comp;

        Returns:
        the value.
      • setUnit_cell_volume

        DataNode setUnit_cell_volume(IDataset unit_cell_volume)
        Unit cell

        Type: NX_FLOAT Units: NX_VOLUME Dimensions: 1: n_comp;

        Parameters:
        unit_cell_volume - the unit_cell_volume
      • getUnit_cell_volumeScalar

        java.lang.Double getUnit_cell_volumeScalar()
        Unit cell

        Type: NX_FLOAT Units: NX_VOLUME Dimensions: 1: n_comp;

        Returns:
        the value.
      • setUnit_cell_volumeScalar

        DataNode setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
        Unit cell

        Type: NX_FLOAT Units: NX_VOLUME Dimensions: 1: n_comp;

        Parameters:
        unit_cell_volume - the unit_cell_volume
      • getOrientation_matrix

        IDataset getOrientation_matrix()
        Orientation matrix of single crystal filter using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

        Type: NX_FLOAT Dimensions: 1: n_comp; 2: 3; 3: 3;

        Returns:
        the value.
      • setOrientation_matrix

        DataNode setOrientation_matrix(IDataset orientation_matrix)
        Orientation matrix of single crystal filter using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

        Type: NX_FLOAT Dimensions: 1: n_comp; 2: 3; 3: 3;

        Parameters:
        orientation_matrix - the orientation_matrix
      • getOrientation_matrixScalar

        java.lang.Double getOrientation_matrixScalar()
        Orientation matrix of single crystal filter using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

        Type: NX_FLOAT Dimensions: 1: n_comp; 2: 3; 3: 3;

        Returns:
        the value.
      • setOrientation_matrixScalar

        DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
        Orientation matrix of single crystal filter using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464

        Type: NX_FLOAT Dimensions: 1: n_comp; 2: 3; 3: 3;

        Parameters:
        orientation_matrix - the orientation_matrix
      • getM_value

        IDataset getM_value()
        m value of supermirror filter

        Type: NX_FLOAT Units: NX_DIMENSIONLESS

        Returns:
        the value.
      • setM_value

        DataNode setM_value(IDataset m_value)
        m value of supermirror filter

        Type: NX_FLOAT Units: NX_DIMENSIONLESS

        Parameters:
        m_value - the m_value
      • getM_valueScalar

        java.lang.Double getM_valueScalar()
        m value of supermirror filter

        Type: NX_FLOAT Units: NX_DIMENSIONLESS

        Returns:
        the value.
      • setM_valueScalar

        DataNode setM_valueScalar(java.lang.Double m_value)
        m value of supermirror filter

        Type: NX_FLOAT Units: NX_DIMENSIONLESS

        Parameters:
        m_value - the m_value
      • getSubstrate_material

        IDataset getSubstrate_material()
        substrate material of supermirror filter
        Returns:
        the value.
      • setSubstrate_material

        DataNode setSubstrate_material(IDataset substrate_material)
        substrate material of supermirror filter
        Parameters:
        substrate_material - the substrate_material
      • getSubstrate_materialScalar

        java.lang.String getSubstrate_materialScalar()
        substrate material of supermirror filter
        Returns:
        the value.
      • setSubstrate_materialScalar

        DataNode setSubstrate_materialScalar(java.lang.String substrate_material)
        substrate material of supermirror filter
        Parameters:
        substrate_material - the substrate_material
      • getSubstrate_thickness

        IDataset getSubstrate_thickness()
        substrate thickness of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_thickness

        DataNode setSubstrate_thickness(IDataset substrate_thickness)
        substrate thickness of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_thickness - the substrate_thickness
      • getSubstrate_thicknessScalar

        java.lang.Double getSubstrate_thicknessScalar()
        substrate thickness of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_thicknessScalar

        DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
        substrate thickness of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_thickness - the substrate_thickness
      • getCoating_material

        IDataset getCoating_material()
        coating material of supermirror filter
        Returns:
        the value.
      • setCoating_material

        DataNode setCoating_material(IDataset coating_material)
        coating material of supermirror filter
        Parameters:
        coating_material - the coating_material
      • getCoating_materialScalar

        java.lang.String getCoating_materialScalar()
        coating material of supermirror filter
        Returns:
        the value.
      • setCoating_materialScalar

        DataNode setCoating_materialScalar(java.lang.String coating_material)
        coating material of supermirror filter
        Parameters:
        coating_material - the coating_material
      • getSubstrate_roughness

        IDataset getSubstrate_roughness()
        substrate roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_roughness

        DataNode setSubstrate_roughness(IDataset substrate_roughness)
        substrate roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_roughness - the substrate_roughness
      • getSubstrate_roughnessScalar

        java.lang.Double getSubstrate_roughnessScalar()
        substrate roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_roughnessScalar

        DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
        substrate roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_roughness - the substrate_roughness
      • getCoating_roughness

        IDataset getCoating_roughness()
        coating roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: nsurf;

        Returns:
        the value.
      • setCoating_roughness

        DataNode setCoating_roughness(IDataset coating_roughness)
        coating roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: nsurf;

        Parameters:
        coating_roughness - the coating_roughness
      • getCoating_roughnessScalar

        java.lang.Double getCoating_roughnessScalar()
        coating roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: nsurf;

        Returns:
        the value.
      • setCoating_roughnessScalar

        DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
        coating roughness (RMS) of supermirror filter

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: nsurf;

        Parameters:
        coating_roughness - the coating_roughness




© 2015 - 2024 Weber Informatics LLC | Privacy Policy