Volume.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 * All rights reserved. Do not distribute without permission.
 * Responsible Author: Daniel Nachbaur <daniel.nachbaur@epfl.ch>
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <platform/core/common/Api.h>
#include <platform/core/common/BaseObject.h>
#include <platform/core/common/Types.h>
 
namespace core
{
class Volume : public BaseObject
{
public:
    PLATFORM_API Volume(const Vector3ui& dimensions, const Vector3f& spacing, const DataType type);
 
    /*
     * @brief Sets the range of data in the volume.
     * @param range The data range represented as a Vector2f object.
     */
    PLATFORM_API virtual void setDataRange(const Vector2f& range) = 0;
 
    /*
     * @brief Gets the range of values in the volume.
     */
    PLATFORM_API Vector2f getDataRange() const { return _valueRange; }
 
    PLATFORM_API virtual void commit() = 0;
 
    PLATFORM_API size_t getSizeInBytes() const { return _sizeInBytes; }
 
    PLATFORM_API Boxd getBounds() const { return {_offset, _offset + Vector3f(_dimensions) * _spacing}; }
 
    PLATFORM_API Vector3f getDimensions() const { return _dimensions; }
 
    PLATFORM_API Vector3f getElementSpacing() const { return _spacing; }
 
    PLATFORM_API Vector3f getOffset() const { return _offset; }
 
    PLATFORM_API Vector2f getValueRange() const { return _valueRange; }
 
protected:
    std::atomic_size_t _sizeInBytes{0}; // The size of the volume in bytes.
    const Vector3ui _dimensions;        // The dimensions of the volume as a Vector3ui object.
    const Vector3f _spacing;            // The spacing between voxels as a Vector3f object.
    Vector3f _offset;                   // Volume offset
    const DataType _dataType;           // The data type of the volume.
    Vector2f _valueRange{-1e6f, 1e6f};  // The voxel value range in the volume.
};
} // namespace core