Mantid
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Mantid::DataObjects::MDBin Class Reference

MDBin : Class describing a single bin in a dense, Multidimensional histogram. More...

#include <MDBin.h>

Public Member Functions

 MDBin ()
 

Public Attributes

signal_t m_errorSquared
 The accumulated error (squared) in this bin. More...
 
size_t m_index
 Index of where this bin lands into the broader histogrammed workspace. More...
 
coord_t m_max [nd]
 The maximum edge of the bin for each dimension in the workspace. More...
 
coord_t m_min [nd]
 The minimum edge of the bin for each dimension in the workspace. More...
 
signal_t m_signal
 The accumulated signal in this bin. More...
 

Detailed Description

MDBin : Class describing a single bin in a dense, Multidimensional histogram.

This object will get passed around by MDBox'es and accumulate the total signal of events contained in it. The signal (and error) of each bin will be used to make the big dense histogram.

NOTE: For now, will only support bins that are aligned with the workspace axes (no rotation!), but in future it will be extended.

Template Parameters
nd:: the number of dimensions **in the workspace being binned, not the output workspace **
Author
Janik Zikovsky, SNS
Date
2011-03-23 17:04:02.621325

Definition at line 32 of file MDBin.h.

Constructor & Destructor Documentation

◆ MDBin()

Mantid::DataObjects::MDBin::MDBin ( )

Member Data Documentation

◆ m_errorSquared

signal_t Mantid::DataObjects::MDBin::m_errorSquared

The accumulated error (squared) in this bin.

This is public so as to avoid the need (and slowdown) of getters/setters

Definition at line 44 of file MDBin.h.

◆ m_index

size_t Mantid::DataObjects::MDBin::m_index

Index of where this bin lands into the broader histogrammed workspace.

Definition at line 53 of file MDBin.h.

◆ m_max

coord_t Mantid::DataObjects::MDBin::m_max[nd]

The maximum edge of the bin for each dimension in the workspace.

Definition at line 50 of file MDBin.h.

◆ m_min

coord_t Mantid::DataObjects::MDBin::m_min[nd]

The minimum edge of the bin for each dimension in the workspace.

Definition at line 47 of file MDBin.h.

◆ m_signal

signal_t Mantid::DataObjects::MDBin::m_signal

The accumulated signal in this bin.

This is public so as to avoid the need (and slowdown) of getters/setters

Definition at line 39 of file MDBin.h.


The documentation for this class was generated from the following file: