Frame Class Reference

Description

Holds one or two axes.

Definition at line 27 of file Frame.h.

Collaboration diagram for Frame:

Public Member Functions
	Frame (const std::vector< IAxis * > &axes)
	Constructor that takes ownership of supplied axes. More...
virtual	~Frame ()
std::vector< int >	allIndices (size_t i_flat) const
	Returns vector of axes indices for given global index. More...
const IAxis &	axis (size_t k_axis) const
	Returns axis with given serial number. More...
std::vector< IAxis * >	cloned_axes () const
	Returns cloned axes. More...
bool	hasSameSizes (const Frame &) const
	Returns true if both Frames have same rank, and all axes have same sizes. More...
bool	operator== (const Frame &) const
	Returns true if both Frames have same rank, and all axes are equal. More...
double	projectedCoord (size_t i_flat, size_t k_axis) const
	Returns the value of selected axis for given i_flat. More...
size_t	projectedIndex (size_t i_flat, size_t k_axis) const
	Returns axis bin index for given global index. More...
size_t	projectedSize (size_t k_axis) const
	Returns number of bins along axis. More...
size_t	rank () const
	Returns number of dimensions. More...
size_t	size () const
	Returns total number of bins. More...
size_t	toGlobalIndex (const std::vector< unsigned > &axes_indices) const
	Returns global index for specified indices of axes. More...
const IAxis &	xAxis () const
const IAxis &	yAxis () const

Protected Attributes
OwningVector< IAxis >	m_axes

Private Attributes
size_t	m_size

Constructor & Destructor Documentation

Frame()

Frame::Frame

(

const std::vector< IAxis * > &

axes

)

Constructor that takes ownership of supplied axes.

Definition at line 20 of file Frame.cpp.

    : m_axes(axes)
{
    m_size = 1;
    for (size_t k = 0; k < rank(); ++k) {
        ASSERT(axis(k).size() > 0);
        m_size *= axis(k).size();
    }
}

References ASSERT, axis(), m_size, rank(), size(), and IAxis::size().

Here is the call graph for this function:

~Frame()

Frame::~Frame ( )

virtualdefault

Member Function Documentation

allIndices()

std::vector< int > Frame::allIndices

(

size_t

i_flat

)

const

Returns vector of axes indices for given global index.

Parameters

i_flat

The global index of this data structure.

Returns

Vector of bin indices for all axes defined

Definition at line 48 of file Frame.cpp.

{
    std::vector<int> result(rank());
    for (size_t k = 0; k < rank(); ++k)
        result[k] = projectedIndex(i_flat, k);
    return result;
}

References projectedIndex(), and rank().

Referenced by DataUtils::Data::createRearrangedDataSet().

Here is the call graph for this function:

axis()

const IAxis& Frame::axis ( size_t  k_axis ) const

inline

Returns axis with given serial number.

Definition at line 46 of file Frame.h.

{ return *m_axes.at(k_axis); }

References OwningVector< T >::at(), and m_axes.

Referenced by Frame(), hasSameSizes(), and operator==().

Here is the call graph for this function:

cloned_axes()

std::vector< IAxis * > Frame::cloned_axes

(

)

const

Returns cloned axes.

Definition at line 32 of file Frame.cpp.

{
    return m_axes.cloned_vector();
}

References OwningVector< T >::cloned_vector(), and m_axes.

Referenced by IDetector::applyDetectorResolution(), and DiffUtil::relativeDifferenceField().

Here is the call graph for this function:

hasSameSizes()

bool Frame::hasSameSizes

(

const Frame &

o

)

const

Returns true if both Frames have same rank, and all axes have same sizes.

Definition at line 102 of file Frame.cpp.

{
    if (rank() != o.rank())
        return false;
    for (size_t k = 0; k < rank(); ++k)
        if (axis(k).size() != o.axis(k).size())
            return false;
    return true;
}

References axis(), rank(), and IAxis::size().

Referenced by Datafield::hasSameSizes().

Here is the call graph for this function:

operator==()

bool Frame::operator==

(

const Frame &

o

)

const

Returns true if both Frames have same rank, and all axes are equal.

Definition at line 92 of file Frame.cpp.

{
    if (rank() != o.rank())
        return false;
    for (size_t k = 0; k < rank(); ++k)
        if (axis(k) != o.axis(k))
            return false;
    return true;
}

References axis(), and rank().

Here is the call graph for this function:

projectedCoord()

double Frame::projectedCoord	(	size_t	i_flat,
		size_t	k_axis
	)		const

Returns the value of selected axis for given i_flat.

Parameters

i_flat	The global index of this data structure.
k_axis	Serial number of selected axis.

Returns

corresponding bin center of selected axis

Definition at line 42 of file Frame.cpp.

{
    auto axis_index = projectedIndex(i_flat, k_axis);
    return (*m_axes[k_axis])[axis_index];
}

References m_axes, and projectedIndex().

Here is the call graph for this function:

projectedIndex()

size_t Frame::projectedIndex	(	size_t	i_flat,
		size_t	k_axis
	)		const

Returns axis bin index for given global index.

Parameters

i_flat	The global index of this data structure.
k_axis	Serial number of selected axis.

Returns

Corresponding bin index for selected axis

Definition at line 56 of file Frame.cpp.

{
    if (rank() == 1) {
        return i_flat;
    } else if (rank() == 2) {
        if (k_axis == 0)
            return (i_flat / m_axes[1]->size()) % m_axes[0]->size();
        if (k_axis == 1)
            return i_flat % m_axes[1]->size();
        ASSERT(0);
    }
    ASSERT(0);
    /* // generic code for rank>2 currently unused
    size_t remainder(i_flat);
    for (int k = rank() - 1; k >= 0; --k) {
        size_t result = remainder % m_axes[k]->size();
        if (k_axis == k)
            return result;
        remainder /= m_axes[k]->size();
    }
    */
}

References ASSERT, m_axes, rank(), size(), and OwningVector< T >::size().

Referenced by allIndices(), ConvolutionDetectorResolution::apply2dConvolution(), and projectedCoord().

Here is the call graph for this function:

projectedSize()

size_t Frame::projectedSize

(

size_t

k_axis

)

const

Returns number of bins along axis.

Definition at line 37 of file Frame.cpp.

{
    return m_axes[k_axis]->size();
}

References m_axes, and OwningVector< T >::size().

Here is the call graph for this function:

rank()

size_t Frame::rank ( ) const

inline

Returns number of dimensions.

Definition at line 34 of file Frame.h.

{ return m_axes.size(); }

References m_axes, and OwningVector< T >::size().

Referenced by Frame(), allIndices(), hasSameSizes(), operator==(), projectedIndex(), and toGlobalIndex().

Here is the call graph for this function:

size()

size_t Frame::size ( ) const

inline

Returns total number of bins.

Definition at line 37 of file Frame.h.

{ return m_size; }

References m_size.

Referenced by Frame(), Datafield::normalizedToMaximum(), projectedIndex(), Datafield::size(), and toGlobalIndex().

toGlobalIndex()

size_t Frame::toGlobalIndex

(

const std::vector< unsigned > &

axes_indices

)

const

Returns global index for specified indices of axes.

Parameters

axes_indices

Vector of axes indices for all specified axes in this dataset

Returns

Corresponding global index

Definition at line 79 of file Frame.cpp.

{
    ASSERT(axes_indices.size() == rank());
    size_t result = 0;
    size_t step_size = 1;
    for (int k = rank() - 1; k >= 0; --k) {
        ASSERT(axes_indices[k] < m_axes[k]->size());
        result += axes_indices[k] * step_size;
        step_size *= m_axes[k]->size();
    }
    return result;
}

References ASSERT, m_axes, rank(), size(), and OwningVector< T >::size().

Referenced by IO::readNicosData().

Here is the call graph for this function:

xAxis()

const IAxis& Frame::xAxis ( ) const

inline

Definition at line 47 of file Frame.h.

{ return *m_axes.at(0); }

References OwningVector< T >::at(), and m_axes.

Referenced by FramUtil::coordinatesFromBinf(), and FramUtil::coordinatesToBinf().

Here is the call graph for this function:

yAxis()

const IAxis& Frame::yAxis ( ) const

inline

Definition at line 48 of file Frame.h.

{ return *m_axes.at(1); }

References OwningVector< T >::at(), and m_axes.

Referenced by FramUtil::coordinatesFromBinf(), and FramUtil::coordinatesToBinf().

Here is the call graph for this function:

Member Data Documentation

m_axes

OwningVector<IAxis> Frame::m_axes

protected

Definition at line 80 of file Frame.h.

Referenced by axis(), cloned_axes(), projectedCoord(), projectedIndex(), projectedSize(), rank(), toGlobalIndex(), xAxis(), and yAxis().

m_size

size_t Frame::m_size

private

Definition at line 83 of file Frame.h.

Referenced by Frame(), and size().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/Frame.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/Frame.cpp