h5analysis.histogram.load_histogram_2d

h5analysis.histogram.load_histogram_2d(config, file, x_stream, y_stream, z_stream, *args, norm=False, xoffset=None, xcoffset=None, yoffset=None, ycoffset=None, binsize_x=None, binsize_y=None, binsize_z=None, bins=None)

Internal function to generate scatter plots for (x,y,z) SCA data

Parameters:
  • config (dict) – h5 configuration

  • file (string) – file name

  • x_stream (string) – key name or alias

  • y_stream (string) – key name or alias

  • z_stream (string) – key name or alias

  • *args (ints) – scan numbers, comma separated

  • kwargs

    norm: boolean

    normalizes to [0,1]

    xoffset: list

    fitting offset (x-stream)

    xcoffset: float

    constant offset (x-stream)

    yoffset: list

    fitting offset (y-stream)

    ycoffset: float

    constant offset (y-stream)

    binsize_x: int

    puts x-data in bins of specified size

    binsize_y: int

    puts y-data in bins of specified size

    binsize_z: int

    puts z-data in bins of specified size

    bins: tuple

    Set the number of bins in the (x-direction,y-direction) explicitly

Returns:

data

Return type:

dict