C++ API Reference#

Class Hierarchy#

- Struct Column
- Struct InputFileData
- Struct MagDataProperties
- Struct MagnetizationData
- Struct NucDataProperties
- Struct NuclearData
- Template Struct Option
- Struct OutFlag
- Struct OutFlagQuant
- Struct PrefixEntry
- Struct ScalingFactors
- Struct ScatteringData
- Struct SpectralComponent
- Struct SpectralData
- Struct StructDataProperties
- Struct StructureData
- Struct SuffixEntry

File Hierarchy#

- Directory src
  - File NuMagSANS.cu
  - File NuMagSANSlib.h
  - File NuMagSANSlib_Directory.h
  - File NuMagSANSlib_gpuKernel.h
  - File NuMagSANSlib_HelperFun.h
  - File NuMagSANSlib_InputFileInterpreter.h
  - File NuMagSANSlib_LogFile.h
  - File NuMagSANSlib_MagData.h
  - File NuMagSANSlib_MagDataExplorer.h
  - File NuMagSANSlib_NucData.h
  - File NuMagSANSlib_NucDataExplorer.h
  - File NuMagSANSlib_ReadWrite.h
  - File NuMagSANSlib_SANSData.h
  - File NuMagSANSlib_SpectralData.h
  - File NuMagSANSlib_StringCompare.h
  - File NuMagSANSlib_StructureData.h
  - File NuMagSANSlib_StructureDataExplorer.h

Full API#

Namespaces#

Namespace LogSystem
- Functions
- Variables

Namespace std

Classes and Structs#

Struct Column
- Struct Documentation
  - Column
    - Column()
    - name
    - data

Struct MagDataProperties
- Struct Documentation
  - MagDataProperties

Struct MagnetizationData
- Struct Documentation
  - MagnetizationData
    - RotMat
    - x
    - y
    - z
    - mx
    - my
    - mz
    - K
    - TotalAtomNumber
    - NumberOfElements
    - NumberOfNonZeroMoments
    - N_act
    - N_cum
    - N_avg

Struct NucDataProperties
- Struct Documentation
  - NucDataProperties

Struct NuclearData
- Struct Documentation
  - NuclearData
    - RotMat
    - x
    - y
    - z
    - Nuc
    - K
    - TotalAtomNumber
    - NumberOfElements
    - N_cum
    - N_act
    - N_avg

Template Struct Option
- Struct Documentation
  - Option
    - key
    - target
    - required
    - found

Struct OutFlag
- Struct Documentation
  - OutFlag

Struct OutFlagQuant
- Struct Documentation
  - OutFlagQuant
    - SANS2D
    - SANS1D
    - Corr2D
    - Corr1D
    - PairDist1D

Struct PrefixEntry
- Struct Documentation
  - PrefixEntry
    - name
    - member

Struct ScalingFactors
- Struct Documentation
  - ScalingFactors

Struct ScatteringData
- Struct Documentation
  - ScatteringData

Struct SpectralComponent
- Struct Documentation
  - SpectralComponent
    - name
    - data

Struct StructDataProperties
- Struct Documentation
  - StructDataProperties
    - GlobalFilePath
    - Number_Of_Elements

Struct StructureData
- Struct Documentation
  - StructureData
    - RotMat
    - x
    - y
    - z
    - K

Struct SuffixEntry
- Struct Documentation
  - SuffixEntry
    - name
    - quantity

Functions#

Function allocate_MagnetizationDataGPU
- Function Documentation
  - allocate_MagnetizationDataGPU()

Function allocate_MagnetizationDataRAM
- Function Documentation
  - allocate_MagnetizationDataRAM()

Function allocate_NuclearDataGPU
- Function Documentation
  - allocate_NuclearDataGPU()

Function allocate_NuclearDataRAM
- Function Documentation
  - allocate_NuclearDataRAM()

Function allocate_ScatteringData_GPU
- Function Documentation
  - allocate_ScatteringData_GPU()

Function allocate_ScatteringData_RAM
- Function Documentation
  - allocate_ScatteringData_RAM()

Function allocate_SpectralData_GPU
- Function Documentation
  - allocate_SpectralData_GPU()

Function allocate_SpectralData_RAM
- Function Documentation
  - allocate_SpectralData_RAM()

Function allocate_StructureDataGPU
- Function Documentation
  - allocate_StructureDataGPU()

Function allocate_StructureDataRAM
- Function Documentation
  - allocate_StructureDataRAM()

Function any_active
- Function Documentation
  - any_active()

Function Atomistic_MagSANS_Kernel
- Function Documentation

Function Atomistic_MagSANS_Kernel_dilute
- Function Documentation

Function Atomistic_NucSANS_Kernel
- Function Documentation

Function Atomistic_NucSANS_Kernel_dilute
- Function Documentation

Function Atomistic_NuMagSANS_Kernel
- Function Documentation

Function Atomistic_NuMagSANS_Kernel_dilute
- Function Documentation

Function AzimuthalAverage
- Function Documentation

Function build_Corr1D_columns
- Function Documentation
  - build_Corr1D_columns()

Function build_Corr2D_columns
- Function Documentation
  - build_Corr2D_columns()

Function build_SANS1D_columns
- Function Documentation
  - build_SANS1D_columns()

Function build_SANS2D_columns
- Function Documentation
  - build_SANS2D_columns()

Function build_spectral_amplitudes
- Function Documentation
  - build_spectral_amplitudes()

Function build_spectral_intensities
- Function Documentation
  - build_spectral_intensities()

Function check_element_names_MagData
- Function Documentation
  - check_element_names_MagData()

Function check_element_names_NucData
- Function Documentation
  - check_element_names_NucData()

Function check_FileDimensions_MagData
- Function Documentation
  - check_FileDimensions_MagData()

Function check_FileDimensions_NucData
- Function Documentation
  - check_FileDimensions_NucData()

Function Check_Idx_Consistency
- Function Documentation
  - Check_Idx_Consistency()

Function Check_Nom_Consistency
- Function Documentation
  - Check_Nom_Consistency()

Function check_number_of_elements_in_folders_MagData
- Function Documentation
  - check_number_of_elements_in_folders_MagData()

Function check_number_of_elements_in_folders_NucData
- Function Documentation
  - check_number_of_elements_in_folders_NucData()

Function Check_SinglePoint
- Function Documentation
  - Check_SinglePoint()

Function Check_SingleUnderscore
- Function Documentation
  - Check_SingleUnderscore()

Function check_Subfolder_FileNames_MagData
- Function Documentation
  - check_Subfolder_FileNames_MagData()

Function check_Subfolder_FileNames_NucData
- Function Documentation
  - check_Subfolder_FileNames_NucData()

Function check_Subfolders_MagData
- Function Documentation
  - check_Subfolders_MagData()

Function check_Subfolders_NucData
- Function Documentation
  - check_Subfolders_NucData()

Function CheckStrings_ElementNames
- Function Documentation
  - CheckStrings_ElementNames()

Function CheckStrings_FolderNames
- Function Documentation
  - CheckStrings_FolderNames()

Function Compute_RotMat
- Function Documentation
  - Compute_RotMat()

Function ComputeAngularSpectrumAmplitudes
- Function Documentation

Function ComputeSpectralDecomposition
- Function Documentation

Function copyGPU2RAM_ScatteringData
- Function Documentation
  - copyGPU2RAM_ScatteringData()

Function copyGPU2RAM_SpectralData
- Function Documentation
  - copyGPU2RAM_SpectralData()

Function CorrelationFunction_2D
- Function Documentation

Function count_NumberOfElements
- Function Documentation
  - count_NumberOfElements()

Function count_NumberOfFolders
- Function Documentation
  - count_NumberOfFolders()

Function CountAtomNumbers_MagData
- Function Documentation
  - CountAtomNumbers_MagData()

Function CountAtomNumbers_NucData
- Function Documentation
  - CountAtomNumbers_NucData()

Function CountColumnsAndRowsInMagDataFile
- Function Documentation
  - CountColumnsAndRowsInMagDataFile()

Function disp_MagnetizationData
- Function Documentation
  - disp_MagnetizationData()

Function disp_NuclearData
- Function Documentation
  - disp_NuclearData()

Function disp_StructureData
- Function Documentation
  - disp_StructureData()

Function DistributionFunctions
- Function Documentation

Function free_MagnetizationData
- Function Documentation
  - free_MagnetizationData()

Function free_NuclearData
- Function Documentation
  - free_NuclearData()

Function free_ScatteringData
- Function Documentation
  - free_ScatteringData()

Function free_SpectralData
- Function Documentation
  - free_SpectralData()

Function free_StructureData
- Function Documentation
  - free_StructureData()

Function get_GlobalMagDataPath
- Function Documentation
  - get_GlobalMagDataPath()

Function get_GlobalNucDataPath
- Function Documentation
  - get_GlobalNucDataPath()

Function get_GlobalStructDataPath
- Function Documentation
  - get_GlobalStructDataPath()

Function init_MagnetizationData
- Function Documentation
  - init_MagnetizationData()

Function init_NuclearData
- Function Documentation
  - init_NuclearData()

Function init_ScalingFactors
- Function Documentation
  - init_ScalingFactors()

Function init_ScatteringData
- Function Documentation
  - init_ScatteringData()

Function init_SpectralData
- Function Documentation
  - init_SpectralData()

Function init_StructureData
- Function Documentation
  - init_StructureData()

Function InitializeLogSystem
- Function Documentation
  - InitializeLogSystem()

Function LogSystem::close
- Function Documentation
  - close()

Function LogSystem::initLog
- Function Documentation
  - initLog()

Function LogSystem::write
- Function Documentation
  - write()

Function MagData_Observer
- Function Documentation
  - MagData_Observer()

Function NucData_Observer
- Function Documentation
  - NucData_Observer()

Function NuMagSANS_Calculator
- Function Documentation
  - NuMagSANS_Calculator()

Function Number_Of_Comma_In_String
- Function Documentation
  - Number_Of_Comma_In_String()

Function NumberOfEntriesInNucFile
- Function Documentation
  - NumberOfEntriesInNucFile()

Function NumberOfEntriesInStructureFile
- Function Documentation
  - NumberOfEntriesInStructureFile()

Function NumberOfNonZeroMagneticMomentsInFile
- Function Documentation
  - NumberOfNonZeroMagneticMomentsInFile()

Function NumberOfNonZeroMagneticMomentsInFile2
- Function Documentation
  - NumberOfNonZeroMagneticMomentsInFile2()

Function parse_int_list
- Function Documentation
  - parse_int_list()

Function parseStringNoCout
- Function Documentation
  - parseStringNoCout()

Function read_FolderNames
- Function Documentation
  - read_FolderNames()

Function read_MagnetizationData
- Function Documentation
  - read_MagnetizationData()

Function read_NuclearData
- Function Documentation
  - read_NuclearData()

Function read_StructureData
- Function Documentation
  - read_StructureData()

Function ReadCSV__Input_File_Interpreter
- Function Documentation
  - ReadCSV__Input_File_Interpreter()

Function ReadCSV_double_matrix
- Function Documentation
  - ReadCSV_double_matrix()

Function ReadCSV_double_vector
- Function Documentation
  - ReadCSV_double_vector()

Function ReadCSV_float_vector
- Function Documentation
  - ReadCSV_float_vector()

Function scale_ScatteringData
- Function Documentation
  - scale_ScatteringData()

Function scale_SpectralData
- Function Documentation
  - scale_SpectralData()

Function sort_integ
- Function Documentation
  - sort_integ()

Function Split_Nom_Idx
- Function Documentation
  - Split_Nom_Idx()

Function Split_Nom_Idx_Type
- Function Documentation
  - Split_Nom_Idx_Type()

Function StructData_Observer
- Function Documentation
  - StructData_Observer()

Function SumIntList2
- Function Documentation
  - SumIntList2()

Function trim
- Function Documentation
  - trim()

Function try_extract_value
- Function Documentation
  - try_extract_value()

Function User_Selection_To_Int_Array
- Function Documentation
  - User_Selection_To_Int_Array()

Function write2CSV_SpectralData
- Function Documentation
  - write2CSV_SpectralData()

Function write2CSVtable_ScatteringData
- Function Documentation
  - write2CSVtable_ScatteringData()

Function write_amplitude_csv
- Function Documentation
  - write_amplitude_csv()

Function write_spectral_csv
- Function Documentation
  - write_spectral_csv()

Function writeCSV
- Function Documentation
  - writeCSV()

Function WriteCSV_double_vector
- Function Documentation
  - WriteCSV_double_vector()

Function WriteCSV_float_matrix
- Function Documentation
  - WriteCSV_float_matrix()

Function WriteCSV_float_vector
- Function Documentation
  - WriteCSV_float_vector()

Variables#

Variable LogSystem::logFile
- Variable Documentation
  - logFile