reconstruct_fourier_buffer_data.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Authors:     David Strelak (davidstrelak@gmail.com)
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

#ifndef XMIPP_LIBRARIES_DATA_RECONSTRUCT_FOURIER_BUFFER_DATA_H_
#define XMIPP_LIBRARIES_DATA_RECONSTRUCT_FOURIER_BUFFER_DATA_H_

#include "reconstruct_fourier_projection_traverse_space.h"
#include "core/utils/memory_utils.h"

struct RecFourierBufferData
{
    RecFourierBufferData(bool hasFFTs, bool hasCTFs,
            int fftSizeX, int fftSizeY, int paddedImgSize,
            int maxNoOfImages, int noOfSymmetries) :
            hasFFTs(hasFFTs), hasCTFs(hasCTFs),
            fftSizeX(fftSizeX), fftSizeY(fftSizeY), paddedImgSize(paddedImgSize),
            maxNoOfImages(maxNoOfImages),noOfSymmetries(noOfSymmetries), noOfImages(0) {
        spaces = memoryUtils::page_aligned_alloc<RecFourierProjectionTraverseSpace>(maxNoOfImages * noOfSymmetries, false);
        if (hasFFTs) {
            paddedImages = nullptr;
            FFTs = memoryUtils::page_aligned_alloc<float>(fftSizeX * fftSizeY * maxNoOfImages * 2, true); // *2 since it's complex
        } else {
            FFTs = nullptr;
            paddedImages = memoryUtils::page_aligned_alloc<float>(paddedImgSize * paddedImgSize * maxNoOfImages, true);
        }

        if (hasCTFs) {
            CTFs = memoryUtils::page_aligned_alloc<float>(fftSizeX * fftSizeY * maxNoOfImages, true);
            modulators = memoryUtils::page_aligned_alloc<float>(fftSizeX * fftSizeY * maxNoOfImages, true);
        } else {
            CTFs = modulators = nullptr;
        }
    };

    ~RecFourierBufferData() {
        free(FFTs);
        free(CTFs);
        free(paddedImages);
        free(modulators);
        FFTs = CTFs = paddedImages = modulators = nullptr;

        free(spaces);
        spaces = nullptr;
    }

    int getPaddedImgSize() {
        return paddedImgSize * paddedImgSize;
    }

    int getPaddedImgByteSize() {
        return getPaddedImgSize() * sizeof(float);
    }

    int getFFTsByteSize() {
        return getNoOfElements(FFTs) * sizeof(float);
    }

    float* getNthItem(float* array, int itemIndex) {
        if (array == FFTs) return array + (fftSizeX * fftSizeY * itemIndex * 2); // *2 since it's complex
        if (array == CTFs) return array + (fftSizeX * fftSizeY * itemIndex);
        if (array == modulators) return array + (fftSizeX * fftSizeY * itemIndex);
        if (array == paddedImages) return array + (paddedImgSize * paddedImgSize * itemIndex);
        return nullptr; // undefined
    }

    int getNoOfElements(float* array) {
        if (array == FFTs) return (fftSizeX * fftSizeY * noOfImages * 2); // *2 since it's complex
        if (array == CTFs) return (fftSizeX * fftSizeY * noOfImages);
        if (array == modulators) return (fftSizeX * fftSizeY * noOfImages);
        if (array == paddedImages) return (paddedImgSize * paddedImgSize * noOfImages);
        return -1; // undefined
    }

    int getNoOfElements(RecFourierProjectionTraverseSpace* array) {
        return noOfImages * noOfSymmetries;
    }

    int getMaxByteSize(float* array) {
        if (array == FFTs) return (fftSizeX * fftSizeY * maxNoOfImages * 2 * sizeof(float)); // *2 since it's complex
        if (array == CTFs) return (fftSizeX * fftSizeY * maxNoOfImages * sizeof(float));
        if (array == modulators) return (fftSizeX * fftSizeY * maxNoOfImages * sizeof(float));
        if (array == paddedImages) return (paddedImgSize * paddedImgSize * maxNoOfImages * sizeof(float));
        return -1; // undefined
    }

    int getMaxByteSize(RecFourierProjectionTraverseSpace* array) {
        if (array == spaces) return (noOfSymmetries * maxNoOfImages * sizeof(RecFourierProjectionTraverseSpace));
        return -1; // undefined
    }

    // holds 'right side of the centered FFT', i.e. only unique values, with high frequencies in the corners
    float* FFTs;
    // holds CTF correction for each pixel of FFT
    float* CTFs;
    // holds correction for each pixel of FFT
    float* modulators;
    float* paddedImages;
    // holds spaces for each FFT
    RecFourierProjectionTraverseSpace* spaces;

    int fftSizeX;
    int fftSizeY;
    int paddedImgSize; // paddedImage is squared
    int noOfImages; // currently stored in buffer
    int maxNoOfImages; // that can be stored in the buffer
    int noOfSymmetries;
    bool hasFFTs;
    bool hasCTFs; // if 'true', CTF correction data are present in 'CTFs' and 'modulators'

    void invalidate() {
        hasCTFs = hasFFTs = false;
        noOfImages = fftSizeX = fftSizeY = paddedImgSize
                = maxNoOfImages = noOfSymmetries = -1;

        FFTs = CTFs = paddedImages = modulators = nullptr;
        spaces = nullptr;
    }

protected:
    RecFourierBufferData() { invalidate(); };
};


#endif /* XMIPP_LIBRARIES_DATA_RECONSTRUCT_FOURIER_BUFFER_DATA_H_ */