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

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






NXbending_magnet (h5jan API)












org.eclipse.dawnsci.nexus

Interface NXbending_magnet

    • Method Detail

      • getCritical_energy

        IDataset getCritical_energy()

        Type: NX_FLOAT Units: NX_ENERGY

        Returns:
        the value.
      • setCritical_energy

        DataNode setCritical_energy(IDataset critical_energy)

        Type: NX_FLOAT Units: NX_ENERGY

        Parameters:
        critical_energy - the critical_energy
      • getCritical_energyScalar

        java.lang.Double getCritical_energyScalar()

        Type: NX_FLOAT Units: NX_ENERGY

        Returns:
        the value.
      • setCritical_energyScalar

        DataNode setCritical_energyScalar(java.lang.Double critical_energy)

        Type: NX_FLOAT Units: NX_ENERGY

        Parameters:
        critical_energy - the critical_energy
      • getBending_radius

        IDataset getBending_radius()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setBending_radius

        DataNode setBending_radius(IDataset bending_radius)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        bending_radius - the bending_radius
      • getBending_radiusScalar

        java.lang.Double getBending_radiusScalar()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setBending_radiusScalar

        DataNode setBending_radiusScalar(java.lang.Double bending_radius)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        bending_radius - the bending_radius
      • getMagnetic_field

        IDataset getMagnetic_field()
        strength of magnetic field of dipole magnets

        Type: NX_FLOAT Units: NX_CURRENT

        Returns:
        the value.
      • setMagnetic_field

        DataNode setMagnetic_field(IDataset magnetic_field)
        strength of magnetic field of dipole magnets

        Type: NX_FLOAT Units: NX_CURRENT

        Parameters:
        magnetic_field - the magnetic_field
      • getMagnetic_fieldScalar

        java.lang.Double getMagnetic_fieldScalar()
        strength of magnetic field of dipole magnets

        Type: NX_FLOAT Units: NX_CURRENT

        Returns:
        the value.
      • setMagnetic_fieldScalar

        DataNode setMagnetic_fieldScalar(java.lang.Double magnetic_field)
        strength of magnetic field of dipole magnets

        Type: NX_FLOAT Units: NX_CURRENT

        Parameters:
        magnetic_field - the magnetic_field
      • getAccepted_photon_beam_divergence

        IDataset getAccepted_photon_beam_divergence()
        An array of four numbers giving X+, X-, Y+ and Y- half divergence

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setAccepted_photon_beam_divergence

        DataNode setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)
        An array of four numbers giving X+, X-, Y+ and Y- half divergence

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        accepted_photon_beam_divergence - the accepted_photon_beam_divergence
      • getAccepted_photon_beam_divergenceScalar

        java.lang.Double getAccepted_photon_beam_divergenceScalar()
        An array of four numbers giving X+, X-, Y+ and Y- half divergence

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setAccepted_photon_beam_divergenceScalar

        DataNode setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)
        An array of four numbers giving X+, X-, Y+ and Y- half divergence

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        accepted_photon_beam_divergence - the accepted_photon_beam_divergence
      • getSource_distance_x

        IDataset getSource_distance_x()
        Distance of source point from particle beam waist in X (horizontal) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSource_distance_x

        DataNode setSource_distance_x(IDataset source_distance_x)
        Distance of source point from particle beam waist in X (horizontal) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        source_distance_x - the source_distance_x
      • getSource_distance_xScalar

        java.lang.Double getSource_distance_xScalar()
        Distance of source point from particle beam waist in X (horizontal) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSource_distance_xScalar

        DataNode setSource_distance_xScalar(java.lang.Double source_distance_x)
        Distance of source point from particle beam waist in X (horizontal) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        source_distance_x - the source_distance_x
      • getSource_distance_y

        IDataset getSource_distance_y()
        Distance of source point from particle beam waist in Y (vertical) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSource_distance_y

        DataNode setSource_distance_y(IDataset source_distance_y)
        Distance of source point from particle beam waist in Y (vertical) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        source_distance_y - the source_distance_y
      • getSource_distance_yScalar

        java.lang.Double getSource_distance_yScalar()
        Distance of source point from particle beam waist in Y (vertical) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSource_distance_yScalar

        DataNode setSource_distance_yScalar(java.lang.Double source_distance_y)
        Distance of source point from particle beam waist in Y (vertical) direction.

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        source_distance_y - the source_distance_y
      • getDivergence_x_plus

        IDataset getDivergence_x_plus()
        Accepted photon beam divergence in X+ (horizontal outboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_x_plus

        DataNode setDivergence_x_plus(IDataset divergence_x_plus)
        Accepted photon beam divergence in X+ (horizontal outboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_x_plus - the divergence_x_plus
      • getDivergence_x_plusScalar

        java.lang.Double getDivergence_x_plusScalar()
        Accepted photon beam divergence in X+ (horizontal outboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_x_plusScalar

        DataNode setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)
        Accepted photon beam divergence in X+ (horizontal outboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_x_plus - the divergence_x_plus
      • getDivergence_x_minus

        IDataset getDivergence_x_minus()
        Accepted photon beam divergence in X- (horizontal inboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_x_minus

        DataNode setDivergence_x_minus(IDataset divergence_x_minus)
        Accepted photon beam divergence in X- (horizontal inboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_x_minus - the divergence_x_minus
      • getDivergence_x_minusScalar

        java.lang.Double getDivergence_x_minusScalar()
        Accepted photon beam divergence in X- (horizontal inboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_x_minusScalar

        DataNode setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)
        Accepted photon beam divergence in X- (horizontal inboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_x_minus - the divergence_x_minus
      • getDivergence_y_plus

        IDataset getDivergence_y_plus()
        Accepted photon beam divergence in Y+ (vertical upward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_y_plus

        DataNode setDivergence_y_plus(IDataset divergence_y_plus)
        Accepted photon beam divergence in Y+ (vertical upward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_y_plus - the divergence_y_plus
      • getDivergence_y_plusScalar

        java.lang.Double getDivergence_y_plusScalar()
        Accepted photon beam divergence in Y+ (vertical upward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_y_plusScalar

        DataNode setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)
        Accepted photon beam divergence in Y+ (vertical upward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_y_plus - the divergence_y_plus
      • getDivergence_y_minus

        IDataset getDivergence_y_minus()
        Accepted photon beam divergence in Y- (vertical downward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_y_minus

        DataNode setDivergence_y_minus(IDataset divergence_y_minus)
        Accepted photon beam divergence in Y- (vertical downward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_y_minus - the divergence_y_minus
      • getDivergence_y_minusScalar

        java.lang.Double getDivergence_y_minusScalar()
        Accepted photon beam divergence in Y- (vertical downward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setDivergence_y_minusScalar

        DataNode setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)
        Accepted photon beam divergence in Y- (vertical downward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        divergence_y_minus - the divergence_y_minus
      • getSpectrum

        NXdata getSpectrum()
        bending magnet spectrum
        Returns:
        the value.
      • setSpectrum

        void setSpectrum(NXdata spectrum)
        bending magnet spectrum
        Parameters:
        spectrum - the spectrum
      • getGeometry

        NXgeometry getGeometry()
        "Engineering" position of bending magnet
        Returns:
        the value.
      • setGeometry

        void setGeometry(NXgeometry geometry)
        "Engineering" position of bending magnet
        Parameters:
        geometry - the geometry
      • getGeometry

        NXgeometry getGeometry(java.lang.String name)
        Get a NXgeometry node by name:
        • "Engineering" position of bending magnet
        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:
        • "Engineering" position of bending magnet
        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:
        • "Engineering" position of bending magnet
        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.
        • "Engineering" position of bending magnet
        Parameters:
        geometry - the child nodes to add




© 2015 - 2024 Weber Informatics LLC | Privacy Policy