Class FloatEquivalentDoseMatrix

    • Constructor Detail

      • FloatEquivalentDoseMatrix

        public FloatEquivalentDoseMatrix​(FloatMatrixData data,
                                         EquivalentDoseUnit unit)
        Parameters:
        data - FloatMatrixData; an internal data object
        unit - EquivalentDoseUnit; the unit
    • Method Detail

      • getScalarClass

        public Class<FloatEquivalentDose> getScalarClass()
        Return the class of the corresponding scalar.
        Returns:
        Class<S>; the class of the corresponding scalar
      • getVectorClass

        public Class<FloatEquivalentDoseVector> getVectorClass()
        Return the class of the corresponding vector.
        Returns:
        Class<V>; the class of the corresponding vector
      • instantiateMatrix

        public FloatEquivalentDoseMatrix instantiateMatrix​(FloatMatrixData fmd,
                                                           EquivalentDoseUnit displayUnit)
        Instantiate a new matrix of the class of this matrix. This can be used instead of the FloatMatrix.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatMatrix.instantiate, and it will also work if the matrix is user-defined.
        Parameters:
        fmd - FloatMatrixData; the data used to instantiate the matrix
        displayUnit - U; the display unit of the matrix
        Returns:
        V; a matrix of the correct type
      • instantiateVector

        public FloatEquivalentDoseVector instantiateVector​(FloatVectorData fvd,
                                                           EquivalentDoseUnit displayUnit)
        Instantiate a new vector of the class of this matrix. This can be used instead of the FloatVector.instiantiate() methods in case another matrix of this class is known. The method is faster than FloatVector.instantiate, and it will also work if the matrix and/or vector are user-defined.
        Parameters:
        fvd - FloatVectorData; the data used to instantiate the vector
        displayUnit - U; the display unit of the vector
        Returns:
        V; a vector of the correct type
      • instantiateScalarSI

        public FloatEquivalentDose instantiateScalarSI​(float valueSI,
                                                       EquivalentDoseUnit displayUnit)
        Instantiate a new scalar for the class of this matrix. This can be used instead of the FloatScalar.instiantiate() methods in case a matrix of this class is known. The method is faster than FloatScalar.instantiate, and it will also work if the matrix and/or scalar are user-defined.
        Parameters:
        valueSI - float; the SI value of the scalar
        displayUnit - U; the unit in which the value will be displayed
        Returns:
        S; a scalar of the correct type, belonging to the matrix type