Alignment::AShiftCorrEstimator< T > Class Template Reference

#include <ashift_corr_estimator.h>

Inheritance diagram for Alignment::AShiftCorrEstimator< T >:

Collaboration diagram for Alignment::AShiftCorrEstimator< T >:

Public Member Functions
	AShiftCorrEstimator ()
	AShiftCorrEstimator (const AShiftCorrEstimator &)=delete
	AShiftCorrEstimator (const AShiftCorrEstimator &&)=delete
virtual	~AShiftCorrEstimator ()
AShiftCorrEstimator &	operator= (const AShiftCorrEstimator &)=delete
AShiftCorrEstimator &	operator= (const AShiftCorrEstimator &&)=delete
virtual void	init2D (const std::vector< HW *> &hw, AlignType type, const FFTSettings< T > &dims, size_t maxShift, bool includingBatchFT, bool includingSingleFT, bool allowDataOverwrite)=0
virtual void	computeCorrelations2DOneToN (std::complex< T > *inOut, bool center)=0
virtual void	load2DReferenceOneToN (const std::complex< T > *ref)=0
virtual void	computeCorrelations2DOneToN (const HW &hw, std::complex< T > *inOut, const std::complex< T > *ref, const Dimensions &dims, bool center)=0
void	release () override
Public Member Functions inherited from Alignment::AShiftEstimator< T >
	AShiftEstimator ()
	AShiftEstimator (const AShiftEstimator &)=delete
	AShiftEstimator (const AShiftEstimator &&)=delete
virtual	~AShiftEstimator ()
AShiftEstimator &	operator= (const AShiftEstimator &)=delete
AShiftEstimator &	operator= (const AShiftEstimator &&)=delete
virtual void	load2DReferenceOneToN (const T *ref)=0
virtual void	computeShift2DOneToN (T *others)=0
std::vector< Point2D< float > >	getShifts2D ()
constexpr bool	isInitialized () const
constexpr Dimensions	getDimensions () const
constexpr AlignType	getAlignType () const
virtual HW &	getHW () const =0

Protected Member Functions
void	setDefault () override
virtual void	init2D (AlignType type, const FFTSettings< T > &dims, size_t maxShift, bool includingBatchFT, bool includingSingleFT, bool allowDataOverwrite)
void	check () override
virtual void	init2DOneToN ()
void	init2D (const std::vector< HW *> &hw, AlignType type, const Dimensions &dims, size_t batch, size_t maxShift)
Protected Member Functions inherited from Alignment::AShiftEstimator< T >
virtual void	init2D (AlignType type, const Dimensions &dims, size_t batch, size_t maxShift)

Protected Attributes
FFTSettings< T > *	m_settingsInv
size_t	m_centerSize
bool	m_includingBatchFT
bool	m_includingSingleFT
bool	m_is_ref_FD_loaded
bool	m_allowDataOverwrite
Protected Attributes inherited from Alignment::AShiftEstimator< T >
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::AShiftCorrEstimator< T >

Definition at line 41 of file ashift_corr_estimator.h.

Constructor & Destructor Documentation

AShiftCorrEstimator() [1/3]

template<typename T>

Alignment::AShiftCorrEstimator< T >::AShiftCorrEstimator ( )

inline

Definition at line 43 of file ashift_corr_estimator.h.

                          {
        setDefault();
    }

AShiftCorrEstimator() [2/3]

template<typename T>

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

delete

AShiftCorrEstimator() [3/3]

template<typename T>

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

delete

~AShiftCorrEstimator()

template<typename T>

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

inlinevirtual

Definition at line 50 of file ashift_corr_estimator.h.

                                   {
        release();
    }

Member Function Documentation

check()

template<typename T >

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

overrideprotectedvirtual

Reimplemented from Alignment::AShiftEstimator< T >.

Definition at line 76 of file ashift_corr_estimator.cpp.

                                   {
    using memoryUtils::operator "" _GB;

    if (this->m_settingsInv->fBytesBatch() >= 4_GB) {
       REPORT_ERROR(ERR_VALUE_INCORRECT, "Batch is bigger than max size (4GB)");
    }
    if ((0 != (this->m_settingsInv->sDim().x() % 2))
        || (0 != (this->m_settingsInv->sDim().y() % 2))) {
        // while performing IFT of the correlation, we center the signal using multiplication
        // in the FD. This, however, works only for even signal.
            REPORT_ERROR(ERR_VALUE_INCORRECT,
                    "The X and Y dimensions have to be multiple of two. Crop your signal");
    }
}

computeCorrelations2DOneToN() [1/2]

template<typename T>

virtual void Alignment::AShiftCorrEstimator< T >::computeCorrelations2DOneToN ( std::complex< T > *  inOut, bool  center  )

pure virtual

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

computeCorrelations2DOneToN() [2/2]

template<typename T>

virtual void Alignment::AShiftCorrEstimator< T >::computeCorrelations2DOneToN ( const HW &  hw, std::complex< T > *  inOut, const std::complex< T > *  ref, const Dimensions &  dims, bool  center  )

pure virtual

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

init2D() [1/3]

template<typename T>

virtual void Alignment::AShiftCorrEstimator< T >::init2D ( const std::vector< HW *> &  hw, AlignType  type, const FFTSettings< T > &  dims, size_t  maxShift, bool  includingBatchFT, bool  includingSingleFT, bool  allowDataOverwrite  )

pure virtual

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

init2D() [2/3]

template<typename T >

void Alignment::AShiftCorrEstimator< T >::init2D ( AlignType  type, const FFTSettings< T > &  dims, size_t  maxShift, bool  includingBatchFT, bool  includingSingleFT, bool  allowDataOverwrite  )

protectedvirtual

Definition at line 52 of file ashift_corr_estimator.cpp.

                                 {
    AShiftEstimator<T>::init2D(type, dims.sDim(), dims.batch(), maxShift);

    m_settingsInv = new FFTSettings<T>(dims.isForward() ? dims.createInverse() : dims);
    m_includingBatchFT = includingBatchFT;
    m_includingSingleFT = includingSingleFT;
    m_centerSize = 2 * maxShift + 1;
    m_allowDataOverwrite = allowDataOverwrite;

    this->check();

    switch (type) {
        case AlignType::OneToN:
            init2DOneToN();
            break;
        default:
            REPORT_ERROR(ERR_NOT_IMPLEMENTED, "This alignment type is not supported yet");
    }
}

init2D() [3/3]

template<typename T>

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

inlineprotectedvirtual

Implements Alignment::AShiftEstimator< T >.

Definition at line 100 of file ashift_corr_estimator.h.

                                                                          {};

init2DOneToN()

template<typename T>

virtual void Alignment::AShiftCorrEstimator< T >::init2DOneToN ( )

inlineprotectedvirtual

Definition at line 95 of file ashift_corr_estimator.h.

{}; // nothing to do

load2DReferenceOneToN()

template<typename T>

virtual void Alignment::AShiftCorrEstimator< T >::load2DReferenceOneToN ( const std::complex< T > *  ref )

pure virtual

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

operator=() [1/2]

template<typename T>

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

delete

operator=() [2/2]

template<typename T>

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

delete

release()

template<typename T >

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

overridevirtual

Reimplemented from Alignment::AShiftEstimator< T >.

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

Definition at line 44 of file ashift_corr_estimator.cpp.

                                     {
    delete m_settingsInv;
    AShiftEstimator<T>::release();

    AShiftCorrEstimator<T>::setDefault();
}

setDefault()

template<typename T >

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

overrideprotectedvirtual

Reimplemented from Alignment::AShiftEstimator< T >.

Definition at line 30 of file ashift_corr_estimator.cpp.

                                        {
    AShiftEstimator<T>::setDefault();

    m_settingsInv = nullptr;
    m_centerSize = 0;

    // flags
    m_includingBatchFT = false;
    m_includingSingleFT = false;
    m_is_ref_FD_loaded = false;
    m_allowDataOverwrite = false;
}

Member Data Documentation

m_allowDataOverwrite

template<typename T>

bool Alignment::AShiftCorrEstimator< T >::m_allowDataOverwrite

protected

Definition at line 86 of file ashift_corr_estimator.h.

m_centerSize

template<typename T>

size_t Alignment::AShiftCorrEstimator< T >::m_centerSize

protected

Definition at line 80 of file ashift_corr_estimator.h.

m_includingBatchFT

template<typename T>

bool Alignment::AShiftCorrEstimator< T >::m_includingBatchFT

protected

Definition at line 83 of file ashift_corr_estimator.h.

m_includingSingleFT

template<typename T>

bool Alignment::AShiftCorrEstimator< T >::m_includingSingleFT

protected

Definition at line 84 of file ashift_corr_estimator.h.

m_is_ref_FD_loaded

template<typename T>

bool Alignment::AShiftCorrEstimator< T >::m_is_ref_FD_loaded

protected

Definition at line 85 of file ashift_corr_estimator.h.

m_settingsInv

template<typename T>

FFTSettings<T>* Alignment::AShiftCorrEstimator< T >::m_settingsInv

protected

Definition at line 79 of file ashift_corr_estimator.h.

---

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

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