Alignment::RotationEstimationSetting Class Reference

#include <arotation_estimator.h>

Collaboration diagram for Alignment::RotationEstimationSetting:

Public Member Functions
unsigned	getNoOfRings () const
void	check () const

Static Public Member Functions
static float	getMaxRotation ()
static unsigned	getDefaultLastRing (const Dimensions &d)
static unsigned	getDefaultFirstRing (const Dimensions &d)

Public Attributes
std::vector< HW * >	hw
AlignType	type
Dimensions	refDims = Dimensions(0)
Dimensions	otherDims = Dimensions(0)
size_t	batch
float	maxRotDeg
bool	fullCircle
unsigned	firstRing
unsigned	lastRing
bool	allowTuningOfNumberOfSamples
bool	allowDataOverwrite

Detailed Description

Definition at line 42 of file arotation_estimator.h.

Member Function Documentation

check()

void Alignment::RotationEstimationSetting::check ( ) const

inline

Definition at line 72 of file arotation_estimator.h.

                       {
        if (0 == hw.size()) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "HW contains zero (0) devices");
        }
        if ( ! refDims.isValid()) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "'Reference' dimensions are invalid (contain 0)");
        }
        if ( ! otherDims.isValid()) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "'Other' dimensions are invalid (contain 0)");
        }
        if ( ! refDims.equalExceptNPadded(otherDims)) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "Dimensions of the reference and other signals differ");
        }
        if (AlignType::None == type) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "'None' alignment type is set. This is invalid value");
        }
        if ((AlignType::OneToN == type)
                && (1 != refDims.n())) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "More than one reference specified for alignment type 1:N");
        }
        if ((AlignType::MToN == type)
                && (1 == refDims.n())) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "Single reference specified for alignment type M:N");
        }
        if (batch > otherDims.n()) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "Batch is bigger than number of signals");
        }
        if (0 == batch) {
            REPORT_ERROR(ERR_LOGIC_ERROR, "Batch is zero (0)");
        }
        if (0 == maxRotDeg) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "Max rotation is zero (0)");
        }
        if (0 == lastRing) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "Last ring is zero (0)");
        }
        if (0 == firstRing) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "First ring is zero (0)");
        }
        if (lastRing <= firstRing) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "Last ring is bigger (or equal) than first ring");
        }
        if (lastRing >= refDims.x()) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "Last ring is too big");
        }
        if (firstRing >= refDims.x()) {
            REPORT_ERROR(ERR_VALUE_INCORRECT, "First ring is too big");
        }
    }

getDefaultFirstRing()

static unsigned Alignment::RotationEstimationSetting::getDefaultFirstRing ( const Dimensions &  d )

inlinestatic

Definition at line 64 of file arotation_estimator.h.

                                                                    {
        return std::max((size_t)2, d.x() / 20);
    }

getDefaultLastRing()

static unsigned Alignment::RotationEstimationSetting::getDefaultLastRing ( const Dimensions &  d )

inlinestatic

Definition at line 60 of file arotation_estimator.h.

                                                                   {
        return (d.x() - 3) / 2; // so that we have some edge around the biggest ring
    }

getMaxRotation()

static float Alignment::RotationEstimationSetting::getMaxRotation ( )

inlinestatic

Definition at line 56 of file arotation_estimator.h.

                                         {
        return 360.f - std::numeric_limits<float>::min();
    }

getNoOfRings()

unsigned Alignment::RotationEstimationSetting::getNoOfRings ( ) const

inline

Definition at line 68 of file arotation_estimator.h.

                                         {
        return 1 + lastRing - firstRing;
    }

Member Data Documentation

allowDataOverwrite

bool Alignment::RotationEstimationSetting::allowDataOverwrite

Definition at line 54 of file arotation_estimator.h.

allowTuningOfNumberOfSamples

bool Alignment::RotationEstimationSetting::allowTuningOfNumberOfSamples

Definition at line 53 of file arotation_estimator.h.

batch

size_t Alignment::RotationEstimationSetting::batch

Definition at line 48 of file arotation_estimator.h.

firstRing

unsigned Alignment::RotationEstimationSetting::firstRing

Definition at line 51 of file arotation_estimator.h.

fullCircle

bool Alignment::RotationEstimationSetting::fullCircle

Definition at line 50 of file arotation_estimator.h.

hw

std::vector<HW*> Alignment::RotationEstimationSetting::hw

Definition at line 44 of file arotation_estimator.h.

lastRing

unsigned Alignment::RotationEstimationSetting::lastRing

Definition at line 52 of file arotation_estimator.h.

maxRotDeg

float Alignment::RotationEstimationSetting::maxRotDeg

Definition at line 49 of file arotation_estimator.h.

otherDims

Dimensions Alignment::RotationEstimationSetting::otherDims = Dimensions(0)

Definition at line 47 of file arotation_estimator.h.

refDims

Dimensions Alignment::RotationEstimationSetting::refDims = Dimensions(0)

Definition at line 46 of file arotation_estimator.h.

type

AlignType Alignment::RotationEstimationSetting::type

Definition at line 45 of file arotation_estimator.h.

---

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

• xmipp/libraries/reconstruction/arotation_estimator.h