MaterialSet.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __MaterialSet_h
#define __MaterialSet_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#include <iostream>
#include <map>
#include <string>

#ifndef __TissueMaterial_h
#include "TissueMaterial.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class MaterialSet
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    static MaterialSet& getInstance();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    ~MaterialSet();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void clearMemory();


    //--------------------------------------------------------------------------
    /*
    *   @param aFileName:   the name of the file to load
    */
    //--------------------------------------------------------------------------
    void loadFromFile(const std::string& aFileName);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void loadMaterialSetFromMemory();


    //---------------------------------------------------------------------------
    /*
    *   @param aMaterial    the material to add
    */
    //---------------------------------------------------------------------------
    void addMaterial(const TissueMaterial& aMaterial);


    //--------------------------------------------------------------------------
    /*
    *   @param aHUValue:    the HU value of the material
    */
    //--------------------------------------------------------------------------
    const TissueMaterial& getMaterial(short aHUValue) const;


    //--------------------------------------------------------------------------
    /*
    *   @return the lower energy cutoff for attenuation coefficient
    */
    //--------------------------------------------------------------------------
    float getMuMinEnergy() const;


    //--------------------------------------------------------------------------
    /*
    *   @return the higher energy cutoff for attenuation coefficient
    */
    //--------------------------------------------------------------------------
    float getMuMaxEnergy() const;


    //--------------------------------------------------------------------------
    /*
    *   @return the minimum Hounsfield unit that the material set can handle
    */
    //--------------------------------------------------------------------------
    short getMinHU() const;


    //--------------------------------------------------------------------------
    /*
    *   @return the maximum Hounsfield unit that the material set can handle
    */
    //--------------------------------------------------------------------------
    short getMaxHU() const;
    

    //--------------------------------------------------------------------------
    /*
    *   @return the number of materials
    */
    //--------------------------------------------------------------------------
    unsigned int getMaterialNumber() const;


    //--------------------------------------------------------------------------
    /*
     *  @param anOutputSream:   the output stream
     *  @param anElement:       the element to output
     *  @return the output stream
     */
    //--------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream& anOutputSream,
                                       const MaterialSet& anMaterialSet);


//*****************************************************************************
private:
    //---------------------------------------------------------------------------
    //---------------------------------------------------------------------------
    MaterialSet();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    MaterialSet(const MaterialSet&);


    //--------------------------------------------------------------------------
    /*
     *  @param aFileName:   the name of the file to load
     */
    //--------------------------------------------------------------------------
    MaterialSet(const std::string& aFileName);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    MaterialSet& operator=(const MaterialSet&);


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    std::map<std::pair<short, short>, TissueMaterial> m_material_set;

    
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    float m_mu_min_energy;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    float m_mu_max_energy;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    float m_min_S;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    float m_max_S;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    short m_min_HU;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    short m_max_HU;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "MaterialSet.inl"


#endif // __MaterialSet_h