XMM-Newton Science Analysis System


ssclib (ssclib-4.36.1) [xmmsas_20230412_1735-21.0.0]

Value at histogram fraction

For $binFraction = 0.5$ this gives the same result as median(). The algorithm is as follows: the values in $vector$ or $array$ are sorted; that element index is identified which, expressed as a fraction of the total number of elements, comes nearest to $binFraction$; finally, the element which occurs at that index of the sorted list is returned.

If $binFraction$ is outside the range 0 to 1, the smallest or largest element, whichever is appropriate, is returned.

  interface valueAtHistoFraction
    real(single) function valueAtHistoFractionVector(vector, binFraction&
      , maskVector)

      real(single),  intent(in)           :: vector(:), binFraction
      logical(bool), intent(in), optional :: maskVector(:)
    end function valueAtHistoFractionVector

    real(single) function valueAtHistoFractionArray(array, binFraction&
      , maskArray)

      real(single),  intent(in)           :: array(:,:), binFraction
      logical(bool), intent(in), optional :: maskArray(:,:)
    end function valueAtHistoFractionArray
  end interface