Alignment::ARotationEstimator< T > Class Template Reference

#include <arotation_estimator.h>

Inheritance diagram for Alignment::ARotationEstimator< T >:

Public Member Functions
	ARotationEstimator ()
void	init (const RotationEstimationSetting settings, bool reuse)
void	loadReference (const T *ref)
void	compute (T *others)
const std::vector< float > &	getRotations2D () const
virtual	~ARotationEstimator ()
HW &	getHW () const
const RotationEstimationSetting &	getSettings () const

Protected Member Functions
virtual void	check ()=0
virtual void	init2D ()=0
virtual void	load2DReferenceOneToN (const T *ref)=0
virtual void	computeRotation2DOneToN (T *others)=0
virtual bool	canBeReused2D (const RotationEstimationSetting &s) const =0
std::vector< float > &	getRotations2D ()
constexpr bool	isInitialized () const
constexpr bool	isRefLoaded () const

Detailed Description

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

Definition at line 124 of file arotation_estimator.h.

Constructor & Destructor Documentation

ARotationEstimator()

template<typename T>

Alignment::ARotationEstimator< T >::ARotationEstimator ( )

inline

Definition at line 126 of file arotation_estimator.h.

                         :
        m_isInit(false),
        m_isRefLoaded(false) {};

~ARotationEstimator()

template<typename T>

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

inlinevirtual

Definition at line 140 of file arotation_estimator.h.

{};

Member Function Documentation

canBeReused2D()

template<typename T>

virtual bool Alignment::ARotationEstimator< T >::canBeReused2D ( const RotationEstimationSetting &  s ) const

protectedpure virtual

check()

template<typename T>

virtual void Alignment::ARotationEstimator< T >::check ( )

protectedpure virtual

compute()

template<typename T >

void Alignment::ARotationEstimator< T >::compute

(

T *

others

)

Definition at line 72 of file arotation_estimator.cpp.

                                             { // FIXME DS should be const?
    if (m_settings.otherDims.is2D()) {
        m_rotations2D.resize(0);
        m_rotations2D.reserve(m_settings.otherDims.n());
        if (AlignType::OneToN == m_settings.type) {
            return this->computeRotation2DOneToN(others);
        }
    }
    REPORT_ERROR(ERR_NOT_IMPLEMENTED, "Not implemented");
}

computeRotation2DOneToN()

template<typename T>

virtual void Alignment::ARotationEstimator< T >::computeRotation2DOneToN ( T *  others )

protectedpure virtual

getHW()

template<typename T>

HW& Alignment::ARotationEstimator< T >::getHW ( ) const

inline

Definition at line 142 of file arotation_estimator.h.

                      { // FIXME DS remove once we use the new data-centric approach
        assert(m_isInit);
        return *m_settings.hw.at(0);
    }

getRotations2D() [1/2]

template<typename T>

const std::vector<float>& Alignment::ARotationEstimator< T >::getRotations2D ( ) const

inline

Definition at line 136 of file arotation_estimator.h.

                                                          {
        return m_rotations2D;
    }

getRotations2D() [2/2]

template<typename T>

std::vector<float>& Alignment::ARotationEstimator< T >::getRotations2D ( )

inlineprotected

Definition at line 160 of file arotation_estimator.h.

                                              {
        return m_rotations2D;
    }

getSettings()

template<typename T>

const RotationEstimationSetting& Alignment::ARotationEstimator< T >::getSettings ( ) const

inline

Definition at line 147 of file arotation_estimator.h.

                                                                {
        return m_settings;
    }

init()

template<typename T >

void Alignment::ARotationEstimator< T >::init	(	const RotationEstimationSetting	settings,
		bool	reuse
	)

Definition at line 31 of file arotation_estimator.cpp.

                                                                                     {
    // check that settings is not completely wrong
    settings.check();
    bool skipInit = m_isInit && reuse && this->canBeReused(settings);
    // set it
    m_settings = settings;
    // initialize estimator
    if ( ! skipInit) {
        if (m_settings.otherDims.is2D()) {
            this->init2D();
        } else {
            REPORT_ERROR(ERR_NOT_IMPLEMENTED, "Not implemented");
        }
        // check that there's no logical problem
        this->check();
        // no issue found, we're good to go
        m_isInit = true;
    }
}

init2D()

template<typename T>

virtual void Alignment::ARotationEstimator< T >::init2D ( )

protectedpure virtual

isInitialized()

template<typename T>

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

inlineprotected

Definition at line 164 of file arotation_estimator.h.

                                                {
        return m_isInit;
    }

isRefLoaded()

template<typename T>

constexpr bool Alignment::ARotationEstimator< T >::isRefLoaded ( ) const

inlineprotected

Definition at line 168 of file arotation_estimator.h.

                                              {
        return m_isRefLoaded;
    }

load2DReferenceOneToN()

template<typename T>

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

protectedpure virtual

loadReference()

template<typename T >

void Alignment::ARotationEstimator< T >::loadReference

(

const T *

ref

)

Definition at line 60 of file arotation_estimator.cpp.

                                                      {
    if (m_settings.otherDims.is2D()) {
        if (AlignType::OneToN == m_settings.type) {
            this->load2DReferenceOneToN(ref);
            m_isRefLoaded = true;
            return;
        }
    }
    REPORT_ERROR(ERR_NOT_IMPLEMENTED, "Not implemented");
}

---

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

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