Binning

bin_1D( bin_quantity, bin_lim, count_quantity=nothing; 
        calc_sigma::Bool=true, Nbins::Int=100,
        show_progress::Bool=true)

Get a 1D histogram of quantity in the limits bin_lim, over a number if bins Nbins. If a count_quantity is provided it computes the mean of said quantity within the bin. If calc_sigma is set to true it will also return the standard deviation of the quantity per bin.

bin_1D!(count, bin_quantity, bin_lim, 
        sum_quantity=nothing, count_quantity=nothing; 
        Nbins::Int=100,
        show_progress::Bool=true)

Get a 1D histogram of quantity in the limits bin_lim, over a number if bins Nbins for pre-allocated array count. If a count_quantity is provided it computes the sum of said quantity within the bin and writes it into sum_quantity.

bin_1D_log( bin_quantity, bin_lim, count_quantity=nothing; 
            calc_sigma::Bool=true, Nbins::Int=100,
            show_progress::Bool=true)

Get a 1D histogram of quantity in the limits bin_lim, over a number if bins Nbins $log$-space. If a count_quantity is provided it computes the mean of said quantity within the bin. If calc_sigma is set to true it will also return the standard deviation of the quantity per bin.

bin_1D_log!(count, bin_quantity, bin_lim, 
            sum_quantity=nothing, count_quantity=nothing; 
            Nbins::Int=100,
            show_progress::Bool=true)

Get a 1D histogram of quantity in the limits bin_lim, over a number if bins Nbins for pre-allocated array count in $log$-space. If a count_quantity is provided it computes the sum of said quantity within the bin and writes it into sum_quantity.

σ_1D_quantity(quantity_sum, bin_count)

Compute the standard deviation per bin. From: https://math.stackexchange.com/questions/198336/how-to-calculate-standard-deviation-with-streaming-inputs

bin_2D( x_q, y_q, x_lim, y_lim, bin_q=nothing; 
        calc_mean::Bool=true, Nbins::Int=100,
        show_progress::Bool=true)

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number if bins Nbins. If you want to bin an additional quantity bin_q you can pass it as an optional argument. If calc_mean is set to true it will calculate the mean of the quantity per bin, otherwise the sum is returned.

bin_2D!( phase_map_count,  
         x_q, y_q, x_lim, y_lim; 
         Nbins::Int=100,
         show_progress::Bool=true)

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number if bins Nbins for pre-allocated array phase_map_count. Should be used if computing a 2D phase map over multiple files.

bin_2D_quantity!( phase_map_count, phase_map, 
                  x_q, y_q, bin_q, x_lim, y_lim; 
                  Nbins::Int=100,
                  show_progress::Bool=true )

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number of bins Nbins for pre-allocated arrays phase_map_count and phase_map. Should be used if computing a 2D phase map over multiple files.

bin_2D_log( x_q, y_q, x_lim, y_lim, bin_q=nothing; 
        calc_mean::Bool=true, Nbins::Int=100,
        show_progress::Bool=true)

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number if bins Nbins in $log$-space. If you want to bin an additional quantity bin_q you can pass it as an optional argument. If calc_mean is set to true it will calculate the mean of the quantity per bin, otherwise the sum is returned.

bin_2D_log!( phase_map_count,  
             x_q, y_q, x_lim, y_lim; 
             Nbins::Int=100,
            show_progress::Bool=true)

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number if bins Nbins in $log$-space for pre-allocated array phase_map_count. Should be used if computing a 2D phase map over multiple files.

bin_2D_quantity_log!( phase_map_count, phase_map, 
                      x_q, y_q, bin_q, x_lim, y_lim; 
                      Nbins::Int=100,
                      show_progress::Bool=true)

Get a 2D histogram of x_q and y_q in the limits x_lim, y_lim over a number if bins Nbins in $log$-space for pre-allocated arrays phase_map_count and phase_map. Should be used if computing a 2D phase map over multiple files.