Alignment::AShiftEstimator< T > Class Template Reference

#include <ashift_estimator.h>

Inheritance diagram for Alignment::AShiftEstimator< T >:

Collaboration diagram for Alignment::AShiftEstimator< T >:

Public Member Functions
	AShiftEstimator ()
	AShiftEstimator (const AShiftEstimator &)=delete
	AShiftEstimator (const AShiftEstimator &&)=delete
virtual	~AShiftEstimator ()
AShiftEstimator &	operator= (const AShiftEstimator &)=delete
AShiftEstimator &	operator= (const AShiftEstimator &&)=delete
virtual void	init2D (const std::vector< HW *> &hw, AlignType type, const Dimensions &dims, size_t batch, size_t maxShift)=0
virtual void	load2DReferenceOneToN (const T *ref)=0
virtual void	computeShift2DOneToN (T *others)=0
std::vector< Point2D< float > >	getShifts2D ()
virtual void	release ()
constexpr bool	isInitialized () const
constexpr Dimensions	getDimensions () const
constexpr AlignType	getAlignType () const
virtual HW &	getHW () const =0

Protected Member Functions
virtual void	setDefault ()
virtual void	init2D (AlignType type, const Dimensions &dims, size_t batch, size_t maxShift)
virtual void	check ()

Protected Attributes
AlignType	m_type
const Dimensions *	m_dims
size_t	m_batch
size_t	m_maxShift
std::vector< Point2D< float > >	m_shifts2D
bool	m_is_ref_loaded
bool	m_is_shift_computed
bool	m_isInit

Detailed Description

template<typename T>
class Alignment::AShiftEstimator< T >

Definition at line 42 of file ashift_estimator.h.

Constructor & Destructor Documentation

AShiftEstimator() [1/3]

template<typename T>

Alignment::AShiftEstimator< T >::AShiftEstimator ( )

inline

Definition at line 44 of file ashift_estimator.h.

                      {
        setDefault();
    }

AShiftEstimator() [2/3]

template<typename T>

Alignment::AShiftEstimator< T >::AShiftEstimator ( const AShiftEstimator< T > &  )

delete

AShiftEstimator() [3/3]

template<typename T>

Alignment::AShiftEstimator< T >::AShiftEstimator ( const AShiftEstimator< T > &&  )

delete

~AShiftEstimator()

template<typename T>

virtual Alignment::AShiftEstimator< T >::~AShiftEstimator ( )

inlinevirtual

Definition at line 50 of file ashift_estimator.h.

                               {
        release();
    }

Member Function Documentation

check()

template<typename T >

void Alignment::AShiftEstimator< T >::check ( )

protectedvirtual

Reimplemented in Alignment::AShiftCorrEstimator< T >.

Definition at line 65 of file ashift_estimator.cpp.

                               {
    if (AlignType::None == m_type) {
        REPORT_ERROR(ERR_LOGIC_ERROR, "'None' alignment type is set. This is invalid value");
    }
    if ((0 == m_dims->x()) || (0 == m_dims->y())
            || (0 == m_dims->z()) || (0 == m_dims->n())) {
        REPORT_ERROR(ERR_VALUE_INCORRECT, "One of the dimensions is zero (0)");
    }
    if (0 == m_batch) {
        REPORT_ERROR(ERR_VALUE_INCORRECT, "Batch is zero (0)");
    }
    if (m_batch > m_dims->n()) {
        REPORT_ERROR(ERR_VALUE_INCORRECT, "Batch is bigger than N");
    }
    if (0 == m_maxShift) {
        REPORT_ERROR(ERR_VALUE_INCORRECT, "Max shift is zero (0)");
    }
}

computeShift2DOneToN()

template<typename T>

virtual void Alignment::AShiftEstimator< T >::computeShift2DOneToN ( T *  others )

pure virtual

Implemented in Alignment::CudaShiftCorrEstimator< T >, and Alignment::ShiftCorrEstimator< T >.

getAlignType()

template<typename T>

constexpr AlignType Alignment::AShiftEstimator< T >::getAlignType ( ) const

inline

Definition at line 84 of file ashift_estimator.h.

                                             {
        return m_type;
    }

getDimensions()

template<typename T>

constexpr Dimensions Alignment::AShiftEstimator< T >::getDimensions ( ) const

inline

Definition at line 80 of file ashift_estimator.h.

                                               {
        return *m_dims;
    }

getHW()

template<typename T>

virtual HW& Alignment::AShiftEstimator< T >::getHW ( ) const

pure virtual

Implemented in Alignment::ShiftCorrEstimator< T >, and Alignment::CudaShiftCorrEstimator< T >.

getShifts2D()

template<typename T>

std::vector<Point2D<float> > Alignment::AShiftEstimator< T >::getShifts2D ( )

inline

Definition at line 64 of file ashift_estimator.h.

                                                   {
        if ( ! m_is_shift_computed) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "Shift has not been yet computed or it has been already retrieved");
        }
        auto cpy = std::vector<Point2D<float>>();
        cpy.swap(m_shifts2D);
        m_is_shift_computed = false;
        return cpy;
    }

init2D() [1/2]

template<typename T>

virtual void Alignment::AShiftEstimator< T >::init2D ( const std::vector< HW *> &  hw, AlignType  type, const Dimensions &  dims, size_t  batch, size_t  maxShift  )

pure virtual

Implemented in Alignment::AShiftCorrEstimator< T >.

init2D() [2/2]

template<typename T >

void Alignment::AShiftEstimator< T >::init2D ( AlignType  type, const Dimensions &  dims, size_t  batch, size_t  maxShift  )

protectedvirtual

Definition at line 54 of file ashift_estimator.cpp.

                                              {
    m_type = type;
    m_dims = new Dimensions(dims);
    m_batch = std::min(batch, m_dims->n());
    m_maxShift = maxShift;

    AShiftEstimator<T>::check();
}

isInitialized()

template<typename T>

constexpr bool Alignment::AShiftEstimator< T >::isInitialized ( ) const

inline

Definition at line 76 of file ashift_estimator.h.

                                         {
        return m_isInit;
    }

load2DReferenceOneToN()

template<typename T>

virtual void Alignment::AShiftEstimator< T >::load2DReferenceOneToN ( const T *  ref )

pure virtual

Implemented in Alignment::CudaShiftCorrEstimator< T >, and Alignment::ShiftCorrEstimator< T >.

operator=() [1/2]

template<typename T>

AShiftEstimator& Alignment::AShiftEstimator< T >::operator= ( const AShiftEstimator< T > &  )

delete

operator=() [2/2]

template<typename T>

AShiftEstimator& Alignment::AShiftEstimator< T >::operator= ( const AShiftEstimator< T > &&  )

delete

release()

template<typename T >

void Alignment::AShiftEstimator< T >::release ( )

virtual

Reimplemented in Alignment::AShiftCorrEstimator< T >, Alignment::CudaShiftCorrEstimator< T >, and Alignment::ShiftCorrEstimator< T >.

Definition at line 31 of file ashift_estimator.cpp.

                                 {
    delete m_dims;

    m_shifts2D.clear();

    AShiftEstimator<T>::setDefault();
}

setDefault()

template<typename T >

void Alignment::AShiftEstimator< T >::setDefault ( )

protectedvirtual

Reimplemented in Alignment::AShiftCorrEstimator< T >.

Definition at line 40 of file ashift_estimator.cpp.

                                    {
    m_type = AlignType::None;
    m_dims = nullptr;
    m_batch = 0;
    m_maxShift = 0;

    // m_shifts2D.reserve(0); // COSS: This is not necessary (size=0), and it is causing some Sonarcloud bug

    m_isInit = false;
    m_is_ref_loaded = false;
    m_is_shift_computed = false;
}

Member Data Documentation

m_batch

template<typename T>

size_t Alignment::AShiftEstimator< T >::m_batch

protected

Definition at line 94 of file ashift_estimator.h.

m_dims

template<typename T>

const Dimensions* Alignment::AShiftEstimator< T >::m_dims

protected

Definition at line 93 of file ashift_estimator.h.

m_is_ref_loaded

template<typename T>

bool Alignment::AShiftEstimator< T >::m_is_ref_loaded

protected

Definition at line 101 of file ashift_estimator.h.

m_is_shift_computed

template<typename T>

bool Alignment::AShiftEstimator< T >::m_is_shift_computed

protected

Definition at line 102 of file ashift_estimator.h.

m_isInit

template<typename T>

bool Alignment::AShiftEstimator< T >::m_isInit

protected

Definition at line 103 of file ashift_estimator.h.

m_maxShift

template<typename T>

size_t Alignment::AShiftEstimator< T >::m_maxShift

protected

Definition at line 95 of file ashift_estimator.h.

m_shifts2D

template<typename T>

std::vector<Point2D<float> > Alignment::AShiftEstimator< T >::m_shifts2D

protected

Definition at line 98 of file ashift_estimator.h.

m_type

template<typename T>

AlignType Alignment::AShiftEstimator< T >::m_type

protected

Definition at line 92 of file ashift_estimator.h.

---

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

• xmipp/libraries/reconstruction/ashift_estimator.h
• xmipp/libraries/reconstruction/ashift_estimator.cpp